org.jgroups.protocols

Class SaslHeader

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.SaslHeader

All Implemented Interfaces:

Streamable

public class SaslHeader
extends Header

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SaslHeader.Type

Field Summary

Fields inherited from class org.jgroups.Header

prot_id

Constructor Summary

Constructors

Constructor and Description
SaslHeader()
SaslHeader(SaslHeader.Type type, byte[] payload)

Method Summary

Modifier and Type	Method and Description
byte[]	getPayload()
SaslHeader.Type	getType()
SaslHeader	payload(byte[] payload)
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
void	setPayload(byte[] payload)
void	setType(SaslHeader.Type type)
int	size() To be implemented by subclasses.
byte[]	token()
java.lang.String	toString()
SaslHeader	type(SaslHeader.Type 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

Constructor Detail

SaslHeader

public SaslHeader()

SaslHeader

public SaslHeader(SaslHeader.Type type,
                  byte[] payload)

Method Detail

getPayload

public byte[] getPayload()

setPayload

public void setPayload(byte[] payload)

getType

public SaslHeader.Type getType()

setType

public void setType(SaslHeader.Type type)

payload

public SaslHeader payload(byte[] payload)

token

public byte[] token()

type

public SaslHeader type(SaslHeader.Type type)

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

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

toString

public java.lang.String toString()

Overrides:

toString in class Header