Module org.snmp4j

Package org.snmp4j.transport

Class TcpTransportMapping<S extends AbstractSocketEntry<TcpAddress>>

java.lang.Object

org.snmp4j.transport.AbstractTransportMapping<TcpAddress>

org.snmp4j.transport.AbstractConnectionOrientedTransportMapping<TcpAddress,S>

org.snmp4j.transport.TcpTransportMapping<S>

Type Parameters:

S - defines the type of AbstractSocketEntry used by this transport mapping.

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectionOrientedTransportMapping<TcpAddress>, TransportMapping<TcpAddress>

Direct Known Subclasses:

DefaultTcpTransportMapping, TLSTM

public abstract class TcpTransportMapping<S extends AbstractSocketEntry<TcpAddress>>
extends AbstractConnectionOrientedTransportMapping<TcpAddress,S>
implements ConnectionOrientedTransportMapping<TcpAddress>

The TcpTransportMapping is the abstract base class for TCP transport mappings.

Version:

3.7.0

Author:

Frank Fock

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	openSocketOnSending	Enable or disable automatic (re)opening the communication socket when sending a message
protected TcpAddress	tcpAddress

Fields inherited from class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping

serverEnabled, sockets

Fields inherited from class org.snmp4j.transport.AbstractTransportMapping

asyncMsgProcessingSupported, connectionTimeout, listenWorkerTask, maxInboundMessageSize, socketCleaner, suspendedAddresses, transportListener, transportStateListeners

Constructor Summary

Constructors

Constructor	Description
TcpTransportMapping(TcpAddress tcpAddress)

Method Summary

Modifier and Type	Method	Description
TcpAddress	getAddress()	Deprecated. Use getListenAddress() instead.
TcpAddress	getListenAddress()	Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.
abstract MessageLengthDecoder	getMessageLengthDecoder()	Returns the MessageLengthDecoder used by this transport mapping.
Class<? extends Address>	getSupportedAddressClass()	Gets the primary Address class that is supported by this transport mapping.
boolean	isOpenSocketOnSending()	If true and method listen() has not been called yet or the connection has been closed or reset, then listen() will be called to open the communication socket when a message is being sent using sendMessage(TcpAddress, byte[], TransportStateReference, long, int).
abstract void	listen()	Listen for incoming messages.
abstract void	sendMessage(TcpAddress address, byte[] message, TransportStateReference tmStateReference, long timeoutMillis, int maxRetries)	Sends a message to the supplied address using this transport.
abstract void	setMessageLengthDecoder(MessageLengthDecoder messageLengthDecoder)	Sets the MessageLengthDecoder that decodes the total message length from the header of a message.
void	setOpenSocketOnSending(boolean openSocketOnSending)	Activate or deactivate auto listen() when sendMessage(TcpAddress, byte[], TransportStateReference, long, int) is called but there is no listening socket.

Methods inherited from class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping

cancelNonServerSelectionKey, close, close, closeSockets, getConnectionTimeout, getMaxBusyLoops, getSockets, isServerEnabled, setConnectionTimeout, setMaxBusyLoops, setServerEnabled, setSocketOptions, timeoutSocket, wakeupServerSelector

Methods inherited from class org.snmp4j.transport.AbstractTransportMapping

addTransportListener, addTransportStateListener, fireConnectionStateChanged, fireProcessMessage, getListenWorkerTask, getMaxInboundMessageSize, getPriority, getSocketCleaner, getSuspendedAddresses, getThreadName, handleDroppedMessageToSend, isAsyncMsgProcessingSupported, isListening, removeAllTransportListeners, removeTransportListener, removeTransportStateListener, resumeAddress, setAsyncMsgProcessingSupported, setPriority, setThreadName, suspendAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snmp4j.transport.ConnectionOrientedTransportMapping

addTransportStateListener, close, getConnectionTimeout, getSocketCleaner, isServerEnabled, removeTransportStateListener, resumeAddress, setConnectionTimeout, setServerEnabled, suspendAddress

Methods inherited from interface org.snmp4j.TransportMapping

addTransportListener, close, getMaxInboundMessageSize, getMaxOutboundMessageSize, getSupportedAddressClasses, getSupportedTransportType, isAddressSupported, isAddressSupported, isListening, removeTransportListener

Field Details

tcpAddress

protected TcpAddress tcpAddress

openSocketOnSending

protected boolean openSocketOnSending

Enable or disable automatic (re)opening the communication socket when sending a message

Constructor Details

TcpTransportMapping

