com.github.dm.jrt.core

Class ByteChannel

java.lang.Object

com.github.dm.jrt.core.ByteChannel

public class ByteChannel
extends Object

Utility class focused on the optimization of the transfer of byte chunks through routine channels.

Each instance maintains a pool of byte buffers which are re-used to minimize memory consumption. When the pool is empty, additional buffers are created in order to avoid blocking the caller thread. Though, the pool will retain its maximum capacity and every buffer exceeding it will be discarded.
Note that the streams used to write into and read from buffers should be properly closed as the Java best practices suggest.

Created by davide-maestroni on 08/26/2015.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ByteChannel.BufferInputStream Input stream used to read the data contained in a buffer instance.
static class	ByteChannel.BufferOutputStream Output stream used to write data into the buffer channel.
class	ByteChannel.ByteBuffer Object acting as a buffer of bytes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE The default buffer size in number of bytes.
static int	DEFAULT_POOL_SIZE The default core pool size.

Method Summary

Methods

Modifier and Type	Method and Description
static ByteChannel	byteChannel() Returns a new byte channel.
static ByteChannel	byteChannel(int dataBufferSize) Returns a new byte channel.
static ByteChannel	byteChannel(int dataBufferSize, int corePoolSize) Returns a new byte channel.
static ByteChannel.BufferInputStream	inputStream(ByteChannel.ByteBuffer... buffers) Creates an input stream returning the concatenation of the data contained in the specified buffers. Note that only one input stream can be created for each buffer.
static ByteChannel.BufferInputStream	inputStream(ByteChannel.ByteBuffer buffer) Creates an input stream returning the data contained in the specified buffer. Note that only one input stream can be created for each buffer.
static ByteChannel.BufferInputStream	inputStream(List<ByteChannel.ByteBuffer> buffers) Creates an input stream returning the concatenation of the data contained in the specified buffers. Note that only one input stream can be created for each buffer.
ByteChannel.BufferOutputStream	passTo(Channel.InputChannel<? super ByteChannel.ByteBuffer> channel) Returns the output stream used to write bytes into the specified channel.
ByteChannel.BufferOutputStream	passTo(IOChannel<? super ByteChannel.ByteBuffer,?> channel) Returns the output stream used to write bytes into the specified channel. Note that the channel will be automatically closed as soon as the returned output stream is closed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

The default buffer size in number of bytes.

See Also:

Constant Field Values

DEFAULT_POOL_SIZE

public static final int DEFAULT_POOL_SIZE

The default core pool size.

See Also:

Constant Field Values

Method Detail

byteChannel

@NotNull
public static ByteChannel byteChannel()

Returns a new byte channel.

Returns:

the byte channel.

byteChannel

@NotNull
public static ByteChannel byteChannel(int dataBufferSize)

Returns a new byte channel.

Parameters:

dataBufferSize - the size of the data buffer used to transfer the bytes through the routine channels.

Returns:

the byte channel.

Throws:

IllegalArgumentException - if the specified size is 0 or negative.

byteChannel

@NotNull
public static ByteChannel byteChannel(int dataBufferSize,
                              int corePoolSize)

Returns a new byte channel.

Parameters:

dataBufferSize - the size of the data buffer used to transfer the bytes through the routine channels.

corePoolSize - the maximum number of data retained in the pool. Additional data created to fulfill the bytes requirement will be discarded.

Returns:

the byte channel.

Throws:

IllegalArgumentException - if the specified size is 0 or negative.

inputStream

@NotNull
public static ByteChannel.BufferInputStream inputStream(@NotNull
                                                ByteChannel.ByteBuffer buffer)

Creates an input stream returning the data contained in the specified buffer.
Note that only one input stream can be created for each buffer.

Parameters:

buffer - the byte buffer.

Returns:

the input stream.

Throws:

IllegalStateException - if an input stream has been already created for the specified buffer.

inputStream

@NotNull
public static ByteChannel.BufferInputStream inputStream(@NotNull
                                                ByteChannel.ByteBuffer... buffers)

Creates an input stream returning the concatenation of the data contained in the specified buffers.
Note that only one input stream can be created for each buffer.

Parameters:

buffers - the byte buffers whose data have to be concatenated.

Returns:

the input stream.

Throws:

IllegalStateException - if an input stream has been already created for one of the specified buffers.

inputStream

@NotNull
public static ByteChannel.BufferInputStream inputStream(@NotNull
                                                List<ByteChannel.ByteBuffer> buffers)

Creates an input stream returning the concatenation of the data contained in the specified buffers.
Note that only one input stream can be created for each buffer.

Parameters:

buffers - the byte buffers whose data have to be concatenated.

Returns:

the input stream.

Throws:

IllegalStateException - if an input stream has been already created for one of the specified buffers.

passTo

@NotNull
public ByteChannel.BufferOutputStream passTo(@NotNull
                                            Channel.InputChannel<? super ByteChannel.ByteBuffer> channel)

Returns the output stream used to write bytes into the specified channel.

Parameters:

channel - the input channel to which pass the data.

Returns:

the output stream.

passTo

@NotNull
public ByteChannel.BufferOutputStream passTo(@NotNull
                                            IOChannel<? super ByteChannel.ByteBuffer,?> channel)

Returns the output stream used to write bytes into the specified channel.
Note that the channel will be automatically closed as soon as the returned output stream is closed.

Parameters:

channel - the I/O channel to which pass the data.

Returns:

the output stream.