org.jgroups.protocols

Class UNICAST3.Header

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.UNICAST3.Header

All Implemented Interfaces:

Constructable<Header>, Streamable

Enclosing class:

UNICAST3

public static class UNICAST3.Header
extends Header

The following types and fields are serialized:

 | DATA | seqno | conn_id | first |
 | ACK  | seqno | timestamp |
 | SEND_FIRST_SEQNO | timestamp |
 | CLOSE | conn_id |
 

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ACK
static byte	CLOSE
static byte	DATA
static byte	SEND_FIRST_SEQNO
static byte	XMIT_REQ

Fields inherited from class org.jgroups.Header

prot_id

Constructor Summary

Constructors

Modifier	Constructor and Description
	Header()
protected	Header(byte type)
protected	Header(byte type, long seqno)
protected	Header(byte type, long seqno, short conn_id, boolean first)

Method Summary

Modifier and Type	Method and Description
short	connId()
UNICAST3.Header	copy()
java.util.function.Supplier<? extends Header>	create() Creates an instance of the class implementing this interface
static UNICAST3.Header	createAckHeader(long seqno, short conn_id, long timestamp)
static UNICAST3.Header	createCloseHeader(short conn_id)
static UNICAST3.Header	createDataHeader(long seqno, short conn_id, boolean first)
static UNICAST3.Header	createSendFirstSeqnoHeader(long timestamp)
static UNICAST3.Header	createXmitReqHeader()
boolean	first()
short	getMagicId() Returns the magic-ID.
void	readFrom(java.io.DataInput in) Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
long	seqno()
int	size() To be implemented by subclasses.
long	timestamp()
UNICAST3.Header	timestamp(long ts)
java.lang.String	toString()
byte	type()
static java.lang.String	type2Str(byte t)
void	writeTo(java.io.DataOutput out) Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class org.jgroups.Header

getProtId, setProtId

Methods inherited from class java.lang.Object

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

Field Detail

DATA

public static final byte DATA

See Also:

Constant Field Values

ACK

public static final byte ACK

See Also:

Constant Field Values

SEND_FIRST_SEQNO

public static final byte SEND_FIRST_SEQNO

See Also:

Constant Field Values

XMIT_REQ

public static final byte XMIT_REQ

See Also:

Constant Field Values

CLOSE

public static final byte CLOSE

See Also:

Constant Field Values

Constructor Detail

Header

public Header()

Header

protected Header(byte type)

Header

protected Header(byte type,
                 long seqno)

Header

protected Header(byte type,
                 long seqno,
                 short conn_id,
                 boolean first)

Method Detail

getMagicId

public short getMagicId()

Description copied from class: Header

Returns the magic-ID. If defined in jg-magic-map.xml, the IDs need to be the same

Specified by:

getMagicId in class Header

create

public java.util.function.Supplier<? extends Header> create()

Description copied from interface: Constructable

Creates an instance of the class implementing this interface

createDataHeader

public static UNICAST3.Header createDataHeader(long seqno,
                                               short conn_id,
                                               boolean first)

createAckHeader

public static UNICAST3.Header createAckHeader(long seqno,
                                              short conn_id,
                                              long timestamp)

createSendFirstSeqnoHeader

public static UNICAST3.Header createSendFirstSeqnoHeader(long timestamp)

createXmitReqHeader

public static UNICAST3.Header createXmitReqHeader()

createCloseHeader

public static UNICAST3.Header createCloseHeader(short conn_id)

type

public byte type()

seqno

public long seqno()

connId

public short connId()

first

public boolean first()

timestamp

public long timestamp()

timestamp

public UNICAST3.Header timestamp(long ts)

toString

public java.lang.String toString()

Overrides:

toString in class Header

type2Str

public static java.lang.String type2Str(byte t)

size

public final int size()

Description copied from class: Header

To be implemented by subclasses. Return the size of this object for the serialized version of it. I.e. how many bytes this object takes when flattened into a buffer. This may be different for each instance, or can be the same. This may also just be an estimation. E.g. FRAG uses it on Message to determine whether or not to fragment the message. Fragmentation itself will be accurate, because the entire message will actually be serialized into a byte buffer, so we can determine the exact size.

Specified by:

size in class Header

copy

public UNICAST3.Header copy()

writeTo

public void writeTo(java.io.DataOutput out)
             throws java.lang.Exception

Description copied from interface: Streamable

Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed

Throws:

java.lang.Exception

readFrom

public void readFrom(java.io.DataInput in)
              throws java.lang.Exception

Description copied from interface: Streamable

Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed

Throws:

java.lang.Exception