Module org.snmp4j
Package org.snmp4j.transport
Interface ConnectionOrientedTransportMapping<A extends Address>
-
- All Superinterfaces:
java.lang.AutoCloseable,java.io.Closeable,TransportMapping<A>
- All Known Implementing Classes:
DefaultTcpTransportMapping,DTLSTM,TcpTransportMapping,TLSTM
public interface ConnectionOrientedTransportMapping<A extends Address> extends TransportMapping<A>
Transport mappings for connection oriented transport protocols have to implement this interface.- Since:
- 1.7
- Version:
- 3.0
- Author:
- Frank Fock
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddTransportStateListener(TransportStateListener l)Adds a transport state listener that is to be informed about connection state changes.booleanclose(A remoteAddress)Closes the connection to the given remote address (socket).longgetConnectionTimeout()Gets the connection timeout in millisecondsMessageLengthDecodergetMessageLengthDecoder()Returns theMessageLengthDecoderused by this transport mapping.CommonTimergetSocketCleaner()Gets theCommonTimerthat controls socket cleanup operations.voidremoveTransportStateListener(TransportStateListener l)Removes the supplied transport state listener.voidsetConnectionTimeout(long connectionTimeout)Sets the connection timeout.voidsetMessageLengthDecoder(MessageLengthDecoder messageLengthDecoder)Sets theMessageLengthDecoderthat decodes the total message length from the header of a message.-
Methods inherited from interface org.snmp4j.TransportMapping
addTransportListener, close, getListenAddress, getMaxInboundMessageSize, getSupportedAddressClass, getSupportedAddressClasses, getSupportedTransportType, isAddressSupported, isAddressSupported, isListening, listen, removeTransportListener, sendMessage
-
-
-
-
Method Detail
-
getMessageLengthDecoder
MessageLengthDecoder getMessageLengthDecoder()
Returns theMessageLengthDecoderused by this transport mapping.- Returns:
- a MessageLengthDecoder instance.
-
setMessageLengthDecoder
void setMessageLengthDecoder(MessageLengthDecoder messageLengthDecoder)
Sets theMessageLengthDecoderthat decodes the total message length from the header of a message.- Parameters:
messageLengthDecoder- a MessageLengthDecoder instance.
-
setConnectionTimeout
void setConnectionTimeout(long connectionTimeout)
Sets the connection timeout. This timeout specifies the time a connection may be idle before it is closed.- Parameters:
connectionTimeout- the idle timeout in milliseconds. A zero or negative value will disable any timeout and connections opened by this transport mapping will stay opened until they are explicitly closed.
-
addTransportStateListener
void addTransportStateListener(TransportStateListener l)
Adds a transport state listener that is to be informed about connection state changes.- Parameters:
l- a TransportStateListener.
-
removeTransportStateListener
void removeTransportStateListener(TransportStateListener l)
Removes the supplied transport state listener.- Parameters:
l- a TransportStateListener.
-
close
boolean close(A remoteAddress) throws java.io.IOException
Closes the connection to the given remote address (socket).- Parameters:
remoteAddress- the address of the remote socket.- Returns:
trueif the connection could be closed andfalseif the connection does not exists.- Throws:
java.io.IOException- if closing the connection with the specified remote address fails.- Since:
- 1.7.1
-
getSocketCleaner
CommonTimer getSocketCleaner()
Gets theCommonTimerthat controls socket cleanup operations.- Returns:
- a socket cleaner timer.
- Since:
- 3.0
-
getConnectionTimeout
long getConnectionTimeout()
Gets the connection timeout in milliseconds- Returns:
- the timeout millis after which an inactive connection can be closed.
- Since:
- 3.0
-
-