jnr-enxio 0.32.17 · jnr.enxio.channels.NativeSocketChannel

Modifier and Type	Field and Description
private final int	fd
private static final int	SHUT_RD
private static final int	SHUT_WR
private final int	validOps

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

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 java.nio.channels.ReadableByteChannel.read. Reads a sequence of bytes from this channel into the given buffer.
public void	shutdownInput()
public void	shutdownOutput()
public final int	validOps() Implements abstract java.nio.channels.SelectableChannel.validOps. Returns an operation set identifying this channel's supported operations.
public int	write(ByteBuffer The buffer from which bytes are to be retrieved src) Implements java.nio.channels.WritableByteChannel.write. Writes a sequence of bytes to this channel from the given buffer.

Inherited from java.nio.channels.spi.AbstractSelectableChannel:: blockingLock configureBlocking implCloseChannel isBlocking isRegistered keyFor provider register

fd	back to summary
private final int fd

SHUT_RD	back to summary
private static final int SHUT_RD

SHUT_WR	back to summary
private static final int SHUT_WR

validOps	back to summary
private final int validOps

NativeSocketChannel	back to summary
public NativeSocketChannel(int fd)

NativeSocketChannel	back to summary
public NativeSocketChannel(int fd, int ops)

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

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

shutdownInput	back to summary
public void shutdownInput() throws IOException

shutdownOutput	back to summary
public void shutdownOutput() throws IOException

validOps	back to summary
public final int validOps() Implements abstract java.nio.channels.SelectableChannel.validOps. Doc from java.nio.channels.SelectableChannel.validOps. Returns an operation set identifying this channel's supported operations. The bits that are set in this integer value denote exactly the operations that are valid for this channel. This method always returns the same value for a given concrete channel class. Returns:int The valid-operation set Annotations @Override

validOps

back to summary

public final int validOps()

Implements abstract java.nio.channels.SelectableChannel.validOps.

Doc from java.nio.channels.SelectableChannel.validOps.

Returns an operation set identifying this channel's supported operations. The bits that are set in this integer value denote exactly the operations that are valid for this channel. This method always returns the same value for a given concrete channel class.

Returns:int

The valid-operation set

Annotations

@Override

write back to summary

write	back to summary
public int write(ByteBuffer src) throws IOException 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 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 Class NativeSocketChannel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail