EpollDomainSocketChannel (Netty API Reference (4.1.130.Final))

JavaScript is disabled on your browser.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

io.netty.channel.epoll

Class EpollDomainSocketChannel

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, 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

protected LinuxSocket socket

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

Constructor Summary

Constructors
Constructor and Description
`EpollDomainSocketChannel ()`
`EpollDomainSocketChannel (Channel parent, LinuxSocket fd)`
`EpollDomainSocketChannel (int fd)`
`EpollDomainSocketChannel (int fd, boolean active)`

Method Summary

All Methods
Modifier and Type	Method and Description
`protected static void`	`checkResolvable (InetSocketAddress addr)`
`EpollDomainSocketChannelConfig`	`config ()` Returns the configuration of this channel.
`protected void`	`doBeginRead ()` Schedule a read operation.
`protected void`	`doBind (SocketAddress localAddress)` Bind the `Channel` to the `SocketAddress`
`protected boolean`	`doConnect (SocketAddress remoteAddress, 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 Object`	`filterOutboundMessage (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 (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)`

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, 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.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

- Field Detail
  - socket
```
protected final LinuxSocket socket
```
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- Constructor Detail
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel()
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(int fd)
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(Channel parent,
 LinuxSocket fd)
```
  - EpollDomainSocketChannel
```
public EpollDomainSocketChannel(int fd,
 boolean active)
```
- Method Detail
  - newUnsafe
```
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()
```
    Description copied from class: AbstractChannel
    
    Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
    
    Overrides:
    
    newUnsafe in class AbstractEpollStreamChannel
  - localAddress0
```
protected DomainSocketAddress localAddress0()
```
    Description copied from class: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
  - remoteAddress0
```
protected DomainSocketAddress remoteAddress0()
```
    Description copied from class: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
  - doBind
```
protected void doBind(SocketAddress localAddress)
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    Throws:
    
    Exception
  - config
```
public EpollDomainSocketChannelConfig config()
```
    Description copied from interface: Channel
    
    Returns the configuration of this channel.
    
    Specified by:
    
    config in interface Channel
    
    Specified by:
    
    config in interface DomainSocketChannel
  - doConnect
```
protected boolean doConnect(SocketAddress remoteAddress,
 SocketAddress localAddress)
 throws Exception 
```
    Connect to the remote peer
    
    Throws:
    
    Exception
  - remoteAddress
```
public DomainSocketAddress remoteAddress()
```
    Description copied from interface: 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.
    
    Specified by:
    
    remoteAddress in interface Channel
    
    Specified by:
    
    remoteAddress in interface DomainSocketChannel
    
    Overrides:
    
    remoteAddress in class AbstractChannel
    
    Returns:
    
    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()
```
    Description copied from interface: 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.
    
    Specified by:
    
    localAddress in interface Channel
    
    Specified by:
    
    localAddress in interface DomainSocketChannel
    
    Overrides:
    
    localAddress in class AbstractChannel
    
    Returns:
    
    the local address of this channel. null if this channel is not bound.
  - doWriteSingle
```
protected int doWriteSingle(ChannelOutboundBuffer in)
 throws Exception 
```
    Description copied from class: AbstractEpollStreamChannel
    
    Attempt to write a single object.
    Overrides:
    
    doWriteSingle in class AbstractEpollStreamChannel
    
    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)
```
    Description copied from class: 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)
    
    Overrides:
    
    filterOutboundMessage in class AbstractEpollStreamChannel
  - peerCredentials
```
public PeerCredentials peerCredentials()
 throws IOException 
```
    Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
    
    Throws:
    
    IOException
  - setFlag
```
protected void setFlag(int flag)
 throws IOException 
```
    Throws:
    
    IOException
  - fd
```
public final FileDescriptor fd()
```
    Description copied from interface: UnixChannel
    
    Returns the FileDescriptor that is used by this Channel.
    
    Specified by:
    
    fd in interface UnixChannel
  - isActive
```
public boolean isActive()
```
    Description copied from interface: Channel
    
    Return true if the Channel is active and so connected.
    
    Specified by:
    
    isActive in interface Channel
  - doDisconnect
```
protected void doDisconnect()
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    Specified by:
    
    doDisconnect in class AbstractChannel
    
    Throws:
    
    Exception
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    Description copied from class: AbstractChannel
    
    Return true if the given EventLoop is compatible with this instance.
    
    Specified by:
    
    isCompatible in class AbstractChannel
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: Channel
    
    Returns true if the Channel is open and may get active later
    
    Specified by:
    
    isOpen in interface Channel
  - doDeregister
```
protected void doDeregister()
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Deregister the Channel from its EventLoop. Sub-classes may override this method
    
    Overrides:
    
    doDeregister in class AbstractChannel
    
    Throws:
    
    Exception
  - doBeginRead
```
protected final void doBeginRead()
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Schedule a read operation.
    
    Specified by:
    
    doBeginRead in class AbstractChannel
    
    Throws:
    
    Exception
  - doRegister
```
protected void doRegister()
 throws Exception 
```
    Description copied from class: AbstractChannel
    
    Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method
    
    Overrides:
    
    doRegister in class AbstractChannel
    
    Throws:
    
    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(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(InetSocketAddress addr)
```
  - doReadBytes
```
protected final int doReadBytes(ByteBuf byteBuf)
 throws Exception 
```
    Read bytes into the given ByteBuf and return the amount.
    
    Throws:
    
    Exception
  - doWriteBytes
```
protected final int doWriteBytes(ChannelOutboundBuffer in,
 ByteBuf buf)
 throws Exception 
```
    Throws:
    
    Exception

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

Constructor Summary

Method 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

Field Detail

socket

flags

active

Constructor Detail

EpollDomainSocketChannel

EpollDomainSocketChannel

EpollDomainSocketChannel

EpollDomainSocketChannel

Method Detail

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