com.solacesystems.jcsmp.protocol.smf

Class SMFPubMsgHeaderBean

java.lang.Object

com.solacesystems.jcsmp.protocol.smf.SMFPubMsgHeaderBean

All Implemented Interfaces:

BufferCloningUser, HeaderDescriptionBean

public class SMFPubMsgHeaderBean
extends Object
implements HeaderDescriptionBean, BufferCloningUser

SMFPubMsgHeaderBean is only used by publisher for sending messages. It does not use TLVParameter objects to store header parameters. Instead, when publisher adds parameter into this header bean, the parameter is encoded right away into array of bytes.

Constructor Summary

Constructors

Constructor and Description
SMFPubMsgHeaderBean(boolean isDirect)
SMFPubMsgHeaderBean(SMFPubMsgHeaderBean toclone, BufferCloningPool bufCloningPool)

Method Summary

Modifier and Type	Method and Description
void	addEncodedParam(byte[] encodedParam)
void	addParam(AbstractTLVParameter param)
void	addParam(int uh, int type, byte[] value)
void	dumpHeaderToDirectBB()
SmfTLVParameter[]	findParameters(int typeEnum)
int	getAdf()
int	getDmqEligible()
int	getDto()
int	getElidingEligible()
int	getEncodedParams(byte[] paramData) Dumps the encoded parameter buffer to paramData.
byte[]	getHeaderBuf()
int	getHeaderBufLen()
ByteBuffer	getHeaderByteBuffer()
int	getMaxParamAction()
int	getMsgLen()
FastSmfParamContainer	getParamContainer()
SmfTLVParameter[]	getParams()
int	getSmfEncodedLength() Get smf encoded length (base size + param length + pad bytes)
int	getSmfEncodedLength(int smfVersion)
int	getSmfProtocol()
int	getUserCosValue()
boolean	isUnkParamFlagSet()
void	releaseContentBuffer(BufferCloningPool bufCloningPool)
void	reset()
void	setAdf(int adf)
void	setDmqEligible(int dmqEligible)
void	setDto(int dto)
void	setElidingEligible(int elidingEligible)
void	setHeaderBufLen(int len)
SMFPubMsgHeaderBean	setMsgLen(int msgLen)
void	setParamAction(int uh)
void	setSmfProtocol(int smfProtocol)
void	setUnkParamFlag(boolean unk_param_found)
void	setUserCosValue(int userCosValue)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SMFPubMsgHeaderBean

public SMFPubMsgHeaderBean(boolean isDirect)

SMFPubMsgHeaderBean

public SMFPubMsgHeaderBean(SMFPubMsgHeaderBean toclone,
                           BufferCloningPool bufCloningPool)

Method Detail

reset

public void reset()

Specified by:

reset in interface HeaderDescriptionBean

getMsgLen

public int getMsgLen()

setMsgLen

public SMFPubMsgHeaderBean setMsgLen(int msgLen)

addParam

public void addParam(AbstractTLVParameter param)

Specified by:

addParam in interface HeaderDescriptionBean

addParam

public void addParam(int uh,
                     int type,
                     byte[] value)

addEncodedParam

public void addEncodedParam(byte[] encodedParam)

getParamContainer

public FastSmfParamContainer getParamContainer()

findParameters

public SmfTLVParameter[] findParameters(int typeEnum)

getParams

public SmfTLVParameter[] getParams()

Specified by:

getParams in interface HeaderDescriptionBean

getEncodedParams

public int getEncodedParams(byte[] paramData)

Dumps the encoded parameter buffer to paramData. Does not include pad bytes.

Parameters:

paramData - Buffer to write to

Returns:

Bytes copied

toString

public String toString()

Overrides:

toString in class Object

getSmfEncodedLength

public int getSmfEncodedLength()

Get smf encoded length (base size + param length + pad bytes)

Specified by:

getSmfEncodedLength in interface HeaderDescriptionBean

getSmfEncodedLength

public int getSmfEncodedLength(int smfVersion)

getUserCosValue

public int getUserCosValue()

setUserCosValue

public void setUserCosValue(int userCosValue)

getDto

public int getDto()

setDto

public void setDto(int dto)

getAdf

public int getAdf()

setAdf

public void setAdf(int adf)

getDmqEligible

public int getDmqEligible()

setDmqEligible

public void setDmqEligible(int dmqEligible)

getElidingEligible

public int getElidingEligible()

setElidingEligible

public void setElidingEligible(int elidingEligible)

getMaxParamAction

public int getMaxParamAction()

Specified by:

getMaxParamAction in interface HeaderDescriptionBean

isUnkParamFlagSet

public boolean isUnkParamFlagSet()

Specified by:

isUnkParamFlagSet in interface HeaderDescriptionBean

setParamAction

public void setParamAction(int uh)

Specified by:

setParamAction in interface HeaderDescriptionBean

setUnkParamFlag

public void setUnkParamFlag(boolean unk_param_found)

Specified by:

setUnkParamFlag in interface HeaderDescriptionBean

getSmfProtocol

public int getSmfProtocol()

setSmfProtocol

public void setSmfProtocol(int smfProtocol)

getHeaderBuf

public byte[] getHeaderBuf()

getHeaderBufLen

public int getHeaderBufLen()

setHeaderBufLen

public void setHeaderBufLen(int len)

dumpHeaderToDirectBB

public void dumpHeaderToDirectBB()

getHeaderByteBuffer

public ByteBuffer getHeaderByteBuffer()

releaseContentBuffer

public void releaseContentBuffer(BufferCloningPool bufCloningPool)

Specified by:

releaseContentBuffer in interface BufferCloningUser