EpollDomainSocketChannel (Netty 4.1.109.Final API文档

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

所有已实现的接口:

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

嵌套类概要
- 从类继承的嵌套类/接口 io.netty.channel.epoll.AbstractEpollStreamChannel
  AbstractEpollStreamChannel.SpliceInTask
- 从类继承的嵌套类/接口 io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- 从接口继承的嵌套类/接口 io.netty.channel.Channel
  Channel.Unsafe

字段概要

字段
限定符和类型字段和说明

protected boolean active

protected int flags

protected LinuxSocket socket

字段
限定符和类型	字段和说明
`protected boolean`	`active`
`protected int`	`flags`
`protected LinuxSocket`	`socket`

构造器概要

构造器
构造器和说明
`EpollDomainSocketChannel()`
`EpollDomainSocketChannel(Channel parent, LinuxSocket fd)`
`EpollDomainSocketChannel(int fd)`
`EpollDomainSocketChannel(int fd, boolean active)`

方法概要

All Methods Static Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`EpollDomainSocketChannelConfig`	`config()` Returns the configuration of this channel.
`protected void`	`doBeginRead()` Schedule a read operation.
`protected void`	`doBind(java.net.SocketAddress localAddress)` Bind the `Channel` to the `SocketAddress`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` Connect to the remote peer
`protected void`	`doDeregister()` Deregister the `Channel` from its `EventLoop`.
`protected void`	`doDisconnect()` Disconnect this `Channel` from its remote peer
`protected int`	`doReadBytes(ByteBuf byteBuf)` Read bytes into the given `ByteBuf` and return the amount.
`protected void`	`doRegister()` Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
`protected int`	`doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)`
`protected int`	`doWriteSingle(ChannelOutboundBuffer in)` Attempt to write a single object.
`FileDescriptor`	`fd()` Returns the `FileDescriptor` that is used by this `Channel`.
`protected java.lang.Object`	`filterOutboundMessage(java.lang.Object msg)` Invoked when a new message is added to a `ChannelOutboundBuffer` of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
`boolean`	`isActive()` Return `true` if the `Channel` is active and so connected.
`protected boolean`	`isCompatible(EventLoop loop)` Return `true` if the given `EventLoop` is compatible with this instance.
`boolean`	`isOpen()` Returns `true` if the `Channel` is open and may get active later
`DomainSocketAddress`	`localAddress()` Returns the local address where this channel is bound to.
`protected DomainSocketAddress`	`localAddress0()` Returns the `SocketAddress` which is bound locally.
`protected ByteBuf`	`newDirectBuffer(ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the original one.
`protected ByteBuf`	`newDirectBuffer(java.lang.Object holder, ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the specified holder.
`protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe`	`newUnsafe()` Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`PeerCredentials`	`peerCredentials()` Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
`DomainSocketAddress`	`remoteAddress()` Returns the remote address where this channel is connected to.
`protected DomainSocketAddress`	`remoteAddress0()` Return the `SocketAddress` which the `Channel` is connected to.
`protected void`	`setFlag(int flag)`

从类继承的方法 io.netty.channel.epoll.AbstractEpollStreamChannel
doClose, doShutdownOutput, doWrite, isInputShutdown, isOutputShutdown, isShutdown, metadata, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput, spliceTo, spliceTo, spliceTo, spliceTo

从类继承的方法 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

从类继承的方法 io.netty.util.DefaultAttributeMap
attr, hasAttr

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 io.netty.channel.unix.UnixChannel
fd

从接口继承的方法 io.netty.channel.socket.DuplexChannel
isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

从接口继承的方法 io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, metadata, parent, pipeline, read, unsafe

从接口继承的方法 io.netty.util.AttributeMap
attr, hasAttr

从接口继承的方法 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

从接口继承的方法 java.lang.Comparable
compareTo

- 字段详细资料
  - socket
```
protected final LinuxSocket socket
```
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- 构造器详细资料
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel()
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(int fd)
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(Channel parent,
                                LinuxSocket fd)
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(int fd,
                                boolean active)
```
- 方法详细资料
  - newUnsafe
```
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()
```
    从类复制的说明: AbstractChannel
    
    Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
    
    覆盖:
    
    newUnsafe 在类中 AbstractEpollStreamChannel
  - localAddress0
```
protected DomainSocketAddress localAddress0()
```
    从类复制的说明: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
  - remoteAddress0
```
protected DomainSocketAddress remoteAddress0()
```
    从类复制的说明: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    抛出:
    
    java.lang.Exception
  - config
```
public EpollDomainSocketChannelConfig config()
```
    从接口复制的说明: Channel
    
    Returns the configuration of this channel.
    
    指定者:
    
    config 在接口中 Channel
    
    指定者:
    
    config 在接口中 DomainSocketChannel
  - doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
    Connect to the remote peer
    
    抛出:
    
    java.lang.Exception
  - remoteAddress
```
public DomainSocketAddress remoteAddress()
```
    从接口复制的说明: Channel
    
    Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    指定者:
    
    remoteAddress 在接口中 Channel
    
    指定者:
    
    remoteAddress 在接口中 DomainSocketChannel
    
    覆盖:
    
    remoteAddress 在类中 AbstractChannel
    
    返回:
    
    the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.
  - localAddress
```
public DomainSocketAddress localAddress()
```
    从接口复制的说明: Channel
    
    Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    指定者:
    
    localAddress 在接口中 Channel
    
    指定者:
    
    localAddress 在接口中 DomainSocketChannel
    
    覆盖:
    
    localAddress 在类中 AbstractChannel
    
    返回:
    
    the local address of this channel. null if this channel is not bound.
  - doWriteSingle
```
protected int doWriteSingle(ChannelOutboundBuffer in)
                     throws java.lang.Exception
```
    从类复制的说明: AbstractEpollStreamChannel
    
    Attempt to write a single object.
    覆盖:
    
    doWriteSingle 在类中 AbstractEpollStreamChannel
    
    参数:
    
    in - the collection which contains objects to write.
    
    返回:
    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
    抛出:
    
    java.lang.Exception - If an I/O error occurs.
  - filterOutboundMessage
```
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
```
    从类复制的说明: AbstractChannel
    
    Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)
    
    覆盖:
    
    filterOutboundMessage 在类中 AbstractEpollStreamChannel
  - peerCredentials