public TcpTransportMapping(TcpAddress tcpAddress)

Method Details

getSupportedAddressClass

public Class<? extends Address> getSupportedAddressClass()

Description copied from interface: TransportMapping

Gets the primary Address class that is supported by this transport mapping.

Specified by:

getSupportedAddressClass in interface TransportMapping<S extends AbstractSocketEntry<TcpAddress>>

Specified by:

getSupportedAddressClass in class AbstractTransportMapping<TcpAddress>

Returns:

a subclass of Address.

getAddress

@Deprecated
public TcpAddress getAddress()

Deprecated.

Use getListenAddress() instead.

Returns the transport address that is used by this transport mapping for sending and receiving messages.

Returns:

the Address used by this transport mapping. The returned instance must not be modified!

getListenAddress

public TcpAddress getListenAddress()

Description copied from interface: TransportMapping

Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.

Specified by:

getListenAddress in interface TransportMapping<S extends AbstractSocketEntry<TcpAddress>>

Specified by:

getListenAddress in class AbstractTransportMapping<TcpAddress>

Returns:

the address for incoming packets or null this transport mapping is not configured to listen for incoming packets.

sendMessage

public abstract void sendMessage(TcpAddress address,
 byte[] message,
 TransportStateReference tmStateReference,
 long timeoutMillis,
 int maxRetries)
                          throws IOException

Description copied from class: AbstractTransportMapping

Sends a message to the supplied address using this transport. If the target address has been suspended, then instead actually sending the message on the wire, the method AbstractTransportMapping.handleDroppedMessageToSend(Address, byte[], TransportStateReference, long, int) will be called. To stop suspending of a target address, call AbstractTransportMapping.resumeAddress(Address) for that address.

Specified by:

sendMessage in interface TransportMapping<S extends AbstractSocketEntry<TcpAddress>>

Specified by:

sendMessage in class AbstractTransportMapping<TcpAddress>

Parameters:

address - an Address instance denoting the target address.

message - the whole message as an array of bytes.

tmStateReference - the (optional) transport model state reference as defined by RFC 5590 section 6.1.

timeoutMillis - maximum number of milliseconds the connection creation might take (if connection based).

maxRetries - maximum retries during connection creation.

Throws:

IOException - if any underlying IO operation fails.

isOpenSocketOnSending

public boolean isOpenSocketOnSending()

If true and method listen() has not been called yet or the connection has been closed or reset, then listen() will be called to open the communication socket when a message is being sent using sendMessage(TcpAddress, byte[], TransportStateReference, long, int).

Returns:

true if sendMessage(TcpAddress, byte[], TransportStateReference, long, int) will ensure that a server socket is there for receiving responses, false otherwise.

Since:

3.4.4

setOpenSocketOnSending

public void setOpenSocketOnSending(boolean openSocketOnSending)

Activate or deactivate auto listen() when sendMessage(TcpAddress, byte[], TransportStateReference, long, int) is called but there is no listening socket.

Parameters:

openSocketOnSending - true if sendMessage(TcpAddress, byte[], TransportStateReference, long, int) should ensure that server socket is available for communication, false if listen() must be called explicitly.

Since:

3.4.4

listen

public abstract void listen()
                     throws IOException

Description copied from interface: TransportMapping

Listen for incoming messages. For connection oriented transports, this method needs to be called before TransportMapping.sendMessage(A, byte[], org.snmp4j.TransportStateReference, long, int) is called for the first time.

Specified by:

listen in interface TransportMapping<S extends AbstractSocketEntry<TcpAddress>>

Specified by:

listen in class AbstractTransportMapping<TcpAddress>

Throws:

IOException - if an IO operation exception occurs while starting the listener.

getMessageLengthDecoder

public abstract MessageLengthDecoder getMessageLengthDecoder()

Returns the MessageLengthDecoder used by this transport mapping.

Specified by:

getMessageLengthDecoder in interface ConnectionOrientedTransportMapping<S extends AbstractSocketEntry<TcpAddress>>

Returns:

a MessageLengthDecoder instance.

Since:

1.7

setMessageLengthDecoder

public abstract void setMessageLengthDecoder(MessageLengthDecoder messageLengthDecoder)

Sets the MessageLengthDecoder that decodes the total message length from the header of a message.

Specified by:

setMessageLengthDecoder in interface ConnectionOrientedTransportMapping<S extends AbstractSocketEntry<TcpAddress>>

Parameters:

messageLengthDecoder - a MessageLengthDecoder instance.

Since:

1.7