com.prosysopc.ua.stack.utils.asyncsocket

Class AsyncSocketImpl.AsyncSocketInputStream

java.lang.Object

com.prosysopc.ua.stack.utils.asyncsocket.AsyncInputStream

com.prosysopc.ua.stack.utils.asyncsocket.AsyncSocketImpl.AsyncSocketInputStream

Enclosing class:

AsyncSocketImpl

public class AsyncSocketImpl.AsyncSocketInputStream
extends AsyncInputStream

Internal AsyncInputStream of the AsyncSocketImpl.

Constructor Summary

Constructors

Constructor and Description
AsyncSocketInputStream()

Method Summary

Modifier and Type	Method and Description
int	available() Return the number of bytes available in the buffer.
void	close()
BufferMonitor	createMonitor(long position, MonitorListener listener) Create alarm for
int	getBufferSize() Get the number of bytes the stream buffers from TCP stack.
long	getPosition() Get stream position.
long	getReceivedBytes() Get the number of bytes received to this stream
void	peek(byte[] buf) Peek ahead into buffered content.
void	peek(byte[] buf, int off, int len) Peek bytes to buffer
ByteBuffer	peek(int len) Peek bytes to returned buffer
ByteBuffer[]	peekChunks(int len) Peek bytes to byte chunks.
int	read(byte[] b) Reads some number of bytes from the input stream and stores them into the buffer array b.
int	read(byte[] b, int off, int len)
void	read(ByteBuffer dst) Read to byte buffer
void	read(ByteBuffer dst, int length) Read the given number of bytes to byte buffer.
ByteBuffer	read(int len) Read from the stream.
ByteBuffer[]	readChunks(int len) Read from the input stream.
void	setBufferSize(int size) Set a hint number for buffering.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncSocketInputStream

public AsyncSocketInputStream()

Method Detail

available

public int available()

Description copied from class: AsyncInputStream

Return the number of bytes available in the buffer.

Specified by:

available in class AsyncInputStream

Returns:

a int.

close

public void close()

createMonitor

public BufferMonitor createMonitor(long position,
                                   MonitorListener listener)

Create alarm for

Specified by:

createMonitor in class AsyncInputStream

Parameters:

position - position to trigger

listener - alarm listener

Returns:

alarm

getBufferSize

public int getBufferSize()

Description copied from class: AsyncInputStream

Get the number of bytes the stream buffers from TCP stack.

Specified by:

getBufferSize in class AsyncInputStream

Returns:

buffer size

getPosition

public long getPosition()

Get stream position.

Specified by:

getPosition in class AsyncInputStream

Returns:

number of bytes read

getReceivedBytes

public long getReceivedBytes()

Get the number of bytes received to this stream

Specified by:

getReceivedBytes in class AsyncInputStream

Returns:

bytes received

peek

public void peek(byte[] buf)

Description copied from class: AsyncInputStream

Peek ahead into buffered content. Use available() to see how many bytes there is buffered. Use setBufferSize() to control how much to buffer.

Specified by:

peek in class AsyncInputStream

Parameters:

buf - an array of byte.

peek

public void peek(byte[] buf,
                 int off,
                 int len)

Description copied from class: AsyncInputStream

Peek bytes to buffer

Specified by:

peek in class AsyncInputStream

Parameters:

buf - an array of byte.

off - a int.

len - a int.

peek

public ByteBuffer peek(int len)

Description copied from class: AsyncInputStream

Peek bytes to returned buffer

Specified by:

peek in class AsyncInputStream

Parameters:

len - a int.

Returns:

byte buffer

peekChunks

public ByteBuffer[] peekChunks(int len)

Description copied from class: AsyncInputStream

Peek bytes to byte chunks. (Efficient for big chunks as there is no byte copying)

Specified by:

peekChunks in class AsyncInputStream

Parameters:

len - a int.

Returns:

byte buffer array

read

public int read(byte[] b)

Description copied from class: AsyncInputStream

Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

Specified by:

read in class AsyncInputStream

Parameters:

b - the buffer into which the data is read.

Returns:

the total number of bytes read into the buffer, or -1 is there is no more data because the end of the stream has been reached.

See Also:

InputStream.read(byte[], int, int)

read

public int read(byte[] b,
                int off,
                int len)

read

public void read(ByteBuffer dst)

Description copied from class: AsyncInputStream

Read to byte buffer

Specified by:

read in class AsyncInputStream

Parameters:

dst - a ByteBuffer object.

read

public void read(ByteBuffer dst,
                 int length)

Description copied from class: AsyncInputStream

Read the given number of bytes to byte buffer.

Specified by:

read in class AsyncInputStream

Parameters:

dst - a ByteBuffer object.

length - a int.

read

public ByteBuffer read(int len)

Description copied from class: AsyncInputStream

Read from the stream. Returns a readable byte buffer.

Specified by:

read in class AsyncInputStream

Parameters:

len - a int.

Returns:

byte buffer

readChunks

public ByteBuffer[] readChunks(int len)

Description copied from class: AsyncInputStream

Read from the input stream. Returns readable byte buffers. This is the most efficient read method as it does not copy byte data.

Specified by:

readChunks in class AsyncInputStream

Parameters:

len - a int.

Returns:

byte buffer

setBufferSize

public void setBufferSize(int size)

Description copied from class: AsyncInputStream

Set a hint number for buffering. Buffer reads ahead values from TCP Stack. The given number is minimum for buffering.

Specified by:

setBufferSize in class AsyncInputStream

Parameters:

size - new buffer size value