com.schooner.MemCached

Class SockInputStream

java.lang.Object

java.io.InputStream

com.schooner.MemCached.SockInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class SockInputStream
extends InputStream

SockInputStream is a inputstream based on a socket. Due to memcached protocol, we can only read specified length from the socket, you have to set the byte length to read before invoke read.

Since:

2.5.0

Author:

Xingen Wang

See Also:

InputStream

Constructor Summary

Constructors

Constructor and Description
SockInputStream(SchoonerSockIO sock) Constructor.
SockInputStream(SchoonerSockIO sock, int limit) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
byte[]	getBuffer() get all left bytes from the socket.
String	getLine() get a line from the socket.
int	getWillRead() get length of to-be-read.
int	read()
int	read(byte[] b, int off, int len)
void	willRead(int limit) set limited length to read.

Methods inherited from class java.io.InputStream

close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

SockInputStream

public SockInputStream(SchoonerSockIO sock,
               int limit)
                throws IOException

Constructor.

Parameters:

sock - SchoonerSockIO, read from this socket.

limit - limited length to read from specified socket.

Throws:

IOException - error happened in reading.

SockInputStream

public SockInputStream(SchoonerSockIO sock)
                throws IOException

Constructor. Read all buffered bytes in the socket.

Parameters:

sock - SchoonerSockIO, read from this socket.

Throws:

IOException - error happened in reading.

Method Detail

getWillRead

public final int getWillRead()

get length of to-be-read.

Returns:

length

willRead

public final void willRead(int limit)

set limited length to read.

Parameters:

length - length to set.

read

public final int read()
               throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

getBuffer

public final byte[] getBuffer()
                       throws IOException

get all left bytes from the socket.

Returns:

byte array of holding all bytes.

Throws:

IOException - error happened in reading.

getLine

public final String getLine()
                     throws IOException

get a line from the socket.

Returns:

a line

Throws:

IOException - error happend in reading.

Since:

2.5.1

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException