Class UnixSocketStreamTransportMapping.ServerThread

java.lang.Object

org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

org.snmp4j.transport.unix.UnixSocketStreamTransportMapping.ServerThread

All Implemented Interfaces:

Runnable, org.snmp4j.util.WorkerTask

Enclosing class:

UnixSocketStreamTransportMapping

protected class UnixSocketStreamTransportMapping.ServerThread
extends org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

Field Summary

Fields inherited from class org.snmp4j.transport.AbstractTransportServerThread

exitLatch, lastError, pending, selector, serverAddress, shutdown, ssc, stop, transportMapping

Method Summary

Modifier and Type	Method	Description
protected void	bindOutgoingSocket(SocketChannel socketChannel)	Binds an outgoing socket to the socket path of this transport mapping, so that the peer this socket connects to can tell this SNMP entity apart from other entities that connect to it.
protected UnixDomainAddress	createIncomingAddress(SocketChannel socketChannel)
UnixSocketStreamTransportMapping.SocketEntry	createSocketEntry(UnixDomainAddress address, SocketChannel socketChannel, boolean useClientMode, org.snmp4j.TransportStateReference tmStateReference)
Throwable	getLastError()
protected ServerSocketChannel	getServerSocketChannel()
protected boolean	initListener(UnixDomainAddress address, Selector selector)
boolean	isStop()
boolean	join(long timeout)
protected SocketChannel	openSocketChannel(ProtocolFamily family)
protected void	processQueues()
protected boolean	readMessage(SelectionKey sk, SocketChannel socketChannel, UnixDomainAddress incomingAddress, UnixSocketStreamTransportMapping.SocketEntry socketEntry)
UnixSocketStreamTransportMapping.SocketEntry	removeSocketEntry(UnixDomainAddress incomingAddress)
void	run()
void	setStop(boolean stop)
void	shutdown()

Methods inherited from class org.snmp4j.transport.AbstractTransportServerThread

close, closeChannel, connectChannel, connectSocketToSendMessage, doServer, fireIncrementCounterSessionClose, getSelector, interrupt, join, sendMessage, terminate, writeData, writeMessage

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getLastError

public Throwable getLastError()

isStop

public boolean isStop()

setStop

public void setStop(boolean stop)

getServerSocketChannel

protected ServerSocketChannel getServerSocketChannel()

initListener

protected boolean initListener(UnixDomainAddress address,
 Selector selector)
                        throws IOException

Throws:

IOException

run

public void run()

Specified by:

run in interface Runnable

Specified by:

run in class org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

readMessage

protected boolean readMessage(SelectionKey sk,
 SocketChannel socketChannel,
 UnixDomainAddress incomingAddress,
 UnixSocketStreamTransportMapping.SocketEntry socketEntry)
                       throws IOException

Specified by:

readMessage in class org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

Throws:

IOException

processQueues

protected void processQueues()

Specified by:

processQueues in class org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

createSocketEntry

public UnixSocketStreamTransportMapping.SocketEntry createSocketEntry(UnixDomainAddress address,
 SocketChannel socketChannel,
 boolean useClientMode,
 org.snmp4j.TransportStateReference tmStateReference)

Specified by:

createSocketEntry in class org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

openSocketChannel

protected SocketChannel openSocketChannel(ProtocolFamily family)
                                   throws IOException

Specified by:

openSocketChannel in class org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

Throws:

IOException

bindOutgoingSocket

protected void bindOutgoingSocket(SocketChannel socketChannel)
                           throws IOException

Binds an outgoing socket to the socket path of this transport mapping, so that the peer this socket connects to can tell this SNMP entity apart from other entities that connect to it. A Unix domain socket that has not been bound has no address at all, thus every peer that connects without binding its socket is reported with the same empty address by the accepting entity - which then cannot address more than one of them.

The socket is bound in client mode only: in server mode the socket path is already bound by the server socket that accepts incoming connections and a path can be bound once only. If the path cannot be bound - for example because another process is using it - the connection is opened with an unbound socket, because being unidentifiable to the peer is better than not being able to communicate with it at all.

Parameters:

socketChannel - the outgoing socket to bind, must not be connected yet.

Throws:

IOException - if a socket file created by this transport mapping for an earlier connection could not be removed.

Since:

1.2.2

removeSocketEntry

public UnixSocketStreamTransportMapping.SocketEntry removeSocketEntry(UnixDomainAddress incomingAddress)

Specified by:

removeSocketEntry in class org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

createIncomingAddress

protected UnixDomainAddress createIncomingAddress(SocketChannel socketChannel)
                                           throws IOException

Specified by:

createIncomingAddress in class org.snmp4j.transport.AbstractTransportServerThread<UnixDomainAddress, UnixSocketStreamTransportMapping.SocketEntry>

Throws:

IOException

shutdown

public void shutdown()

join

public boolean join(long timeout)
             throws InterruptedException

Throws:

InterruptedException