Package io.netty.channel.kqueue

Class KQueueDomainSocketChannel

java.lang.Object
io.netty.util.DefaultAttributeMap
io.netty.channel.AbstractChannel
io.netty.channel.kqueue.AbstractKQueueStreamChannel
io.netty.channel.kqueue.KQueueDomainSocketChannel
All Implemented Interfaces:
io.netty.channel.Channel, io.netty.channel.ChannelOutboundInvoker, io.netty.channel.socket.DuplexChannel, io.netty.channel.unix.DomainSocketChannel, io.netty.channel.unix.UnixChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>
@UnstableApi public final class KQueueDomainSocketChannel extends AbstractKQueueStreamChannel implements io.netty.channel.unix.DomainSocketChannel

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

    io.netty.channel.AbstractChannel.AbstractUnsafe

    Nested classes/interfaces inherited from interface io.netty.channel.Channel

    io.netty.channel.Channel.Unsafe

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    active
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    KQueueDomainSocketChannel()
     
    KQueueDomainSocketChannel(int fd)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected static void
    checkResolvable(InetSocketAddress addr)
     
    KQueueDomainSocketChannelConfig
    config()
     
    protected final void
    doBeginRead()
     
    protected void
    doBind(SocketAddress localAddress)
     
    protected void
    doClose()
     
    protected boolean
    doConnect(SocketAddress remoteAddress, SocketAddress localAddress)
    Connect to the remote peer
    protected boolean
    doConnect0(SocketAddress remoteAddress, SocketAddress localAddress)
     
    protected void
    doDeregister()
     
    protected void
    doDisconnect()
     
    protected final int
    doReadBytes(io.netty.buffer.ByteBuf byteBuf)
    Read bytes into the given ByteBuf and return the amount.
    protected void
    doRegister()
     
    protected final int
    doWriteBytes(io.netty.channel.ChannelOutboundBuffer in, io.netty.buffer.ByteBuf buf)
     
    protected int
    doWriteSingle(io.netty.channel.ChannelOutboundBuffer in)
    Attempt to write a single object.
    final io.netty.channel.unix.FileDescriptor
    fd()
     
    protected Object
    filterOutboundMessage(Object msg)
     
    boolean
    isActive()
     
    protected boolean
    isCompatible(io.netty.channel.EventLoop loop)
     
    boolean
    isOpen()
     
    io.netty.channel.unix.DomainSocketAddress
    localAddress()
     
    protected io.netty.channel.unix.DomainSocketAddress
    localAddress0()
     
    protected final io.netty.buffer.ByteBuf
    newDirectBuffer(io.netty.buffer.ByteBuf buf)
    Returns an off-heap copy of the specified ByteBuf, and releases the original one.
    protected final io.netty.buffer.ByteBuf
    newDirectBuffer(Object holder, io.netty.buffer.ByteBuf buf)
    Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
    protected io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe
    newUnsafe()
     
    io.netty.channel.unix.PeerCredentials
    peerCredentials()
    Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
    io.netty.channel.unix.DomainSocketAddress
    remoteAddress()
     
    protected io.netty.channel.unix.DomainSocketAddress
    remoteAddress0()
     

    Methods inherited from class io.netty.channel.kqueue.AbstractKQueueStreamChannel

    doShutdownOutput, doWrite, isInputShutdown, isOutputShutdown, isShutdown, metadata, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

    Methods inherited from class io.netty.channel.AbstractChannel

    alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

    Methods inherited from class io.netty.util.DefaultAttributeMap

    attr, hasAttr

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface io.netty.util.AttributeMap

    attr, hasAttr

    Methods inherited from interface io.netty.channel.Channel

    alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, metadata, parent, pipeline, read, unsafe

    Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

    bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface io.netty.channel.socket.DuplexChannel

    isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

    Methods inherited from interface io.netty.channel.unix.UnixChannel

    fd

  • Field Details

    • active

      protected volatile boolean active

  • Constructor Details

    • KQueueDomainSocketChannel

      public KQueueDomainSocketChannel()

    • KQueueDomainSocketChannel

      public KQueueDomainSocketChannel(int fd)

  • Method Details

    • newUnsafe

      protected io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe newUnsafe()
      Overrides:
      newUnsafe in class AbstractKQueueStreamChannel

    • localAddress0

      protected io.netty.channel.unix.DomainSocketAddress localAddress0()

    • remoteAddress0

      protected io.netty.channel.unix.DomainSocketAddress remoteAddress0()

    • doBind

      protected void doBind(SocketAddress localAddress) throws Exception
      Throws:
      Exception

    • config

      public KQueueDomainSocketChannelConfig config()
      Specified by:
      config in interface io.netty.channel.Channel
      Specified by:
      config in interface io.netty.channel.unix.DomainSocketChannel

    • doConnect

      protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception
      Connect to the remote peer
      Throws:
      Exception

    • remoteAddress

      public io.netty.channel.unix.DomainSocketAddress remoteAddress()
      Specified by:
      remoteAddress in interface io.netty.channel.Channel
      Specified by:
      remoteAddress in interface io.netty.channel.unix.DomainSocketChannel
      Overrides:
      remoteAddress in class io.netty.channel.AbstractChannel

    • localAddress

      public io.netty.channel.unix.DomainSocketAddress localAddress()
      Specified by:
      localAddress in interface io.netty.channel.Channel
      Specified by:
      localAddress in interface io.netty.channel.unix.DomainSocketChannel
      Overrides:
      localAddress in class io.netty.channel.AbstractChannel

    • doWriteSingle

      protected int doWriteSingle(io.netty.channel.ChannelOutboundBuffer in) throws Exception
      Description copied from class: AbstractKQueueStreamChannel
      Attempt to write a single object.
      Overrides:
      doWriteSingle in class AbstractKQueueStreamChannel
      Parameters:
      in - the collection which contains objects to write.
      Returns:
      The value that should be decremented from the write quantum which starts at ChannelConfig.getWriteSpinCount(). The typical use cases are as follows:
      • 0 - if no write was attempted. This is appropriate if an empty ByteBuf (or other empty content) is encountered
      • 1 - if a single call to write data was made to the OS
      • ChannelUtils.WRITE_STATUS_SNDBUF_FULL - if an attempt to write data was made to the OS, but no data was accepted
      Throws:
      Exception - If an I/O error occurs.

    • filterOutboundMessage

      protected Object filterOutboundMessage(Object msg)
      Overrides:
      filterOutboundMessage in class AbstractKQueueStreamChannel

    • peerCredentials

      @UnstableApi public io.netty.channel.unix.PeerCredentials peerCredentials() throws IOException
      Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
      Throws:
      IOException

    • fd

      public final io.netty.channel.unix.FileDescriptor fd()
      Specified by:
      fd in interface io.netty.channel.unix.UnixChannel

    • isActive

      public boolean isActive()
      Specified by:
      isActive in interface io.netty.channel.Channel

    • doClose

      protected void doClose() throws Exception
      Specified by:
      doClose in class io.netty.channel.AbstractChannel
      Throws:
      Exception

    • doDisconnect

      protected void doDisconnect() throws Exception
      Specified by:
      doDisconnect in class io.netty.channel.AbstractChannel
      Throws:
      Exception

    • isCompatible

      protected boolean isCompatible(io.netty.channel.EventLoop loop)
      Specified by:
      isCompatible in class io.netty.channel.AbstractChannel

    • isOpen

      public boolean isOpen()
      Specified by:
      isOpen in interface io.netty.channel.Channel

    • doDeregister

      protected void doDeregister() throws Exception
      Overrides:
      doDeregister in class io.netty.channel.AbstractChannel
      Throws:
      Exception

    • doBeginRead

      protected final void doBeginRead() throws Exception
      Specified by:
      doBeginRead in class io.netty.channel.AbstractChannel
      Throws:
      Exception

    • doRegister

      protected void doRegister() throws Exception
      Overrides:
      doRegister in class io.netty.channel.AbstractChannel
      Throws:
      Exception

    • newDirectBuffer

      protected final io.netty.buffer.ByteBuf newDirectBuffer(io.netty.buffer.ByteBuf buf)
      Returns an off-heap copy of the specified ByteBuf, and releases the original one.

    • newDirectBuffer

      protected final io.netty.buffer.ByteBuf newDirectBuffer(Object holder, io.netty.buffer.ByteBuf buf)
      Returns an off-heap copy of the specified ByteBuf, and releases the specified holder. The caller must ensure that the holder releases the original ByteBuf when the holder is released by this method.

    • checkResolvable

      protected static void checkResolvable(InetSocketAddress addr)

    • doReadBytes

      protected final int doReadBytes(io.netty.buffer.ByteBuf byteBuf) throws Exception
      Read bytes into the given ByteBuf and return the amount.
      Throws:
      Exception

    • doWriteBytes

      protected final int doWriteBytes(io.netty.channel.ChannelOutboundBuffer in, io.netty.buffer.ByteBuf buf) throws Exception
      Throws:
      Exception

    • doConnect0

      protected boolean doConnect0(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception
      Throws:
      Exception