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>
A transport mapping implementation for Unix domain socket communication that leverages stream-oriented semantics. This class is built upon the AbstractConnectionOrientedTransportMapping, providing enhanced support for Unix domain socket addresses.

The class allows for sending and receiving messages, setting socket options, and managing Unix domain socket communication-specific behaviors. It supports asynchronous message handling and can handle multiple concurrent Unix domain socket-based connections.

  • 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
    The Unix domain socket address to which this transport mapping is bound.
    protected UnixSocketStreamTransportMapping.ServerThread
    serverThread
    The server thread responsible for handling incoming connections.

    Fields inherited from class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping

    connectionTimeout, gracefulShutdownTimeoutMillis, serverEnabled, sockets

    Fields inherited from class org.snmp4j.transport.AbstractTransportMapping

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    UnixSocketStreamTransportMapping()
    Constructs a UnixSocketStreamTransportMapping without specifying a Unix domain socket address.
    UnixSocketStreamTransportMapping(UnixDomainAddress listenAddress)
    Constructs a UnixSocketStreamTransportMapping with the specified Unix domain socket address.

  • 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)
     
    protected <T> void
    setSocketOption(SocketOption<T> socketOption, T value)
     
    void
    wakeupServerSelector()
     

    Methods inherited from class org.snmp4j.transport.AbstractConnectionOrientedTransportMapping

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

    Methods inherited from class org.snmp4j.transport.AbstractTransportMapping

    addTransportAuditListener, addTransportListener, addTransportStateListener, fireConnectionStateChanged, fireProcessMessage, fireTransportAuditEvent, getAuditListenAddress, getListenWorkerTask, getMaxInboundMessageSize, getPriority, getSocketCleaner, getSuspendedAddresses, getThreadName, handleDroppedMessageToSend, isAsyncMsgProcessingSupported, isTransportAudit, removeAllTransportAuditListeners, removeAllTransportListeners, removeTransportAuditListener, removeTransportListener, removeTransportStateListener, resumeAddress, setAsyncMsgProcessingSupported, setPriority, setThreadName, suspendAddress

    Methods inherited from class 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)
      Constructs a UnixSocketStreamTransportMapping with the specified Unix domain socket address.
      Parameters:
      listenAddress - the Unix domain socket address to which this transport mapping is bound.

    • UnixSocketStreamTransportMapping

      public UnixSocketStreamTransportMapping()
      Constructs a UnixSocketStreamTransportMapping without specifying a Unix domain socket address. This constructor is useful when the address will be set later.

  • Method Details