net.itransformers.snmp2xml4j.snmptoolkit.transport

Class LogBasedTransportMapping

java.lang.Object

org.snmp4j.transport.AbstractTransportMapping

org.snmp4j.transport.UdpTransportMapping

net.itransformers.snmp2xml4j.snmptoolkit.transport.LogBasedTransportMapping

All Implemented Interfaces:

org.snmp4j.TransportMapping

public class LogBasedTransportMapping
extends org.snmp4j.transport.UdpTransportMapping
implements org.snmp4j.TransportMapping

LogBasedTransportMapping class.

Version:

$Id: $Id

Author:

niau

Field Summary

Fields

Modifier and Type	Field and Description
protected org.snmp4j.util.WorkerTask	listener
protected net.itransformers.snmp2xml4j.snmptoolkit.transport.LogBasedTransportMapping.ListenThread	listenerThread
static Pattern	p Constant p

Fields inherited from class org.snmp4j.transport.UdpTransportMapping

udpAddress

Fields inherited from class org.snmp4j.transport.AbstractTransportMapping

asyncMsgProcessingSupported, maxInboundMessageSize, transportListener

Constructor Summary

Constructors

Constructor and Description
LogBasedTransportMapping(BufferedReader reader, org.snmp4j.smi.TransportIpAddress transportIpAddress) Creates a UDP transport with an arbitrary local port on all local interfaces.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the socket and stops the listener thread.
int	getPriority() Returns the priority of the internal listen thread.
int	getReceiveBufferSize() Gets the requested receive buffer size for the underlying UDP socket.
String	getThreadName() Returns the name of the listen thread.
boolean	isListening() isListening.
void	listen() Starts the listener thread that accepts incoming messages.
void	sendMessage(org.snmp4j.smi.Address targetAddress, byte[] message) sendMessage.
void	setMaxInboundMessageSize(int maxInboundMessageSize) setMaxInboundMessageSize.
void	setPriority(int newPriority) Changes the priority of the listen thread for this UDP transport mapping.
void	setReceiveBufferSize(int receiveBufferSize) Sets the receive buffer size, which should be > the maximum inbound message size.
void	setThreadName(String name) Sets the name of the listen thread for this UDP transport mapping.

Methods inherited from class org.snmp4j.transport.UdpTransportMapping

getAddress, getListenAddress, getSupportedAddressClass

Methods inherited from class org.snmp4j.transport.AbstractTransportMapping

addMessageDispatcher, addTransportListener, fireProcessMessage, getMaxInboundMessageSize, isAsyncMsgProcessingSupported, removeMessageDispatcher, 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

addMessageDispatcher, addTransportListener, getListenAddress, getMaxInboundMessageSize, getSupportedAddressClass, removeMessageDispatcher, removeTransportListener

Field Detail

p

public static Pattern p

Constant p

listener

protected org.snmp4j.util.WorkerTask listener

listenerThread

protected net.itransformers.snmp2xml4j.snmptoolkit.transport.LogBasedTransportMapping.ListenThread listenerThread

Constructor Detail

LogBasedTransportMapping

public LogBasedTransportMapping(BufferedReader reader,
                                org.snmp4j.smi.TransportIpAddress transportIpAddress)
                         throws IOException

Creates a UDP transport with an arbitrary local port on all local interfaces.

Parameters:

reader - a BufferedReader object.

transportIpAddress - a TransportIpAddress object.

Throws:

IOException - if socket binding fails.

Method Detail

sendMessage

public void sendMessage(org.snmp4j.smi.Address targetAddress,
                        byte[] message)
                 throws IOException

sendMessage.

Specified by:

sendMessage in interface org.snmp4j.TransportMapping

Specified by:

sendMessage in class org.snmp4j.transport.UdpTransportMapping

Parameters:

targetAddress - a Address object.

message - an array of byte.

Throws:

IOException - if any.

close

public void close()
           throws IOException

Closes the socket and stops the listener thread.

Specified by:

close in interface org.snmp4j.TransportMapping

Specified by:

close in class org.snmp4j.transport.UdpTransportMapping

Throws:

IOException - if any.

listen

public void listen()
            throws IOException

Starts the listener thread that accepts incoming messages. The thread is started in daemon mode and thus it will not block application terminated. Nevertheless, the close() method should be called to stop the listen thread gracefully and free associated ressources.

Specified by:

listen in interface org.snmp4j.TransportMapping

Specified by:

listen in class org.snmp4j.transport.UdpTransportMapping

Throws:

IOException - if any.

setPriority

public void setPriority(int newPriority)

Changes the priority of the listen thread for this UDP transport mapping. This method has no effect, if called before listen() has been called for this transport mapping.

Parameters:

newPriority - the new priority.

Since:

1.2.2

See Also:

Thread

getPriority

public int getPriority()

Returns the priority of the internal listen thread.

Returns:

a value between Thread.MIN_PRIORITY and Thread.MAX_PRIORITY.

Since:

1.2.2

setThreadName

public void setThreadName(String name)

Sets the name of the listen thread for this UDP transport mapping. This method has no effect, if called before listen() has been called for this transport mapping.

Parameters:

name - the new thread name.

Since:

1.6

getThreadName

public String getThreadName()

Returns the name of the listen thread.

Returns:

the thread name if in listening mode, otherwise null.

Since:

1.6

setMaxInboundMessageSize

public void setMaxInboundMessageSize(int maxInboundMessageSize)

setMaxInboundMessageSize.

Parameters:

maxInboundMessageSize - a int.

getReceiveBufferSize

public int getReceiveBufferSize()

Gets the requested receive buffer size for the underlying UDP socket. This size might not reflect the actual size of the receive buffer, which is implementation specific.

Returns:

=0 if the default buffer size of the OS is used, or a value >0 if the user specified a buffer size.

setReceiveBufferSize

public void setReceiveBufferSize(int receiveBufferSize)

Sets the receive buffer size, which should be > the maximum inbound message size. This method has to be called before listen() to be effective.

Parameters:

receiveBufferSize - an integer value < 0 and > AbstractTransportMapping.getMaxInboundMessageSize().

isListening

public boolean isListening()

isListening.

Specified by:

isListening in interface org.snmp4j.TransportMapping

Returns:

a boolean.