EpollDomainSocketChannel (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.epoll.AbstractEpollStreamChannel
    - - io.netty.channel.epoll.EpollDomainSocketChannel

All Implemented Interfaces:

Channel ， ChannelOutboundInvoker ， DuplexChannel ， DomainSocketChannel ， UnixChannel ， AttributeMap ，java.lang.Comparable的< Channel >
```
public final class EpollDomainSocketChannel
extends AbstractEpollStreamChannel
implements DomainSocketChannel
```

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel
  AbstractEpollStreamChannel.SpliceInTask
- Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  Channel.Unsafe

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`active`
`protected int`	`flags`

构造方法摘要

构造方法
Constructor and Description
`EpollDomainSocketChannel()`
`EpollDomainSocketChannel(Channel parent, io.netty.channel.epoll.LinuxSocket fd)`
`EpollDomainSocketChannel(int fd)`
`EpollDomainSocketChannel(int fd, boolean active)`

方法摘要

所有方法静态方法接口方法具体的方法
Modifier and Type	Method and Description
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`EpollDomainSocketChannelConfig`	`config()` 返回此频道的配置。
`protected void`	`doBeginRead()` 安排读取操作。
`protected void`	`doBind(java.net.SocketAddress localAddress)` 将`Channel`绑定到`SocketAddress`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` 连接到远程对等
`protected void`	`doDeregister()` 注销`Channel`从`EventLoop` 。
`protected void`	`doDisconnect()` 将此`Channel`从其远程对等方断开
`protected int`	`doReadBytes(ByteBuf byteBuf)` 将字节读入给定的`ByteBuf`并返回金额。
`protected void`	`doRegister()` 在`Channel`作为注册过程的一部分注册到`EventLoop`之后调用。
`protected int`	`doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)`
`protected int`	`doWriteSingle(ChannelOutboundBuffer in)` 尝试编写单个对象。
`FileDescriptor`	`fd()` 返回`Channel`使用的`FileDescriptor` 。
`protected java.lang.Object`	`filterOutboundMessage(java.lang.Object msg)` 当新消息添加到此`AbstractChannel`的`ChannelOutboundBuffer`中时调用，以便`Channel`实现将消息转换为另一个消息。
`boolean`	`isActive()` 如果`Channel`处于活动状态并已连接，则返回`true` 。
`protected boolean`	`isCompatible(EventLoop loop)` 如果给定`EventLoop`与此实例兼容，则返回`true` 。
`boolean`	`isOpen()` 如果`Channel`已打开并且稍后可能会激活，则返回`true`
`DomainSocketAddress`	`localAddress()` 返回此通道绑定的本地地址。
`protected DomainSocketAddress`	`localAddress0()` 返回本地绑定的 `SocketAddress` 。
`protected ByteBuf`	`newDirectBuffer(ByteBuf buf)` 返回指定`ByteBuf`的堆外副本，并释放原始副本。
`protected ByteBuf`	`newDirectBuffer(java.lang.Object holder, ByteBuf buf)` 返回指定`ByteBuf`的堆外副本，并释放指定的持有者。
`protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe`	`newUnsafe()` 创建一个新的`AbstractChannel.AbstractUnsafe`实例，该实例将用于`Channel`的生命周期
`PeerCredentials`	`peerCredentials()` 返回对等 SO_PEERCRED的unix凭据（uid，gid，pid）
`DomainSocketAddress`	`remoteAddress()` 返回此通道连接到的远程地址。
`protected DomainSocketAddress`	`remoteAddress0()` 返回`SocketAddress`其中`Channel`被连接到。

Methods inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel
doClose, doShutdownOutput, doWrite, isInputShutdown, isOutputShutdown, isShutdown, metadata, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput, spliceTo, spliceTo, spliceTo, spliceTo

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, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, 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.channel.unix.UnixChannel
fd

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.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, metadata, parent, pipeline, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr

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

- 字段详细信息
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- 构造方法详细信息
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel()
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(int fd)
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(Channel parent,
                                io.netty.channel.epoll.LinuxSocket fd)
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(int fd,
                                boolean active)
```
- 方法详细信息
  - newUnsafe
```
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()
```
    从类复制的描述： AbstractChannel
    
    创建一个新的AbstractChannel.AbstractUnsafe实例，该实例将用于Channel的生命周期
    
    重写：
    
    newUnsafe在课堂 AbstractEpollStreamChannel
  - localAddress0
```
protected DomainSocketAddress localAddress0()
```
    从类复制的描述： AbstractChannel
    
    返回本地绑定的 SocketAddress 。
  - remoteAddress0
```
protected DomainSocketAddress remoteAddress0()
```
    从类复制的描述： AbstractChannel
    
    返回SocketAddress其中Channel被连接到。
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    将Channel绑定到SocketAddress
    
    异常
    
    java.lang.Exception
  - config
```
public EpollDomainSocketChannelConfig config()
```
    从接口Channel复制的描述
    
    返回此频道的配置。
    
    Specified by:
    
    config接口 Channel
    
    Specified by:
    
    config接口 DomainSocketChannel
  - doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
    连接到远程对等
    
    异常
    
    java.lang.Exception
  - remoteAddress