```
@UnstableApi
public PeerCredentials peerCredentials()
                                              throws java.io.IOException
```
    Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
    
    抛出:
    
    java.io.IOException
  - setFlag
```
protected void setFlag(int flag)
                throws java.io.IOException
```
    抛出:
    
    java.io.IOException
  - fd
```
public final FileDescriptor fd()
```
    从接口复制的说明: UnixChannel
    
    Returns the FileDescriptor that is used by this Channel.
    
    指定者:
    
    fd 在接口中 UnixChannel
  - isActive
```
public boolean isActive()
```
    从接口复制的说明: Channel
    
    Return true if the Channel is active and so connected.
    
    指定者:
    
    isActive 在接口中 Channel
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    指定者:
    
    doDisconnect 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    从类复制的说明: AbstractChannel
    
    Return true if the given EventLoop is compatible with this instance.
    
    指定者:
    
    isCompatible 在类中 AbstractChannel
  - isOpen
```
public boolean isOpen()
```
    从接口复制的说明: Channel
    
    Returns true if the Channel is open and may get active later
    
    指定者:
    
    isOpen 在接口中 Channel
  - doDeregister
```
protected void doDeregister()
                     throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Deregister the Channel from its EventLoop. Sub-classes may override this method
    
    覆盖:
    
    doDeregister 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doBeginRead
```
protected final void doBeginRead()
                          throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Schedule a read operation.
    
    指定者:
    
    doBeginRead 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - doRegister
```
protected void doRegister()
                   throws java.lang.Exception
```
    从类复制的说明: AbstractChannel
    
    Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method
    
    覆盖:
    
    doRegister 在类中 AbstractChannel
    
    抛出:
    
    java.lang.Exception
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(ByteBuf buf)
```
    Returns an off-heap copy of the specified ByteBuf, and releases the original one.
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(java.lang.Object holder,
                                        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(java.net.InetSocketAddress addr)
```
  - doReadBytes
```
protected final int doReadBytes(ByteBuf byteBuf)
                         throws java.lang.Exception
```
    Read bytes into the given ByteBuf and return the amount.
    
    抛出:
    
    java.lang.Exception
  - doWriteBytes
```
protected final int doWriteBytes(ChannelOutboundBuffer in,
                                 ByteBuf buf)
                          throws java.lang.Exception
```
    抛出:
    
    java.lang.Exception

类 EpollDomainSocketChannel

嵌套类概要

从类继承的嵌套类/接口 io.netty.channel.epoll.AbstractEpollStreamChannel

从类继承的嵌套类/接口 io.netty.channel.AbstractChannel

从接口继承的嵌套类/接口 io.netty.channel.Channel

字段概要

构造器概要

方法概要

从类继承的方法 io.netty.channel.epoll.AbstractEpollStreamChannel

从类继承的方法 io.netty.channel.AbstractChannel

从类继承的方法 io.netty.util.DefaultAttributeMap

从类继承的方法 java.lang.Object

从接口继承的方法 io.netty.channel.unix.UnixChannel

从接口继承的方法 io.netty.channel.socket.DuplexChannel

从接口继承的方法 io.netty.channel.Channel

从接口继承的方法 io.netty.util.AttributeMap

从接口继承的方法 io.netty.channel.ChannelOutboundInvoker

从接口继承的方法 java.lang.Comparable

字段详细资料

socket

flags

active

构造器详细资料

EpollDomainSocketChannel

EpollDomainSocketChannel

EpollDomainSocketChannel

EpollDomainSocketChannel

方法详细资料

newUnsafe

localAddress0

remoteAddress0

doBind

config

doConnect

remoteAddress

localAddress

doWriteSingle

filterOutboundMessage

peerCredentials

setFlag

fd

isActive

doDisconnect

isCompatible

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes