/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.ignite.internal.processors.cache.distributed;
import java.io.Externalizable;
import java.nio.ByteBuffer;
import java.util.Collection;
import java.util.UUID;
import org.apache.ignite.IgniteLogger;
import org.apache.ignite.cache.CacheWriteSynchronizationMode;
import org.apache.ignite.internal.GridDirectTransient;
import org.apache.ignite.internal.processors.affinity.AffinityTopologyVersion;
import org.apache.ignite.internal.processors.cache.GridCacheSharedContext;
import org.apache.ignite.internal.processors.cache.transactions.IgniteTxState;
import org.apache.ignite.internal.processors.cache.transactions.IgniteTxStateAware;
import org.apache.ignite.internal.processors.cache.version.GridCacheVersion;
import org.apache.ignite.internal.util.tostring.GridToStringBuilder;
import org.apache.ignite.lang.IgniteUuid;
import org.apache.ignite.plugin.extensions.communication.MessageReader;
import org.apache.ignite.plugin.extensions.communication.MessageWriter;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import static org.apache.ignite.cache.CacheWriteSynchronizationMode.*;
/**
* Transaction completion message.
*/
public class GridDistributedTxFinishRequest extends GridDistributedBaseMessage implements IgniteTxStateAware {
/** */
private static final long serialVersionUID = 0L;
/** */
protected static final int WAIT_REMOTE_TX_FLAG_MASK = 0x01;
/** */
protected static final int CHECK_COMMITTED_FLAG_MASK = 0x02;
/** */
protected static final int NEED_RETURN_VALUE_FLAG_MASK = 0x04;
/** */
protected static final int SYS_INVALIDATE_FLAG_MASK = 0x08;
/** */
protected static final int EXPLICIT_LOCK_FLAG_MASK = 0x10;
/** */
protected static final int STORE_ENABLED_FLAG_MASK = 0x20;
/** Topology version. */
private AffinityTopologyVersion topVer;
/** Future ID. */
private IgniteUuid futId;
/** Thread ID. */
private long threadId;
/** Commit version. */
private GridCacheVersion commitVer;
/** Invalidate flag. */
private boolean invalidate;
/** Commit flag. */
private boolean commit;
/** Min version used as base for completed versions. */
private GridCacheVersion baseVer;
/** Expected txSize. */
private int txSize;
/** System transaction flag. */
private boolean sys;
/** IO policy. */
private byte plc;
/** Subject ID. */
private UUID subjId;
/** Task name hash. */
private int taskNameHash;
/** */
private byte flags;
/** Write synchronization mode. */
private CacheWriteSynchronizationMode syncMode;
/** Transient TX state. */
@GridDirectTransient
private IgniteTxState txState;
/**
* Empty constructor required by {@link Externalizable}.
*/
public GridDistributedTxFinishRequest() {
/* No-op. */
}
/**
* @param xidVer Transaction ID.
* @param futId future ID.
* @param threadId Thread ID.
* @param commitVer Commit version.
* @param commit Commit flag.
* @param invalidate Invalidate flag.
* @param sys System transaction flag.
* @param plc IO policy.
* @param syncMode Write synchronization mode.
* @param baseVer Base version.
* @param committedVers Committed versions.
* @param rolledbackVers Rolled back versions.
* @param txSize Expected transaction size.
* @param addDepInfo Deployment info flag.
*/
public GridDistributedTxFinishRequest(
GridCacheVersion xidVer,
IgniteUuid futId,
@NotNull AffinityTopologyVersion topVer,
@Nullable GridCacheVersion commitVer,
long threadId,
boolean commit,
boolean invalidate,
boolean sys,
byte plc,
CacheWriteSynchronizationMode syncMode,
GridCacheVersion baseVer,
Collection<GridCacheVersion> committedVers,
Collection<GridCacheVersion> rolledbackVers,
@Nullable UUID subjId,
int taskNameHash,
int txSize,
boolean addDepInfo
) {
super(xidVer, 0, addDepInfo);
assert xidVer != null;
assert syncMode != null;
this.futId = futId;
this.topVer = topVer;
this.commitVer = commitVer;
this.threadId = threadId;
this.commit = commit;
this.invalidate = invalidate;
this.sys = sys;
this.plc = plc;
this.syncMode = syncMode;
this.baseVer = baseVer;
this.subjId = subjId;
this.taskNameHash = taskNameHash;
this.txSize = txSize;
completedVersions(committedVers, rolledbackVers);
}
/**
* @return Transaction write synchronization mode (can be null is message sent from old nodes).
*/
public final CacheWriteSynchronizationMode syncMode() {
return syncMode;
}
/**
* Sets flag mask.
*
* @param flag Set or clear.
* @param mask Mask.
*/
protected final void setFlag(boolean flag, int mask) {
flags = flag ? (byte)(flags | mask) : (byte)(flags & ~mask);
}
/**
* Reags flag mask.
*
* @param mask Mask to read.
* @return Flag value.
*/
protected final boolean isFlag(int mask) {
return (flags & mask) != 0;
}
/**
* @return Subject ID.
*/
@Nullable public final UUID subjectId() {
return subjId;
}
/**
* @return Task name hash.
*/
public final int taskNameHash() {
return taskNameHash;
}
/**
* @return Topology version.
*/
@Override public final AffinityTopologyVersion topologyVersion() {
return topVer;
}
/**
* @return System transaction flag.
*/
public boolean system() {
return sys;
}
/**
* @return IO policy.
*/
public byte policy() {
return plc;
}
/**
* @return Future ID.
*/
public IgniteUuid futureId() {
return futId;
}
/**
* @return Thread ID.
*/
public long threadId() {
return threadId;
}
/**
* @return Commit version.
*/
public GridCacheVersion commitVersion() {
return commitVer;
}
/**
* @return Commit flag.
*/
public boolean commit() {
return commit;
}
/**
*
* @return Invalidate flag.
*/
public boolean isInvalidate() {
return invalidate;
}
/**
* @return Base version.
*/
public GridCacheVersion baseVersion() {
return baseVer;
}
/**
* @return Expected tx size.
*/
public int txSize() {
return txSize;
}
/**
*
* @return {@code True} if reply is required.
*/
public boolean replyRequired() {
assert syncMode != null;
return syncMode == FULL_SYNC;
}
/** {@inheritDoc} */
@Override public IgniteTxState txState() {
return txState;
}
/** {@inheritDoc} */
@Override public void txState(IgniteTxState txState) {
this.txState = txState;
}
/** {@inheritDoc} */
@Override public IgniteLogger messageLogger(GridCacheSharedContext ctx) {
return ctx.txFinishMessageLogger();
}
/** {@inheritDoc} */
@Override public boolean writeTo(ByteBuffer buf, MessageWriter writer) {
writer.setBuffer(buf);
if (!super.writeTo(buf, writer))
return false;
if (!writer.isHeaderWritten()) {
if (!writer.writeHeader(directType(), fieldsCount()))
return false;
writer.onHeaderWritten();
}
switch (writer.state()) {
case 7:
if (!writer.writeMessage("baseVer", baseVer))
return false;
writer.incrementState();
case 8:
if (!writer.writeBoolean("commit", commit))
return false;
writer.incrementState();
case 9:
if (!writer.writeMessage("commitVer", commitVer))
return false;
writer.incrementState();
case 10:
if (!writer.writeByte("flags", flags))
return false;
writer.incrementState();
case 11:
if (!writer.writeIgniteUuid("futId", futId))
return false;
writer.incrementState();
case 12:
if (!writer.writeBoolean("invalidate", invalidate))
return false;
writer.incrementState();
case 13:
if (!writer.writeByte("plc", plc))
return false;
writer.incrementState();
case 14:
if (!writer.writeUuid("subjId", subjId))
return false;
writer.incrementState();
case 15:
if (!writer.writeByte("syncMode", syncMode != null ? (byte)syncMode.ordinal() : -1))
return false;
writer.incrementState();
case 16:
if (!writer.writeBoolean("sys", sys))
return false;
writer.incrementState();
case 17:
if (!writer.writeInt("taskNameHash", taskNameHash))
return false;
writer.incrementState();
case 18:
if (!writer.writeLong("threadId", threadId))
return false;
writer.incrementState();
case 19:
if (!writer.writeMessage("topVer", topVer))
return false;
writer.incrementState();
case 20:
if (!writer.writeInt("txSize", txSize))
return false;
writer.incrementState();
}
return true;
}
/** {@inheritDoc} */
@Override public boolean readFrom(ByteBuffer buf, MessageReader reader) {
reader.setBuffer(buf);
if (!reader.beforeMessageRead())
return false;
if (!super.readFrom(buf, reader))
return false;
switch (reader.state()) {
case 7:
baseVer = reader.readMessage("baseVer");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 8:
commit = reader.readBoolean("commit");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 9:
commitVer = reader.readMessage("commitVer");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 10:
flags = reader.readByte("flags");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 11:
futId = reader.readIgniteUuid("futId");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 12:
invalidate = reader.readBoolean("invalidate");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 13:
plc = reader.readByte("plc");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 14:
subjId = reader.readUuid("subjId");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 15:
byte syncModeOrd;
syncModeOrd = reader.readByte("syncMode");
if (!reader.isLastRead())
return false;
syncMode = CacheWriteSynchronizationMode.fromOrdinal(syncModeOrd);
reader.incrementState();
case 16:
sys = reader.readBoolean("sys");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 17:
taskNameHash = reader.readInt("taskNameHash");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 18:
threadId = reader.readLong("threadId");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 19:
topVer = reader.readMessage("topVer");
if (!reader.isLastRead())
return false;
reader.incrementState();
case 20:
txSize = reader.readInt("txSize");
if (!reader.isLastRead())
return false;
reader.incrementState();
}
return reader.afterMessageRead(GridDistributedTxFinishRequest.class);
}
/** {@inheritDoc} */
@Override public short directType() {
return 23;
}
/** {@inheritDoc} */
@Override public byte fieldsCount() {
return 21;
}
/** {@inheritDoc} */
@Override public String toString() {
return GridToStringBuilder.toString(GridDistributedTxFinishRequest.class, this,
"super", super.toString());
}
}