org.snmp4j.transport
Class UdpTransportMapping

java.lang.Object
  org.snmp4j.transport.AbstractTransportMapping<UdpAddress>
      org.snmp4j.transport.UdpTransportMapping

All Implemented Interfaces:

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:

1.0

Author:

Frank Fock

Field Summary

protected UdpAddress

udpAddress

Fields inherited from class org.snmp4j.transport.AbstractTransportMapping

asyncMsgProcessingSupported, maxInboundMessageSize, transportListener

Constructor Summary

UdpTransportMapping(UdpAddress udpAddress)

Method Summary

abstract void	close() Closes the transport an releases all bound resources synchronously.
UdpAddress	getAddress() Returns the transport address that is used by this transport mapping for sending and receiving messages.
UdpAddress	getListenAddress() Returns the address that represents the incoming address this transport mapping uses to listen for incoming packets.
java.lang.Class<? extends Address>	getSupportedAddressClass() Gets the 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) Sends a message to the supplied address using this transport.

Methods inherited from class org.snmp4j.transport.AbstractTransportMapping

addTransportListener, fireProcessMessage, getMaxInboundMessageSize, isAsyncMsgProcessingSupported, removeTransportListener, setAsyncMsgProcessingSupported

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

isListening

Field Detail

udpAddress

protected UdpAddress udpAddress

Constructor Detail

UdpTransportMapping

public UdpTransportMapping(UdpAddress udpAddress)

Method Detail

getSupportedAddressClass

public java.lang.Class<? extends Address> getSupportedAddressClass()

Description copied from interface: TransportMapping

Gets the 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 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 UdpAddress getListenAddress()

Description copied from interface: TransportMapping

Returns the address that represents the 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.

listen

public abstract void listen()
                     throws java.io.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) is called for the first time.

Specified by:

listen in interface TransportMapping<UdpAddress>

Specified by:

listen in class AbstractTransportMapping<UdpAddress>

Throws:

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

close

public abstract void close()
                    throws java.io.IOException

Description copied from interface: TransportMapping

Closes the transport an releases all bound resources synchronously.

Specified by:

close in interface TransportMapping<UdpAddress>

Specified by:

close in class AbstractTransportMapping<UdpAddress>

Throws:

java.io.IOException - if any IO operation for the close fails.

sendMessage

public abstract void sendMessage(UdpAddress address,
                                 byte[] message,
                                 TransportStateReference tmStateReference)
                          throws java.io.IOException

Description copied from interface: TransportMapping

Sends a message to the supplied address using this transport.

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.

Throws:

java.io.IOException - if any underlying IO operation fails.