Package org.snmp4j
Interface TransportMapping<A extends Address>
- All Known Subinterfaces:
ConnectionOrientedTransportMapping<A>
- All Known Implementing Classes:
AbstractTransportMapping
,DefaultSshTransportMapping
,DefaultTcpTransportMapping
,DefaultUdpTransportMapping
,DummyTransport
,DummyTransport.DummyTransportResponder
,TcpTransportMapping
,TLSTM
,UdpTransportMapping
public interface TransportMapping<A extends Address>
The
TransportMapping
defines the common interface for SNMP
transport mappings. A transport mapping can only support a single
transport protocol.- Version:
- 2.0
- Author:
- Frank Fock
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addTransportListener
(TransportListener transportListener) Adds a transport listener to the transport.void
close()
Closes the transport an releases all bound resources synchronously.Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.int
Gets the maximum length of an incoming message that can be successfully processed by this transport mapping implementation.int
Gets the maximum length of an outgoing message that can be successfully processed by this transport mapping implementation.Gets theAddress
class that is supported by this transport mapping.boolean
Returnstrue
if the transport mapping is listening for incoming messages.void
listen()
Listen for incoming messages.void
removeTransportListener
(TransportListener transportListener) Removes a transport listener.void
sendMessage
(A address, byte[] message, TransportStateReference tmStateReference) Sends a message to the supplied address using this transport.
-
Method Details
-
getSupportedAddressClass
Gets theAddress
class that is supported by this transport mapping.- Returns:
- a subclass of
Address
.
-
getListenAddress
A getListenAddress()Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.- Returns:
- the address for incoming packets or
null
this transport mapping is not configured to listen for incoming packets. - Since:
- 1.6
-
sendMessage
void sendMessage(A address, byte[] message, TransportStateReference tmStateReference) throws IOException Sends a message to the supplied address using this transport.- Parameters:
address
- anAddress
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.- Throws:
IOException
- if any underlying IO operation fails.
-
addTransportListener
Adds a transport listener to the transport. Normally, at least one transport listener needs to be added to process incoming messages.- Parameters:
transportListener
- aTransportListener
instance.- Since:
- 1.6
-
removeTransportListener
Removes a transport listener. Incoming messages will no longer be propagated to the suppliedTransportListener
.- Parameters:
transportListener
- aTransportListener
instance.- Since:
- 1.6
-
close
Closes the transport an releases all bound resources synchronously.- Throws:
IOException
- if any IO operation for the close fails.
-
listen
Listen for incoming messages. For connection oriented transports, this method needs to be called beforesendMessage(A, byte[], org.snmp4j.TransportStateReference)
is called for the first time.- Throws:
IOException
- if an IO operation exception occurs while starting the listener.
-
isListening
boolean isListening()Returnstrue
if the transport mapping is listening for incoming messages. For connection oriented transport mappings this is a prerequisite to be able to send SNMP messages. For connectionless transport mappings it is a prerequisite to be able to receive responses.- Returns:
true
if this transport mapping is listening for messages.- Since:
- 1.1
-
getMaxInboundMessageSize
int getMaxInboundMessageSize()Gets the maximum length of an incoming message that can be successfully processed by this transport mapping implementation.- Returns:
- an integer > 484.
-
getMaxOutboundMessageSize
int getMaxOutboundMessageSize()Gets the maximum length of an outgoing message that can be successfully processed by this transport mapping implementation.- Returns:
- an integer > 484.
-