Package org.jgroups.protocols

Class TpHeader

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.TpHeader

All Implemented Interfaces:

Constructable<Header>, SizeStreamable, Streamable

public class TpHeader
extends Header

Generic transport header, used by TP.

Author:

Bela Ban

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	cluster_name
protected byte	flag
protected int	index
static byte	REQ
static byte	RSP

Fields inherited from class org.jgroups.Header

prot_id

Constructor Summary

Constructors

Constructor	Description
TpHeader()
TpHeader(byte[] n)
TpHeader(java.lang.String n)
TpHeader(java.lang.String n, byte flag, int index)
TpHeader(AsciiString n)
TpHeader(AsciiString n, byte flag, int index)

Method Summary

Modifier and Type	Method	Description
byte[]	clusterName()
java.util.function.Supplier<? extends Header>	create()	Creates an instance of the class implementing this interface
byte	flag()
byte[]	getClusterName()
short	getMagicId()	Returns the magic-ID.
int	index()
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
int	serializedSize()	Returns the size (in bytes) of the marshalled object
java.lang.String	toString()
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

cluster_name

protected byte[] cluster_name

REQ

public static final byte REQ

See Also:

Constant Field Values

RSP

public static final byte RSP

See Also:

Constant Field Values

flag

protected byte flag

index

protected int index

Constructor Detail

TpHeader

public TpHeader()

TpHeader

public TpHeader(java.lang.String n)

TpHeader

public TpHeader(java.lang.String n,
                byte flag,
                int index)

TpHeader

public TpHeader(AsciiString n)

TpHeader

public TpHeader(AsciiString n,
                byte flag,
                int index)

TpHeader

public TpHeader(byte[] n)

Method Detail

getClusterName

public byte[] getClusterName()

clusterName

public byte[] clusterName()

flag

public byte flag()

index

public int index()

create

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

Description copied from interface: Constructable

Creates an instance of the class implementing this interface

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

toString

public java.lang.String toString()

Overrides:

toString in class Header

serializedSize

public int serializedSize()

Description copied from interface: SizeStreamable

Returns the size (in bytes) of the marshalled object

writeTo

public void writeTo(java.io.DataOutput out)
             throws java.io.IOException

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.io.IOException

readFrom

public void readFrom(java.io.DataInput in)
              throws java.io.IOException

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.io.IOException