Module org.snmp4j

Package org.snmp4j.transport

Class UdpTransportMapping

java.lang.Object

org.snmp4j.transport.AbstractTransportMapping<UdpAddress>

org.snmp4j.transport.UdpTransportMapping

All Implemented Interfaces:

Closeable, AutoCloseable, TransportMapping<UdpAddress>

Direct Known Subclasses:

DefaultUdpTransportMapping

public abstract class UdpTransportMapping
extends AbstractTransportMapping<UdpAddress>

The UdpTransportMapping is the abstract base class for UDP transport mappings.

Version:

3.0

Author:

Frank Fock

Field Summary

Fields

Modifier and Type	Field	Description
protected UdpAddress	udpAddress

Fields inherited from class org.snmp4j.transport.AbstractTransportMapping

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

Constructor Summary

Constructors

Constructor	Description
UdpTransportMapping(UdpAddress udpAddress)

Method Summary

Modifier and Type	Method	Description
abstract void	close()	Closes the transport an releases all bound resources synchronously.
UdpAddress	getAddress()	Returns the transport address that is configured for this transport mapping for sending and receiving messages.
UdpAddress	getListenAddress()	Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.
Class<? extends Address>	getSupportedAddressClass()	Gets the primary Address class that is supported by this transport mapping.
abstract void	listen()	Listen for incoming messages.
abstract void	sendMessage(UdpAddress address, byte[] message, TransportStateReference tmStateReference, long timeoutMillis, int maxRetries)	Sends a message to the supplied address using this transport.

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.TransportMapping

getMaxOutboundMessageSize, getSupportedAddressClasses, getSupportedTransportType, isAddressSupported, isAddressSupported

Field Details

udpAddress

protected UdpAddress udpAddress

Constructor Details

UdpTransportMapping

public UdpTransportMapping(UdpAddress udpAddress)

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<UdpAddress>

Specified by:

getSupportedAddressClass in class AbstractTransportMapping<UdpAddress>

Returns:

a subclass of Address.

getAddress

public UdpAddress getAddress()

Returns the transport address that is configured for 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 UdpAddress 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<UdpAddress>

Specified by:

getListenAddress in class AbstractTransportMapping<UdpAddress>

Returns:

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

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<UdpAddress>

Specified by:

listen in class AbstractTransportMapping<UdpAddress>

Throws:

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

close

public abstract void close()
                    throws IOException

Description copied from interface: TransportMapping

Closes the transport an releases all bound resources synchronously.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface TransportMapping<UdpAddress>

Specified by:

close in class AbstractTransportMapping<UdpAddress>

Throws:

IOException - if any IO operation for the close fails.

sendMessage

public abstract void sendMessage(UdpAddress 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<UdpAddress>

Specified by:

sendMessage in class AbstractTransportMapping<UdpAddress>

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.