jnr-unixsocket 0.38.22 · jnr.unixsocket.impl.AbstractNativeSocketChannel

Modifier and Type	Field and Description
private final Common	common
private static final int	SHUT_RD
private static final int	SHUT_WR

Access	Constructor and Description
public	AbstractNativeSocketChannel(int fd)
pack-priv	AbstractNativeSocketChannel(SelectorProvider provider, int fd)

Method Summary

Modifier and Type	Method and Description
public final int	getFD() Implements jnr.enxio.channels.NativeSelectableChannel.getFD.
protected void	implCloseSelectableChannel() Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel. Closes this selectable channel.
protected void	implConfigureBlocking(boolean If `true` then this channel will be placed in blocking mode; if `false` then it will be placed non-blocking mode block) Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking. Adjusts this channel's blocking mode.
public int	read(ByteBuffer The buffer into which bytes are to be transferred dst) Implements abstract java.nio.channels.SocketChannel.read. Implements java.nio.channels.ReadableByteChannel.read. Reads a sequence of bytes from this channel into the given buffer.
public long	read(ByteBuffer[] The buffers into which bytes are to be transferred dsts, int The offset within the buffer array of the first buffer into which bytes are to be transferred; must be non-negative and no larger than `dsts.length` offset, int The maximum number of buffers to be accessed; must be non-negative and no larger than `dsts.length` - `offset` length) Implements abstract java.nio.channels.SocketChannel.read. Implements java.nio.channels.ScatteringByteChannel.read. Reads a sequence of bytes from this channel into a subsequence of the given buffers.
public void	setFD(int fd)
public SocketChannel	shutdownInput() Implements abstract java.nio.channels.SocketChannel.shutdownInput. Shutdown the connection for reading without closing the channel.
public SocketChannel	shutdownOutput() Implements abstract java.nio.channels.SocketChannel.shutdownOutput. Shutdown the connection for writing without closing the channel.
public int	write(ByteBuffer The buffer from which bytes are to be retrieved src) Implements abstract java.nio.channels.SocketChannel.write. Implements java.nio.channels.WritableByteChannel.write. Writes a sequence of bytes to this channel from the given buffer.
public long	write(ByteBuffer[] The buffers from which bytes are to be retrieved srcs, int The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than `srcs.length` offset, int The maximum number of buffers to be accessed; must be non-negative and no larger than `srcs.length` - `offset` length) Implements abstract java.nio.channels.SocketChannel.write. Implements java.nio.channels.GatheringByteChannel.write. Writes a sequence of bytes to this channel from a subsequence of the given buffers.

Inherited from java.nio.channels.SocketChannel:: bind connect finishConnect getLocalAddress getRemoteAddress isConnected isConnectionPending open open open read setOption socket validOps write

common	back to summary
private final Common common

SHUT_RD	back to summary
private static final int SHUT_RD

SHUT_WR	back to summary
private static final int SHUT_WR

AbstractNativeSocketChannel	back to summary
public AbstractNativeSocketChannel(int fd)

AbstractNativeSocketChannel	back to summary
pack-priv AbstractNativeSocketChannel(SelectorProvider provider, int fd)

Method Detail

getFD	back to summary
public final int getFD() Implements jnr.enxio.channels.NativeSelectableChannel.getFD.

implCloseSelectableChannel back to summary

implCloseSelectableChannel	back to summary
protected void implCloseSelectableChannel() throws IOException Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel. Doc from java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel. Closes this selectable channel. This method is invoked by the `close` method in order to perform the actual work of closing the channel. This method is only invoked if the channel has not yet been closed, and it is never invoked more than once. An implementation of this method must arrange for any other thread that is blocked in an I/O operation upon this channel to return immediately, either by throwing an exception or by returning normally. Annotations @Override Exceptions IOException: If an I/O error occurs

protected void implCloseSelectableChannel() throws IOException

Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel.

Doc from java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel.

Closes this selectable channel.

This method is invoked by the close method in order to perform the actual work of closing the channel. This method is only invoked if the channel has not yet been closed, and it is never invoked more than once.

An implementation of this method must arrange for any other thread that is blocked in an I/O operation upon this channel to return immediately, either by throwing an exception or by returning normally.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

implConfigureBlocking back to summary

