Top Fields Constructors Methods
jnr.unixsocket.impl

public abstract Class AbstractNativeDatagramChannel

extends DatagramChannel
implements ByteChannel, NativeSelectableChannel
Class Inheritance
All Implemented Interfaces
jnr.enxio.channels.NativeSelectableChannel, java.nio.channels.Channel, java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.ByteChannel, java.nio.channels.WritableByteChannel, java.nio.channels.ReadableByteChannel
Known Direct Subclasses
jnr.unixsocket.UnixDatagramChannel
Imports
jnr.enxio.channels.Native, .NativeSelectableChannel, .NativeSelectorProvider, java.io.IOException, java.nio.ByteBuffer, java.nio.channels.ByteChannel, .DatagramChannel, java.nio.channels.spi.SelectorProvider

Field Summary

Modifier and TypeField and Description
private final Common
common

Constructor Summary

AccessConstructor and Description
public
AbstractNativeDatagramChannel(int fd)

pack-priv
AbstractNativeDatagramChannel(SelectorProvider provider, int fd)

Method Summary

Modifier and TypeMethod 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.DatagramChannel.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.DatagramChannel.read.

Implements java.nio.channels.ScatteringByteChannel.read.

Reads a datagram from this channel.
public void
setFD(int fd)

public int
write(ByteBuffer
The buffer from which bytes are to be retrieved
src)

Implements abstract java.nio.channels.DatagramChannel.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.DatagramChannel.write.

Implements java.nio.channels.GatheringByteChannel.write.

Writes a datagram to this channel.
Inherited from java.nio.channels.DatagramChannel:
bindconnectdisconnectgetLocalAddressgetRemoteAddressisConnectedopenopenreadreceivesendsetOptionsocketvalidOpswrite

Field Detail

commonback to summary
private final Common common

Constructor Detail

AbstractNativeDatagramChannelback to summary
public AbstractNativeDatagramChannel(int fd)
AbstractNativeDatagramChannelback to summary
pack-priv AbstractNativeDatagramChannel(SelectorProvider provider, int fd)

Method Detail

getFDback to summary
public final int getFD()

Implements jnr.enxio.channels.NativeSelectableChannel.getFD.

implCloseSelectableChannelback 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
implConfigureBlockingback 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
readback to summary
public int read(ByteBuffer dst) throws IOException

Implements abstract java.nio.channels.DatagramChannel.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
readback to summary
public long read(ByteBuffer[] dsts, int offset, int length) throws IOException

Implements abstract java.nio.channels.DatagramChannel.read.

Implements java.nio.channels.ScatteringByteChannel.read.

Doc from java.nio.channels.DatagramChannel.read.

Reads a datagram from this channel.

This method may only be invoked if this channel's socket is connected, and it only accepts datagrams from the socket's peer. If there are more bytes in the datagram than remain in the given buffers then the remainder of the datagram is silently discarded. Otherwise this method behaves exactly as specified in the ScatteringByteChannel interface.

Parameters
dsts:ByteBuffer[]

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

The buffers into which bytes are to be transferred

offset:int

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

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

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

The maximum number of buffers to be accessed; must be non-negative and no larger than dsts.length - offset

Returns:long

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

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

Annotations
@Override
Exceptions
IOException:

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

If some other I/O error occurs

setFDback to summary
public void setFD(int fd)
writeback to summary
public int write(ByteBuffer src) throws IOException

Implements abstract java.nio.channels.DatagramChannel.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
writeback to summary
public long write(ByteBuffer[] srcs, int offset, int length) throws IOException

Implements abstract java.nio.channels.DatagramChannel.write.

Implements java.nio.channels.GatheringByteChannel.write.

Doc from java.nio.channels.DatagramChannel.write.

Writes a datagram to this channel.

This method may only be invoked if this channel's socket is connected, in which case it sends datagrams directly to the socket's peer. Otherwise it behaves exactly as specified in the GatheringByteChannel interface.

Parameters
srcs:ByteBuffer[]

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

The buffers from which bytes are to be retrieved

offset:int

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

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

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

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 sent, which will be either the number of bytes that were remaining in the source buffer when this method was invoked or, if this channel is non-blocking, may be zero if there was insufficient room for the datagram in the underlying output buffer

Annotations
@Override
Exceptions
IOException:

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

If some other I/O error occurs