Module org.snmp4j.transport.unix
Package org.snmp4j.transport.unix

Class UnixSocketStreamTransportMapping

java.lang.Object
org.snmp4j.transport.AbstractTransportMapping<UnixDomainAddress>
org.snmp4j.transport.AbstractConnectionOrientedTransportMapping<UnixDomainAddress,UnixSocketStreamTransportMapping.SocketEntry>
org.snmp4j.transport.unix.UnixSocketStreamTransportMapping
All Implemented Interfaces:
Closeable, AutoCloseable, org.snmp4j.transport.ConnectionOrientedTransportMapping<UnixDomainAddress>, org.snmp4j.TransportMapping<UnixDomainAddress>
public class UnixSocketStreamTransportMapping extends org.snmp4j.transport.AbstractConnectionOrientedTransportMapping<UnixDomainAddress,UnixSocketStreamTransportMapping.SocketEntry>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected class 
    UnixSocketStreamTransportMapping.ServerThread
     
    static class 
    UnixSocketStreamTransportMapping.SocketEntry
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected UnixDomainAddress
    listenAddress
     
    protected UnixSocketStreamTransportMapping.ServerThread
    serverThread
     

    Fields inherited from class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping

    serverEnabled, sockets

    Fields inherited from class org.snmp4j.transport.AbstractTransportMapping

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    UnixSocketStreamTransportMapping()
     
    UnixSocketStreamTransportMapping(UnixDomainAddress listenAddress)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    boolean
    close(UnixDomainAddress remoteAddress)
     
    UnixDomainAddress
    getListenAddress()
     
    org.snmp4j.transport.MessageLengthDecoder
    getMessageLengthDecoder()
     
    Class<? extends org.snmp4j.smi.Address>
    getSupportedAddressClass()
     
    Set<Class<? extends org.snmp4j.smi.Address>>
    getSupportedAddressClasses()
     
    boolean
    isListening()
     
    void
    listen()
     
    protected Optional<ByteBuffer>
    readNextInPacket(SocketChannel socketChannel)
    Read the next network packet for the application.
    void
    sendMessage(UnixDomainAddress address, byte[] message, org.snmp4j.TransportStateReference tmStateReference, long timeoutMillis, int maxRetries)
     
    void
    setMessageLengthDecoder(org.snmp4j.transport.MessageLengthDecoder messageLengthDecoder)
     
    void
    wakeupServerSelector()
     

    Methods inherited from class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping

    cancelNonServerSelectionKey, closeSockets, getConnectionTimeout, getMaxBusyLoops, getSockets, isServerEnabled, setConnectionTimeout, setMaxBusyLoops, setServerEnabled, setSocketOptions, timeoutSocket

    Methods inherited from class org.snmp4j.transport.AbstractTransportMapping

    addTransportListener, addTransportStateListener, fireConnectionStateChanged, fireProcessMessage, getListenWorkerTask, getMaxInboundMessageSize, getPriority, getSocketCleaner, getSuspendedAddresses, getThreadName, handleDroppedMessageToSend, isAsyncMsgProcessingSupported, 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.transport.ConnectionOrientedTransportMapping

    addTransportStateListener, getSocketCleaner, removeTransportStateListener, resumeAddress, suspendAddress

    Methods inherited from interface org.snmp4j.TransportMapping

    addTransportListener, getMaxInboundMessageSize, getMaxOutboundMessageSize, getSupportedTransportType, isAddressSupported, isAddressSupported, removeTransportListener

  • Field Details

  • Constructor Details

    • UnixSocketStreamTransportMapping

      public UnixSocketStreamTransportMapping(UnixDomainAddress listenAddress)

    • UnixSocketStreamTransportMapping

      public UnixSocketStreamTransportMapping()

  • Method Details

    • getMessageLengthDecoder

      public org.snmp4j.transport.MessageLengthDecoder getMessageLengthDecoder()

    • setMessageLengthDecoder

      public void setMessageLengthDecoder(org.snmp4j.transport.MessageLengthDecoder messageLengthDecoder)

    • getSupportedAddressClass

      public Class<? extends org.snmp4j.smi.Address> getSupportedAddressClass()
      Specified by:
      getSupportedAddressClass in interface org.snmp4j.TransportMapping<UnixDomainAddress>
      Specified by:
      getSupportedAddressClass in class org.snmp4j.transport.AbstractTransportMapping<UnixDomainAddress>

    • getSupportedAddressClasses

      public Set<Class<? extends org.snmp4j.smi.Address>> getSupportedAddressClasses()

    • getListenAddress

      public UnixDomainAddress getListenAddress()
      Specified by:
      getListenAddress in interface org.snmp4j.TransportMapping<UnixDomainAddress>
      Specified by:
      getListenAddress in class org.snmp4j.transport.AbstractTransportMapping<UnixDomainAddress>

    • sendMessage

      public void sendMessage(UnixDomainAddress address, byte[] message, org.snmp4j.TransportStateReference tmStateReference, long timeoutMillis, int maxRetries) throws IOException
      Specified by:
      sendMessage in interface org.snmp4j.TransportMapping<UnixDomainAddress>
      Specified by:
      sendMessage in class org.snmp4j.transport.AbstractTransportMapping<UnixDomainAddress>
      Throws:
      IOException

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface org.snmp4j.TransportMapping<UnixDomainAddress>
      Overrides:
      close in class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping<UnixDomainAddress,UnixSocketStreamTransportMapping.SocketEntry>
      Throws:
      IOException

    • close

      public boolean close(UnixDomainAddress remoteAddress) throws IOException
      Specified by:
      close in interface org.snmp4j.transport.ConnectionOrientedTransportMapping<UnixDomainAddress>
      Overrides:
      close in class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping<UnixDomainAddress,UnixSocketStreamTransportMapping.SocketEntry>
      Throws:
      IOException

    • listen

      public void listen() throws IOException
      Specified by:
      listen in interface org.snmp4j.TransportMapping<UnixDomainAddress>
      Specified by:
      listen in class org.snmp4j.transport.AbstractTransportMapping<UnixDomainAddress>
      Throws:
      IOException

    • isListening

      public boolean isListening()
      Specified by:
      isListening in interface org.snmp4j.TransportMapping<UnixDomainAddress>
      Overrides:
      isListening in class org.snmp4j.transport.AbstractTransportMapping<UnixDomainAddress>

    • wakeupServerSelector

      public void wakeupServerSelector()
      Specified by:
      wakeupServerSelector in class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping<UnixDomainAddress,UnixSocketStreamTransportMapping.SocketEntry>

    • readNextInPacket

      protected Optional<ByteBuffer> readNextInPacket(SocketChannel socketChannel) throws IOException
      Read the next network packet for the application.
      Parameters:
      socketChannel - the socket channel to read the data from.
      Returns:
      a byte buffer with the application data of the packet.
      Throws:
      IOException - if there occurs an IO exception during preparation.
      Since:
      3.7