Netty/Transport/Classes/KQueue 4.1.107.Final · io.netty.channel.kqueue.KQueueDomainSocketChannel

Modifier and Type	Class and Description
private class	KQueueDomainSocketChannel.KQueueDomainUnsafe

Modifier and Type	Field and Description
private final KQueueDomainSocketChannelConfig	config
private volatile DomainSocketAddress	local Hides io.netty.channel.kqueue.AbstractKQueueChannel.local.
private volatile DomainSocketAddress	remote Hides io.netty.channel.kqueue.AbstractKQueueChannel.remote.

Constructor Summary

Access	Constructor and Description
public	KQueueDomainSocketChannel()
public	KQueueDomainSocketChannel(int fd)
pack-priv	KQueueDomainSocketChannel(Channel parent, BsdSocket fd)

Method Summary

Modifier and Type	Method and Description
public KQueueDomainSocketChannelConfig	config() Implements abstract io.netty.channel.kqueue.AbstractKQueueChannel.config. Implements io.netty.channel.unix.DomainSocketChannel.config, io.netty.channel.Channel.config. Returns the configuration of this channel.
protected void	doBind(SocketAddress localAddress) Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doBind. Bind the `Channel` to the `SocketAddress`
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doConnect. Connect to the remote peer
protected int	doWriteSingle(ChannelOutboundBuffer the collection which contains objects to write. in) Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.doWriteSingle. Attempt to write a single object.
protected Object	filterOutboundMessage(Object msg) Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.filterOutboundMessage. Invoked when a new message is added to a `ChannelOutboundBuffer` of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
public DomainSocketAddress	localAddress() Overrides io.netty.channel.AbstractChannel.localAddress. Implements io.netty.channel.unix.DomainSocketChannel.localAddress, io.netty.channel.Channel.localAddress. Returns the local address where this channel is bound to.
protected DomainSocketAddress	localAddress0() Overrides io.netty.channel.kqueue.AbstractKQueueChannel.localAddress0. Returns the `SocketAddress` which is bound locally.
protected AbstractKQueueChannel.AbstractKQueueUnsafe	newUnsafe() Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.newUnsafe. Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel`
public PeerCredentials	peerCredentials() Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
public DomainSocketAddress	remoteAddress() Overrides io.netty.channel.AbstractChannel.remoteAddress. Implements io.netty.channel.unix.DomainSocketChannel.remoteAddress, io.netty.channel.Channel.remoteAddress. Returns the remote address where this channel is connected to.
protected DomainSocketAddress	remoteAddress0() Overrides io.netty.channel.kqueue.AbstractKQueueChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to.

Inherited from io.netty.channel.kqueue.AbstractKQueueStreamChannel:: doShutdownOutput doWrite isInputShutdown isOutputShutdown isShutdown metadata shutdown shutdown shutdownInput shutdownInput shutdownOutput shutdownOutput

config	back to summary
private final KQueueDomainSocketChannelConfig config

local	back to summary
private volatile DomainSocketAddress local Hides io.netty.channel.kqueue.AbstractKQueueChannel.local.

remote	back to summary
private volatile DomainSocketAddress remote Hides io.netty.channel.kqueue.AbstractKQueueChannel.remote.

Constructor Detail

KQueueDomainSocketChannel	back to summary
public KQueueDomainSocketChannel()

KQueueDomainSocketChannel	back to summary
public KQueueDomainSocketChannel(int fd)

KQueueDomainSocketChannel	back to summary
pack-priv KQueueDomainSocketChannel(Channel parent, BsdSocket fd)

Method Detail

config	back to summary
public KQueueDomainSocketChannelConfig config() Implements abstract io.netty.channel.kqueue.AbstractKQueueChannel.config. Implements io.netty.channel.unix.DomainSocketChannel.config, io.netty.channel.Channel.config. Doc from io.netty.channel.Channel.config. Returns the configuration of this channel. Annotations @Override

config

back to summary

public KQueueDomainSocketChannelConfig config()

Implements abstract io.netty.channel.kqueue.AbstractKQueueChannel.config.

Implements io.netty.channel.unix.DomainSocketChannel.config, io.netty.channel.Channel.config.

Doc from io.netty.channel.Channel.config.

Returns the configuration of this channel.

Annotations

@Override

doBind back to summary

doBind	back to summary
protected void doBind(SocketAddress localAddress) throws Exception Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doBind. Doc from io.netty.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress` Annotations @Override

protected void doBind(SocketAddress localAddress) throws Exception

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doBind.

Doc from io.netty.channel.AbstractChannel.doBind.

Bind the Channel to the SocketAddress

Annotations

@Override

doConnect	back to summary
protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doConnect. Doc from io.netty.channel.kqueue.AbstractKQueueChannel.doConnect. Connect to the remote peer Annotations @Override

doConnect

back to summary

protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doConnect.

Doc from io.netty.channel.kqueue.AbstractKQueueChannel.doConnect.

Connect to the remote peer

Annotations

@Override

doWriteSingle back to summary

doWriteSingle	back to summary
protected int doWriteSingle(ChannelOutboundBuffer in) throws Exception Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.doWriteSingle. Doc from io.netty.channel.kqueue.AbstractKQueueStreamChannel.doWriteSingle. Attempt to write a single object. Parameters in:ChannelOutboundBuffer the collection which contains objects to write. Returns:int 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 Annotations @Override Exceptions Exception: If an I/O error occurs.

protected int doWriteSingle(ChannelOutboundBuffer in) throws Exception

Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.doWriteSingle.

Doc from io.netty.channel.kqueue.AbstractKQueueStreamChannel.doWriteSingle.

Attempt to write a single object.