```
public DomainSocketAddress remoteAddress()
```
    从界面： Channel复制的描述
    
    返回此通道连接到的远程地址。返回的SocketAddress被假定为更具体的类型，如InetSocketAddress以检索详细信息。
    
    Specified by:
    
    remoteAddress接口 Channel
    
    Specified by:
    
    remoteAddress接口 DomainSocketChannel
    
    重写：
    
    remoteAddress在课堂 AbstractChannel
    
    结果
    
    该频道的远程地址。 null如果此通道未连接。如果此通道未连接，但它可以接收来自任意远程地址的消息（例如DatagramChannel ，请使用DefaultAddressedEnvelope.recipient()来确定收到消息的来源，因为此方法将返回null 。
  - localAddress
```
public DomainSocketAddress localAddress()
```
    从界面： Channel复制的描述
    
    返回此通道绑定的本地地址。返回的SocketAddress应该被下调为更具体的类型，例如InetSocketAddress以检索详细信息。
    
    Specified by:
    
    localAddress接口 Channel
    
    Specified by:
    
    localAddress接口 DomainSocketChannel
    
    重写：
    
    localAddress在课堂 AbstractChannel
    
    结果
    
    这个频道的本地地址。 null如果此通道未绑定。
  - doWriteSingle
```
protected int doWriteSingle(ChannelOutboundBuffer in)
                     throws java.lang.Exception
```
    从类复制的描述： AbstractEpollStreamChannel
    
    尝试编写单个对象。
    重写：
    
    doWriteSingle在课堂 AbstractEpollStreamChannel
    
    参数
    
    in - 包含要写入对象的集合。
    
    结果
    应该从写入量程开始减少的值，其值为ChannelConfig.getWriteSpinCount() 。典型的用例如下：
    
    0 - 如果没有尝试写入。如果遇到空的ByteBuf （或其他空的内容），这是合适的
    
    1 - 如果向OS写入数据的单个调用
    
    ChannelUtils.WRITE_STATUS_SNDBUF_FULL - 如果尝试向操作系统写入数据，但未接受任何数据
    异常
    
    java.lang.Exception - 如果发生I / O错误。
  - filterOutboundMessage
```
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
```
    从类复制的描述： AbstractChannel
    
    在将新消息添加到此AbstractChannel的ChannelOutboundBuffer时调用，以便Channel实现将消息转换为另一个消息。（例如堆缓冲区 - >直接缓冲区）
    
    重写：
    
    filterOutboundMessage在课堂 AbstractEpollStreamChannel
  - peerCredentials
```
@UnstableApi
public PeerCredentials peerCredentials()
                                             throws java.io.IOException
```
    返回对等 SO_PEERCRED的unix凭据（uid，gid，pid）
    
    异常
    
    java.io.IOException
  - fd
```
public final FileDescriptor fd()
```
    从界面复制的描述： UnixChannel
    
    返回Channel使用的FileDescriptor 。
    
    Specified by:
    
    fd在界面 UnixChannel
  - isActive
```
public boolean isActive()
```
    从界面： Channel复制的描述
    
    如果Channel处于活动状态并已连接，则返回true 。
    
    Specified by:
    
    isActive接口 Channel
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    将此Channel从其远程对等方断开
    
    Specified by:
    
    doDisconnect在班级 AbstractChannel
    
    异常
    
    java.lang.Exception
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    从类复制的描述： AbstractChannel
    
    如果给定的EventLoop与此实例兼容，则返回true 。
    
    Specified by:
    
    isCompatible在课堂上 AbstractChannel
  - isOpen
```
public boolean isOpen()
```
    从界面： Channel复制的描述
    
    如果Channel已打开并且稍后可能会激活，则返回true
    
    Specified by:
    
    isOpen接口 Channel
  - doDeregister
```
protected void doDeregister()
                     throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    注销Channel从EventLoop 。子类可能会覆盖此方法
    
    重写：
    
    doDeregister在课堂 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doBeginRead
```
protected final void doBeginRead()
                          throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    安排读取操作。
    
    Specified by:
    
    doBeginRead在课堂 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doRegister
```
protected void doRegister()
                   throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    在Channel作为注册过程的一部分注册到EventLoop之后调用。子类可能会覆盖此方法
    
    重写：
    
    doRegister在课堂 AbstractChannel
    
    异常
    
    java.lang.Exception
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(ByteBuf buf)
```
    返回指定ByteBuf的堆外副本，并释放原始副本。
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(java.lang.Object holder,
                                        ByteBuf buf)
```
    返回指定ByteBuf的堆外副本，并释放指定的持有者。呼叫者必须确保持有人通过此方法释放持有人时释放原始ByteBuf 。
  - checkResolvable
```
protected static void checkResolvable(java.net.InetSocketAddress addr)
```
  - doReadBytes
```
protected final int doReadBytes(ByteBuf byteBuf)
                         throws java.lang.Exception
```
    将字节读入给定的ByteBuf并返回金额。
    
    异常
    
    java.lang.Exception
  - doWriteBytes
```
protected final int doWriteBytes(ChannelOutboundBuffer in,
                                 ByteBuf buf)
                          throws java.lang.Exception
```
    异常
    
    java.lang.Exception

Class EpollDomainSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel

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

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

Field Summary

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

Methods inherited from interface java.lang.Comparable

字段详细信息

flags

active

构造方法详细信息

EpollDomainSocketChannel

EpollDomainSocketChannel

EpollDomainSocketChannel

EpollDomainSocketChannel

方法详细信息

newUnsafe

localAddress0

remoteAddress0

doBind

config

doConnect

remoteAddress

localAddress

doWriteSingle

filterOutboundMessage

peerCredentials

fd

isActive

doDisconnect

isCompatible

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes