- java.lang.Object
-
- org.snmp4j.transport.AbstractTransportMapping<TcpAddress>
-
- org.snmp4j.transport.TcpTransportMapping<DefaultTcpTransportMapping.SocketEntry>
-
- org.snmp4j.transport.DefaultTcpTransportMapping
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,ConnectionOrientedTransportMapping<TcpAddress>
,TransportMapping<TcpAddress>
public class DefaultTcpTransportMapping extends TcpTransportMapping<DefaultTcpTransportMapping.SocketEntry>
TheDefaultTcpTransportMapping
implements a TCP transport mapping with the Java 1.4 new IO API.It uses a single thread for processing incoming and outgoing messages. The thread is started when the
listen
method is called, or when an outgoing request is sent using thesendMessage
method.- Version:
- 3.0
- Author:
- Frank Fock
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
DefaultTcpTransportMapping.ServerThread
static class
DefaultTcpTransportMapping.SnmpMesssageLengthDecoder
protected class
DefaultTcpTransportMapping.SocketEntry
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_BUSY_LOOPS
The maximum number of loops trying to read data from an incoming port but no data has been received.protected MessageLengthDecoder
messageLengthDecoder
protected DefaultTcpTransportMapping.ServerThread
serverThread
-
Fields inherited from class org.snmp4j.transport.TcpTransportMapping
connectionTimeout, openSocketOnSending, serverEnabled, socketCleaner, sockets, tcpAddress
-
Fields inherited from class org.snmp4j.transport.AbstractTransportMapping
asyncMsgProcessingSupported, listenWorkerTask, maxInboundMessageSize, suspendedAddresses, transportListener
-
-
Constructor Summary
Constructors Constructor Description DefaultTcpTransportMapping()
Creates a default TCP transport mapping with the server for incoming messages disabled.DefaultTcpTransportMapping(TcpAddress serverAddress)
Creates a default TCP transport mapping that binds to the given address (interface) on the local host and enables server mode (i.e.DefaultTcpTransportMapping(TcpAddress serverAddress, boolean serverEnabled)
Creates a default TCP transport mapping that binds to the given address (interface) on the local host and enables server mode on request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addBufferToReadBuffer(DefaultTcpTransportMapping.SocketEntry entry, java.nio.ByteBuffer byteBuffer)
void
close()
Closes all open sockets and stops the internal server thread that processes messages and removes all queued requests and socket entries.protected TcpAddress
createIncomingAddress(java.net.Socket s)
TcpAddress
getListenAddress()
Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.protected WorkerTask
getListenerWorkerTask()
Gets theWorkerTask
that is responsible for receiving new messages.protected int
getMaxBusyLoops()
int
getMaxInboundMessageSize()
Gets the inbound buffer size for incoming requests.MessageLengthDecoder
getMessageLengthDecoder()
Returns theMessageLengthDecoder
used by this transport mapping.CommonTimer
getSocketCleaner()
Gets theCommonTimer
that controls socket cleanup operations.TransportType
getSupportedTransportType()
Gets theTransportType
thisTransportMapping
supports depending onTcpTransportMapping.isServerEnabled()
.void
listen()
Listen for incoming and outgoing requests.void
sendMessage(TcpAddress address, byte[] message, TransportStateReference tmStateReference, long timeoutMillis, int maxRetries)
Sends a SNMP message to the supplied address.protected void
setMaxBusyLoops(int maxBusyLoops)
void
setMaxInboundMessageSize(int maxInboundMessageSize)
Sets the maximum buffer size for incoming requests.void
setMessageLengthDecoder(MessageLengthDecoder messageLengthDecoder)
Sets the message length decoder.protected void
socketClosedRemotely(java.nio.channels.SelectionKey sk, java.nio.channels.SocketChannel readChannel, TcpAddress incomingAddress)
-
Methods inherited from class org.snmp4j.transport.TcpTransportMapping
addTransportStateListener, cancelNonServerSelectionKey, close, closeSockets, fireConnectionStateChanged, getAddress, getConnectionTimeout, getListenWorkerTask, getSupportedAddressClass, isOpenSocketOnSending, isServerEnabled, removeTransportStateListener, setConnectionTimeout, setOpenSocketOnSending, setServerEnabled, setSocketOptions, timeoutSocket
-
Methods inherited from class org.snmp4j.transport.AbstractTransportMapping
addTransportListener, fireProcessMessage, getPriority, getThreadName, handleDroppedMessageToSend, isAsyncMsgProcessingSupported, isListening, removeAllTransportListeners, removeTransportListener, 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
resumeAddress, suspendAddress
-
Methods inherited from interface org.snmp4j.TransportMapping
addTransportListener, getSupportedAddressClasses, isAddressSupported, isAddressSupported, isListening, removeTransportListener
-
-
-
-
Field Detail
-
DEFAULT_MAX_BUSY_LOOPS
public static final int DEFAULT_MAX_BUSY_LOOPS
The maximum number of loops trying to read data from an incoming port but no data has been received. A value of 0 or less disables the check.- See Also:
- Constant Field Values
-
serverThread
protected DefaultTcpTransportMapping.ServerThread serverThread
-
messageLengthDecoder
protected MessageLengthDecoder messageLengthDecoder
-
-
Constructor Detail
-
DefaultTcpTransportMapping
public DefaultTcpTransportMapping() throws java.io.IOException
Creates a default TCP transport mapping with the server for incoming messages disabled.- Throws:
java.io.IOException
- on failure of binding a local port.
-
DefaultTcpTransportMapping
public DefaultTcpTransportMapping(TcpAddress serverAddress, boolean serverEnabled) throws java.io.IOException
Creates a default TCP transport mapping that binds to the given address (interface) on the local host and enables server mode on request.- Parameters:
serverAddress
- the TcpAddress instance that describes the server address to listen on incoming connection requests.serverEnabled
- iftrue
the server mode is enabled and incoming new connections are accepted. Usefalse
to allow outgoing messages and their responses only (client mode).- Throws:
java.io.IOException
- if the given address cannot be bound.
-
DefaultTcpTransportMapping
public DefaultTcpTransportMapping(TcpAddress serverAddress) throws java.io.IOException
Creates a default TCP transport mapping that binds to the given address (interface) on the local host and enables server mode (i.e. accepts incoming new connections).- Parameters:
serverAddress
- the TcpAddress instance that describes the server address to listen on incoming connection requests.- Throws:
java.io.IOException
- if the given address cannot be bound.
-
-
Method Detail
-
listen
public void listen() throws java.io.IOException
Listen for incoming and outgoing requests. If theserverEnabled
member isfalse
the server for incoming requests is not started. This starts the internal server thread that processes messages.- Specified by:
listen
in interfaceTransportMapping<TcpAddress>
- Specified by:
listen
in classTcpTransportMapping<DefaultTcpTransportMapping.SocketEntry>
- Throws:
java.net.SocketException
- when the transport is already listening for incoming/outgoing messages.java.io.IOException
- if the listen port could not be bound to the server thread.
-
getSupportedTransportType
public TransportType getSupportedTransportType()
Gets theTransportType
thisTransportMapping
supports depending onTcpTransportMapping.isServerEnabled()
.- Returns:
TransportType.any
ifTcpTransportMapping.isServerEnabled()
istrue
andTransportType.sender
otherwise.- Since:
- 3.2.0
-
getListenerWorkerTask
protected WorkerTask getListenerWorkerTask()
Description copied from class:AbstractTransportMapping
Gets theWorkerTask
that is responsible for receiving new messages.- Specified by:
getListenerWorkerTask
in classAbstractTransportMapping<TcpAddress>
- Returns:
- a
WorkerTask
instance which is most likely aDefaultThreadFactory.WorkerThread
.
-
close
public void close()
Closes all open sockets and stops the internal server thread that processes messages and removes all queued requests and socket entries.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in interfaceTransportMapping<TcpAddress>
- Specified by:
close
in classTcpTransportMapping<DefaultTcpTransportMapping.SocketEntry>
-
sendMessage
public void sendMessage(TcpAddress address, byte[] message, TransportStateReference tmStateReference, long timeoutMillis, int maxRetries) throws java.io.IOException
Sends a SNMP message to the supplied address.- Specified by:
sendMessage
in interfaceTransportMapping<TcpAddress>
- Specified by:
sendMessage
in classTcpTransportMapping<DefaultTcpTransportMapping.SocketEntry>
- Parameters:
address
- anTcpAddress
. AClassCastException
is thrown ifaddress
is not aTcpAddress
instance.message
- byte[] the message to sent.tmStateReference
- the (optional) transport model state reference as defined by RFC 5590 section 6.1.timeoutMillis
- maximum number of milli seconds the connection creation might take (if connection based).maxRetries
- maximum retries during connection creation.- Throws:
java.io.IOException
- if an IO exception occurs while trying to send the message.
-
getMessageLengthDecoder
public MessageLengthDecoder getMessageLengthDecoder()
Description copied from class:TcpTransportMapping
Returns theMessageLengthDecoder
used by this transport mapping.- Specified by:
getMessageLengthDecoder
in interfaceConnectionOrientedTransportMapping<TcpAddress>
- Specified by:
getMessageLengthDecoder
in classTcpTransportMapping<DefaultTcpTransportMapping.SocketEntry>
- Returns:
- a MessageLengthDecoder instance.
-
setMessageLengthDecoder
public void setMessageLengthDecoder(MessageLengthDecoder messageLengthDecoder)
Sets the message length decoder. Default message length decoder is theDefaultTcpTransportMapping.SnmpMesssageLengthDecoder
. The message length decoder must be able to decode the total length of a message for this transport mapping protocol(s).- Specified by:
setMessageLengthDecoder
in interfaceConnectionOrientedTransportMapping<TcpAddress>
- Specified by:
setMessageLengthDecoder
in classTcpTransportMapping<DefaultTcpTransportMapping.SocketEntry>
- Parameters:
messageLengthDecoder
- aMessageLengthDecoder
instance.
-
getSocketCleaner
public CommonTimer getSocketCleaner()
Gets theCommonTimer
that controls socket cleanup operations.- Returns:
- a socket cleaner timer.
- Since:
- 3.0
-
getMaxInboundMessageSize
public int getMaxInboundMessageSize()
Gets the inbound buffer size for incoming requests. When SNMP packets are received that are longer than this maximum size, the messages will be silently dropped and the connection will be closed.- Specified by:
getMaxInboundMessageSize
in interfaceTransportMapping<TcpAddress>
- Overrides:
getMaxInboundMessageSize
in classAbstractTransportMapping<TcpAddress>
- Returns:
- the maximum inbound buffer size in bytes.
-
setMaxInboundMessageSize
public void setMaxInboundMessageSize(int maxInboundMessageSize)
Sets the maximum buffer size for incoming requests. When SNMP packets are received that are longer than this maximum size, the messages will be silently dropped and the connection will be closed.- Parameters:
maxInboundMessageSize
- the length of the inbound buffer in bytes.
-
getMaxBusyLoops
protected int getMaxBusyLoops()
-
setMaxBusyLoops
protected void setMaxBusyLoops(int maxBusyLoops)
-
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 interfaceTransportMapping<TcpAddress>
- Overrides:
getListenAddress
in classTcpTransportMapping<DefaultTcpTransportMapping.SocketEntry>
- Returns:
- the address for incoming packets or
null
this transport mapping is not configured to listen for incoming packets.
-
createIncomingAddress
protected TcpAddress createIncomingAddress(java.net.Socket s)
-
addBufferToReadBuffer
protected void addBufferToReadBuffer(DefaultTcpTransportMapping.SocketEntry entry, java.nio.ByteBuffer byteBuffer)
-
socketClosedRemotely
protected void socketClosedRemotely(java.nio.channels.SelectionKey sk, java.nio.channels.SocketChannel readChannel, TcpAddress incomingAddress) throws java.io.IOException
- Throws:
java.io.IOException
-
-