lumis.portal.cluster.multiserver
Class ClusterTransmissionHeader

java.lang.Object
  org.jgroups.Header
      lumis.portal.cluster.multiserver.ClusterTransmissionHeader

All Implemented Interfaces:

Externalizable, Serializable, org.jgroups.util.Streamable

public class ClusterTransmissionHeader
extends org.jgroups.Header
implements org.jgroups.util.Streamable

Header used to store some control information about a IClusterTransmission. Some data available in the IClusterTransmission is also stored in this header to prevent the need to deserialize the message to read them.

Since:

4.1.0

See Also:

Serialized Form

Field Summary

static byte	FLAG_DURABLE Bit used to indicate durable.
static byte	FLAG_TOTAL_ORDER Bit used to indicate total order.
static String	HEADER_NAME The name used to store this header.

Fields inherited from class org.jgroups.Header

HDR_OVERHEAD

Constructor Summary

ClusterTransmissionHeader()
Creates a header with default values.

ClusterTransmissionHeader(IClusterTransmission clusterTransmission)
Creates a header initialized according to the given IClusterTransmission.

Method Summary

byte	getFlags() Returns the flags set in this header.
String	getTransmissionId() Returns the unique identifier of the transmission for which this header belongs.
long	getTransmissionOrder() Returns the transmission order generated for the corresponding transmission.
void	readExternal(ObjectInput in)
void	readFrom(DataInputStream in)
int	size()
String	toString()
void	writeExternal(ObjectOutput out)
void	writeTo(DataOutputStream out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FLAG_TOTAL_ORDER

public static final byte FLAG_TOTAL_ORDER

Bit used to indicate total order.

Since:

4.1.0

See Also:

getFlags(), Constant Field Values

FLAG_DURABLE

public static final byte FLAG_DURABLE

Bit used to indicate durable.

Since:

4.1.0

See Also:

getFlags(), Constant Field Values

HEADER_NAME

public static final String HEADER_NAME

The name used to store this header.

Since:

4.1.0

See Also:

Constant Field Values

Constructor Detail

ClusterTransmissionHeader

public ClusterTransmissionHeader()

Creates a header with default values. Intended for use by deserialization process.

Since:

4.1.0

ClusterTransmissionHeader

public ClusterTransmissionHeader(IClusterTransmission clusterTransmission)

Creates a header initialized according to the given IClusterTransmission.

Parameters:

clusterTransmission - the cluster message.

Since:

4.1.0

Method Detail

getTransmissionId

public String getTransmissionId()

Returns the unique identifier of the transmission for which this header belongs.

Returns:

the unique identifier of the transmission.

Since:

4.1.0

getFlags

public byte getFlags()

Returns the flags set in this header.

Returns:

a value that is an OR combination of the active FLAG_* constants.

Since:

4.1.0

getTransmissionOrder

public long getTransmissionOrder()

Returns the transmission order generated for the corresponding transmission.

Returns:

the transmission order generated for the corresponding transmission.

Since:

4.1.0

size

public int size()

Overrides:

size in class org.jgroups.Header

toString

public String toString()

Overrides:

toString in class org.jgroups.Header

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readFrom

public void readFrom(DataInputStream in)
              throws IOException,
                     IllegalAccessException,
                     InstantiationException

Specified by:

readFrom in interface org.jgroups.util.Streamable

Throws:

IOException

IllegalAccessException

InstantiationException

writeTo

public void writeTo(DataOutputStream out)
             throws IOException

Specified by:

writeTo in interface org.jgroups.util.Streamable

Throws:

IOException