org.jgroups.protocols

Class SCOPE.ScopeHeader

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.SCOPE.ScopeHeader

All Implemented Interfaces:

Streamable

Enclosing class:

SCOPE

public static class SCOPE.ScopeHeader
extends Header

Field Summary

Fields

Modifier and Type	Field and Description
static byte	EXPIRE
static byte	MSG

Fields inherited from class org.jgroups.Header

prot_id

Constructor Summary

Constructors

Constructor and Description
ScopeHeader()

Method Summary

Modifier and Type	Method and Description
static SCOPE.ScopeHeader	createExpireHeader(short scope)
static SCOPE.ScopeHeader	createMessageHeader(short scope)
short	getScope()
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	size() To be implemented by subclasses.
java.lang.String	toString()
static java.lang.String	typeToString(byte type)
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

MSG

public static final byte MSG

See Also:

Constant Field Values

EXPIRE

public static final byte EXPIRE

See Also:

Constant Field Values

Constructor Detail

ScopeHeader

public ScopeHeader()

Method Detail

createMessageHeader

public static SCOPE.ScopeHeader createMessageHeader(short scope)

createExpireHeader

public static SCOPE.ScopeHeader createExpireHeader(short scope)

getScope

public short getScope()

size

public 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

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

toString

public java.lang.String toString()

Overrides:

toString in class Header

typeToString

public static java.lang.String typeToString(byte type)