implConfigureBlocking	back to summary
protected void implConfigureBlocking(boolean block) throws IOException Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking. Doc from java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking. Adjusts this channel's blocking mode. This method is invoked by the `configureBlocking` method in order to perform the actual work of changing the blocking mode. This method is only invoked if the new mode is different from the current mode. Parameters block:boolean If `true` then this channel will be placed in blocking mode; if `false` then it will be placed non-blocking mode Annotations @Override Exceptions IOException: If an I/O error occurs

protected void implConfigureBlocking(boolean block) throws IOException

Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking.

Doc from java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking.

Adjusts this channel's blocking mode.

This method is invoked by the configureBlocking method in order to perform the actual work of changing the blocking mode. This method is only invoked if the new mode is different from the current mode.

Parameters

block:boolean: If true then this channel will be placed in blocking mode; if false then it will be placed non-blocking mode

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(ByteBuffer dst) throws IOException Implements abstract java.nio.channels.SocketChannel.read. Implements java.nio.channels.ReadableByteChannel.read. Doc from java.nio.channels.ReadableByteChannel.read. Reads a sequence of bytes from this channel into the given buffer. An attempt is made to read up to r bytes from the channel, where r is the number of bytes remaining in the buffer, that is, `dst.remaining()`, at the moment this method is invoked. Suppose that a byte sequence of length n is read, where `0` `<=` n `<=` r. This byte sequence will be transferred into the buffer so that the first byte in the sequence is at index p and the last byte is at index p `+` n `-` `1`, where p is the buffer's position at the moment this method is invoked. Upon return the buffer's position will be equal to p `+` n; its limit will not have changed. A read operation might not fill the buffer, and in fact it might not read any bytes at all. Whether or not it does so depends upon the nature and state of the channel. A socket channel in non-blocking mode, for example, cannot read any more bytes than are immediately available from the socket's input buffer; similarly, a file channel cannot read any more bytes than remain in the file. It is guaranteed, however, that if a channel is in blocking mode and there is at least one byte remaining in the buffer then this method will block until at least one byte is read. This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete. Parameters dst:ByteBuffer The buffer into which bytes are to be transferred Returns:int The number of bytes read, possibly zero, or `-1` if the channel has reached end-of-stream Exceptions IOException: If some other I/O error occurs

public int read(ByteBuffer dst) throws IOException

Implements abstract java.nio.channels.SocketChannel.read.

Implements java.nio.channels.ReadableByteChannel.read.

Doc from java.nio.channels.ReadableByteChannel.read.

Reads a sequence of bytes from this channel into the given buffer.

An attempt is made to read up to r bytes from the channel, where r is the number of bytes remaining in the buffer, that is, dst.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is read, where 0 <= n <= r. This byte sequence will be transferred into the buffer so that the first byte in the sequence is at index p and the last byte is at index p + n - 1, where p is the buffer's position at the moment this method is invoked. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

A read operation might not fill the buffer, and in fact it might not read any bytes at all. Whether or not it does so depends upon the nature and state of the channel. A socket channel in non-blocking mode, for example, cannot read any more bytes than are immediately available from the socket's input buffer; similarly, a file channel cannot read any more bytes than remain in the file. It is guaranteed, however, that if a channel is in blocking mode and there is at least one byte remaining in the buffer then this method will block until at least one byte is read.

This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

dst:ByteBuffer: The buffer into which bytes are to be transferred

Returns:int

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Exceptions

IOException:: If some other I/O error occurs

read back to summary

