Package org.snmp4j.agent.agentx

Class AgentXClosePDU

java.lang.Object

org.snmp4j.agent.agentx.AgentXPDU

org.snmp4j.agent.agentx.AgentXClosePDU

All Implemented Interfaces:

Serializable

public class AgentXClosePDU
extends AgentXPDU

The AgentXClosePDU represents the agentx-Close-PDU from RFC 2741.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.snmp4j.agent.agentx.AgentXPDU

AGENTX_ADDAGENTCAPS_PDU, AGENTX_CLEANUPSET_PDU, AGENTX_CLOSE_PDU, AGENTX_COMMITSET_PDU, AGENTX_GET_PDU, AGENTX_GETBULK_PDU, AGENTX_GETNEXT_PDU, AGENTX_INDEXALLOCATE_PDU, AGENTX_INDEXDEALLOCATE_PDU, AGENTX_NOTIFY_PDU, AGENTX_OPEN_PDU, AGENTX_PING_PDU, AGENTX_REGISTER_PDU, AGENTX_REMOVEAGENTCAPS_PDU, AGENTX_RESPONSE_PDU, AGENTX_TESTSET_PDU, AGENTX_UNDOSET_PDU, AGENTX_UNREGISTER_PDU, byteOrder, flags, packetID, RESERVED, sessionID, transactionID, type, version

Constructor Summary

Constructors

Constructor	Description
AgentXClosePDU(byte reason)	Creates a AgentXClosePDU from a close reason.
AgentXClosePDU(AgentXMessageHeader header)	Creates a AgentXClosePDU from a AgentXMessageHeader.

Method Summary

Modifier and Type	Method	Description
protected void	beforeEncode()	Initialize flags and other things before a PDU is encoded.
void	decodePayload(ByteBuffer buf, int length)	Decode this PDU's payload.
void	encodePayload(ByteBuffer buf)	Encode the payload to the given byte buffer.
int	getPayloadLength()	Gets the payload length.
byte	getReason()	Gets the reason for the close.
void	setReason(byte reason)	Sets the close reason, see AgentXProtocol.REASON_OTHER for example.

Methods inherited from class org.snmp4j.agent.agentx.AgentXPDU

addFlag, decode, encode, getByteOrder, getFlags, getPacketID, getSessionID, getTransactionID, getType, getVersion, isConfirmedPDU, isFlagSet, setByteOrder, setFlags, setPacketID, setSessionAttributes, setSessionID, setTransactionID, setType, setVersion, toString, toStringExtMembers

Methods inherited from class java.lang.Object

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

Constructor Details

AgentXClosePDU

public AgentXClosePDU(AgentXMessageHeader header)

Creates a AgentXClosePDU from a AgentXMessageHeader.

Parameters:

header - the message header.

AgentXClosePDU

public AgentXClosePDU(byte reason)

Creates a AgentXClosePDU from a close reason.

Parameters:

reason - the reason to close, see AgentXProtocol.REASON_OTHER for example.

Method Details

decodePayload

public void decodePayload(ByteBuffer buf,
 int length)
                   throws IOException

Description copied from class: AgentXPDU

Decode this PDU's payload.

Specified by:

decodePayload in class AgentXPDU

Parameters:

buf - the buffer positioned at the end of the encoded context.

length - the length of the PDU to be decoded.

Throws:

IOException - if the buffer contains less data than expected.

getReason

public byte getReason()

Gets the reason for the close.

Returns:

the close reason, AgentXProtocol.REASON_OTHER for example.

setReason

public void setReason(byte reason)

Sets the close reason, see AgentXProtocol.REASON_OTHER for example.

Parameters:

reason - a AgentX close reason.

getPayloadLength

public int getPayloadLength()

Description copied from class: AgentXPDU

Gets the payload length.

Specified by:

getPayloadLength in class AgentXPDU

Returns:

the payload length.

encodePayload

public void encodePayload(ByteBuffer buf)

Description copied from class: AgentXPDU

Encode the payload to the given byte buffer.

Specified by:

encodePayload in class AgentXPDU

Parameters:

buf - the buffer.

beforeEncode

protected void beforeEncode()

Description copied from class: AgentXPDU

Initialize flags and other things before a PDU is encoded.

Specified by:

beforeEncode in class AgentXPDU