Parameters

in:ChannelOutboundBuffer: the collection which contains objects to write.

Returns:int

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

Annotations

@Override

Exceptions

Exception:: If an I/O error occurs.

filterOutboundMessage back to summary

filterOutboundMessage	back to summary
protected Object filterOutboundMessage(Object msg) Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.filterOutboundMessage. Doc from io.netty.channel.AbstractChannel.filterOutboundMessage. 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) Annotations @Override

protected Object filterOutboundMessage(Object msg)

Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.filterOutboundMessage.

Doc from io.netty.channel.AbstractChannel.filterOutboundMessage.

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)

Annotations

@Override

localAddress back to summary

localAddress	back to summary
public DomainSocketAddress localAddress() Overrides io.netty.channel.AbstractChannel.localAddress. Implements io.netty.channel.unix.DomainSocketChannel.localAddress, io.netty.channel.Channel.localAddress. Doc from io.netty.channel.Channel.localAddress. 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. Returns:DomainSocketAddress the local address of this channel. `null` if this channel is not bound. Annotations @Override

public DomainSocketAddress localAddress()

Overrides io.netty.channel.AbstractChannel.localAddress.

Implements io.netty.channel.unix.DomainSocketChannel.localAddress, io.netty.channel.Channel.localAddress.

Doc from io.netty.channel.Channel.localAddress.

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.

Returns:DomainSocketAddress

the local address of this channel. null if this channel is not bound.

Annotations

@Override

localAddress0 back to summary

localAddress0	back to summary
protected DomainSocketAddress localAddress0() Overrides io.netty.channel.kqueue.AbstractKQueueChannel.localAddress0. Doc from io.netty.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally. Annotations @Override

protected DomainSocketAddress localAddress0()

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.localAddress0.

Doc from io.netty.channel.AbstractChannel.localAddress0.

Returns the SocketAddress which is bound locally.

Annotations

@Override

newUnsafe back to summary

newUnsafe	back to summary
protected AbstractKQueueChannel.AbstractKQueueUnsafe newUnsafe() Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.newUnsafe. Doc from io.netty.channel.AbstractChannel.newUnsafe. Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel` Annotations @Override

protected AbstractKQueueChannel.AbstractKQueueUnsafe newUnsafe()

Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.newUnsafe.

Doc from io.netty.channel.AbstractChannel.newUnsafe.

Create a new AbstractUnsafe instance which will be used for the life-time of the Channel

Annotations

@Override

peerCredentials	back to summary
public PeerCredentials peerCredentials() throws IOException Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED Annotations @UnstableApi

peerCredentials

back to summary

public PeerCredentials peerCredentials() throws IOException

Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED

Annotations

@UnstableApi

remoteAddress back to summary

remoteAddress	back to summary
public DomainSocketAddress remoteAddress() Overrides io.netty.channel.AbstractChannel.remoteAddress. Implements io.netty.channel.unix.DomainSocketChannel.remoteAddress, io.netty.channel.Channel.remoteAddress. Doc from io.netty.channel.Channel.remoteAddress. 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. Returns:DomainSocketAddress 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 `DatagramPacket#recipient()` to determine the origination of the received message as this method will return `null`. Annotations @Override

public DomainSocketAddress remoteAddress()

Overrides io.netty.channel.AbstractChannel.remoteAddress.

Implements io.netty.channel.unix.DomainSocketChannel.remoteAddress, io.netty.channel.Channel.remoteAddress.

Doc from io.netty.channel.Channel.remoteAddress.

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.

Returns:DomainSocketAddress

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 DatagramPacket#recipient() to determine the origination of the received message as this method will return null.

Annotations

@Override

remoteAddress0 back to summary

remoteAddress0	back to summary
protected DomainSocketAddress remoteAddress0() Overrides io.netty.channel.kqueue.AbstractKQueueChannel.remoteAddress0. Doc from io.netty.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to. Annotations @Override

protected DomainSocketAddress remoteAddress0()

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.remoteAddress0.

Doc from io.netty.channel.AbstractChannel.remoteAddress0.

Return the SocketAddress which the Channel is connected to.

Annotations

@Override

Access	Constructor and Description
private	KQueueDomainUnsafe()

Method Summary

Modifier and Type	Method and Description
pack-priv void	readReady(KQueueRecvByteAllocatorHandle allocHandle) Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.KQueueStreamUnsafe.readReady. Deprecated as a consequence of `KQueueRecvByteAllocatorHandle` being deprecated.
private void	readReadyFd()

Inherited from io.netty.channel.kqueue.AbstractKQueueStreamChannel.KQueueStreamUnsafe:: prepareToClose

Constructor Detail

KQueueDomainUnsafe	back to summary
private KQueueDomainUnsafe()

Method Detail

readReady back to summary

readReady	back to summary
pack-priv void readReady(KQueueRecvByteAllocatorHandle allocHandle) Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.KQueueStreamUnsafe.readReady. Deprecated as a consequence of `KQueueRecvByteAllocatorHandle` being deprecated. See corresponding docs for further information. Annotations @Override

pack-priv void readReady(KQueueRecvByteAllocatorHandle allocHandle)

Overrides io.netty.channel.kqueue.AbstractKQueueStreamChannel.KQueueStreamUnsafe.readReady.

Deprecated

as a consequence of KQueueRecvByteAllocatorHandle being deprecated. See corresponding docs for further information.

Annotations

@Override

readReadyFd	back to summary
private void readReadyFd()

public final Class KQueueDomainSocketChannel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class KQueueDomainSocketChannel.KQueueDomainUnsafe

Constructor Summary

Method Summary

Constructor Detail

Method Detail