read	back to summary
public long read(ByteBuffer[] dsts, int offset, int length) throws IOException Implements abstract java.nio.channels.SocketChannel.read. Implements java.nio.channels.ScatteringByteChannel.read. Doc from java.nio.channels.ScatteringByteChannel.read. Reads a sequence of bytes from this channel into a subsequence of the given buffers. An invocation of this method attempts to read up to r bytes from this channel, where r is the total number of bytes remaining the specified subsequence of the given buffer array, that is, `dsts[offset].remaining() + dsts[offset+1].remaining() + ... + dsts[offset+length-1].remaining()` dsts[offset].remaining() + dsts[offset+1].remaining() + ... + dsts[offset+length-1].remaining() at the moment that this method is invoked. Suppose that a byte sequence of length n is read, where `0` `<=` n `<=` r. Up to the first `dsts[offset].remaining()` bytes of this sequence are transferred into buffer `dsts[offset]`, up to the next `dsts[offset+1].remaining()` bytes are transferred into buffer `dsts[offset+1]`, and so forth, until the entire byte sequence is transferred into the given buffers. As many bytes as possible are transferred into each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit. This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete. Parameters dsts:ByteBuffer[] The buffers into which bytes are to be transferred offset:int The offset within the buffer array of the first buffer into which bytes are to be transferred; must be non-negative and no larger than `dsts.length` length:int The maximum number of buffers to be accessed; must be non-negative and no larger than `dsts.length` - `offset` Returns:long The number of bytes read, possibly zero, or `-1` if the channel has reached end-of-stream Annotations @Override Exceptions IOException: If some other I/O error occurs

public long read(ByteBuffer[] dsts, int offset, int length) throws IOException

Implements abstract java.nio.channels.SocketChannel.read.

Implements java.nio.channels.ScatteringByteChannel.read.

Doc from java.nio.channels.ScatteringByteChannel.read.

Reads a sequence of bytes from this channel into a subsequence of the given buffers.

An invocation of this method attempts to read up to r bytes from this channel, where r is the total number of bytes remaining the specified subsequence of the given buffer array, that is,

dsts[offset].remaining()
    + dsts[offset+1].remaining()
    + ... + dsts[offset+length-1].remaining()

at the moment that this method is invoked.

Suppose that a byte sequence of length n is read, where 0 <= n <= r. Up to the first dsts[offset].remaining() bytes of this sequence are transferred into buffer dsts[offset], up to the next dsts[offset+1].remaining() bytes are transferred into buffer dsts[offset+1], and so forth, until the entire byte sequence is transferred into the given buffers. As many bytes as possible are transferred into each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit.

Parameters

dsts:ByteBuffer[]: The buffers into which bytes are to be transferred
offset:int: The offset within the buffer array of the first buffer into which bytes are to be transferred; must be non-negative and no larger than dsts.length
length:int: The maximum number of buffers to be accessed; must be non-negative and no larger than dsts.length - offset

Returns:long

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

setFD	back to summary
public void setFD(int fd)

shutdownInput back to summary

shutdownInput	back to summary
public SocketChannel shutdownInput() throws IOException Implements abstract java.nio.channels.SocketChannel.shutdownInput. Doc from java.nio.channels.SocketChannel.shutdownInput. Shutdown the connection for reading without closing the channel. Once shutdown for reading then further reads on the channel will return `-1`, the end-of-stream indication. If the input side of the connection is already shutdown then invoking this method has no effect. Returns:SocketChannel The channel Annotations @Override Exceptions IOException: If some other I/O error occurs

public SocketChannel shutdownInput() throws IOException

Implements abstract java.nio.channels.SocketChannel.shutdownInput.

Doc from java.nio.channels.SocketChannel.shutdownInput.

Shutdown the connection for reading without closing the channel.

Once shutdown for reading then further reads on the channel will return -1, the end-of-stream indication. If the input side of the connection is already shutdown then invoking this method has no effect.

Returns:SocketChannel

The channel

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

shutdownOutput back to summary

shutdownOutput	back to summary
public SocketChannel shutdownOutput() throws IOException Implements abstract java.nio.channels.SocketChannel.shutdownOutput. Doc from java.nio.channels.SocketChannel.shutdownOutput. Shutdown the connection for writing without closing the channel. Once shutdown for writing then further attempts to write to the channel will throw `ClosedChannelException`. If the output side of the connection is already shutdown then invoking this method has no effect. Returns:SocketChannel The channel Annotations @Override Exceptions IOException: If some other I/O error occurs

public SocketChannel shutdownOutput() throws IOException

Implements abstract java.nio.channels.SocketChannel.shutdownOutput.

Doc from java.nio.channels.SocketChannel.shutdownOutput.

Shutdown the connection for writing without closing the channel.

Once shutdown for writing then further attempts to write to the channel will throw ClosedChannelException. If the output side of the connection is already shutdown then invoking this method has no effect.

Returns:SocketChannel

The channel

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

write back to summary

write	back to summary
public int write(ByteBuffer src) throws IOException Implements abstract java.nio.channels.SocketChannel.write. Implements java.nio.channels.WritableByteChannel.write. Doc from java.nio.channels.WritableByteChannel.write. Writes a sequence of bytes to this channel from the given buffer. An attempt is made to write up to r bytes to the channel, where r is the number of bytes remaining in the buffer, that is, `src.remaining()`, at the moment this method is invoked. Suppose that a byte sequence of length n is written, where `0` `<=` n `<=` r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment this method is invoked; the index of the last byte written will be p `+` n `-` `1`. Upon return the buffer's position will be equal to p `+` n; its limit will not have changed. Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer. This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete. Parameters src:ByteBuffer The buffer from which bytes are to be retrieved Returns:int The number of bytes written, possibly zero Exceptions IOException: If some other I/O error occurs

public int write(ByteBuffer src) throws IOException

Implements abstract java.nio.channels.SocketChannel.write.

Implements java.nio.channels.WritableByteChannel.write.

Doc from java.nio.channels.WritableByteChannel.write.

Writes a sequence of bytes to this channel from the given buffer.

An attempt is made to write up to r bytes to the channel, where r is the number of bytes remaining in the buffer, that is, src.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is written, where 0 <= n <= r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment this method is invoked; the index of the last byte written will be p + n - 1. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer.

This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

src:ByteBuffer: The buffer from which bytes are to be retrieved

Returns:int

The number of bytes written, possibly zero

Exceptions

IOException:: If some other I/O error occurs

write back to summary

write	back to summary
public long write(ByteBuffer[] srcs, int offset, int length) throws IOException Implements abstract java.nio.channels.SocketChannel.write. Implements java.nio.channels.GatheringByteChannel.write. Doc from java.nio.channels.GatheringByteChannel.write. Writes a sequence of bytes to this channel from a subsequence of the given buffers. An attempt is made to write up to r bytes to this channel, where r is the total number of bytes remaining in the specified subsequence of the given buffer array, that is, `srcs[offset].remaining() + srcs[offset+1].remaining() + ... + srcs[offset+length-1].remaining()` srcs[offset].remaining() + srcs[offset+1].remaining() + ... + srcs[offset+length-1].remaining() at the moment that this method is invoked. Suppose that a byte sequence of length n is written, where `0` `<=` n `<=` r. Up to the first `srcs[offset].remaining()` bytes of this sequence are written from buffer `srcs[offset]`, up to the next `srcs[offset+1].remaining()` bytes are written from buffer `srcs[offset+1]`, and so forth, until the entire byte sequence is written. As many bytes as possible are written from each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit. Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer. This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete. Parameters srcs:ByteBuffer[] The buffers from which bytes are to be retrieved offset:int The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than `srcs.length` length:int The maximum number of buffers to be accessed; must be non-negative and no larger than `srcs.length` - `offset` Returns:long The number of bytes written, possibly zero Annotations @Override Exceptions IOException: If some other I/O error occurs

public long write(ByteBuffer[] srcs, int offset, int length) throws IOException

Implements abstract java.nio.channels.SocketChannel.write.

Implements java.nio.channels.GatheringByteChannel.write.

Doc from java.nio.channels.GatheringByteChannel.write.

Writes a sequence of bytes to this channel from a subsequence of the given buffers.

An attempt is made to write up to r bytes to this channel, where r is the total number of bytes remaining in the specified subsequence of the given buffer array, that is,

srcs[offset].remaining()
    + srcs[offset+1].remaining()
    + ... + srcs[offset+length-1].remaining()

at the moment that this method is invoked.

Suppose that a byte sequence of length n is written, where 0 <= n <= r. Up to the first srcs[offset].remaining() bytes of this sequence are written from buffer srcs[offset], up to the next srcs[offset+1].remaining() bytes are written from buffer srcs[offset+1], and so forth, until the entire byte sequence is written. As many bytes as possible are written from each buffer, hence the final position of each updated buffer, except the last updated buffer, is guaranteed to be equal to that buffer's limit.

Parameters

srcs:ByteBuffer[]: The buffers from which bytes are to be retrieved
offset:int: The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length
length:int: The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

Returns:long

The number of bytes written, possibly zero

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

public abstract Class AbstractNativeSocketChannel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail