Java-WebSocket 1.6.0 · org.java_websocket.WrappedByteChannel

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: is the channel blocking isBlocking() This function returns the blocking state of the channel
public boolean	Returns: is a additional read needed isNeedRead() returns whether readMore should be called to fetch data which has been decoded but not yet been returned.
public boolean	Returns: is a additional write needed isNeedWrite() returns whether writeMore should be called write additional data.
public int	Returns: the amount of remaining data readMore(ByteBuffer the destiny of the read dst) This function does not read data from the underlying channel at all.
public void	writeMore() Gets called when `isNeedWrite()` ()} requires a additional rite

Method Detail

isBlocking	back to summary
public boolean isBlocking() This function returns the blocking state of the channel Returns:boolean is the channel blocking

isBlocking

back to summary

public boolean isBlocking()

This function returns the blocking state of the channel

Returns:boolean: is the channel blocking

isNeedRead back to summary

isNeedRead	back to summary
public boolean isNeedRead() returns whether readMore should be called to fetch data which has been decoded but not yet been returned. Returns:boolean is a additional read needed See Also `read(ByteBuffer)`, `readMore(ByteBuffer)`

public boolean isNeedRead()

returns whether readMore should be called to fetch data which has been decoded but not yet been returned.

Returns:boolean: is a additional read needed
See Also: read(ByteBuffer), readMore(ByteBuffer)

isNeedWrite	back to summary
public boolean isNeedWrite() returns whether writeMore should be called write additional data. Returns:boolean is a additional write needed

isNeedWrite

back to summary

public boolean isNeedWrite()

returns whether writeMore should be called write additional data.

Returns:boolean: is a additional write needed

readMore back to summary

readMore	back to summary
public int readMore(ByteBuffer dst) throws IOException This function does not read data from the underlying channel at all. It is just a way to fetch data which has already be received or decoded but was but was not yet returned to the user. This could be the case when the decoded data did not fit into the buffer the user passed to `read(ByteBuffer)`. Parameters dst:ByteBuffer the destiny of the read Returns:int the amount of remaining data Exceptions IOException: when a error occurred during unwrapping

public int readMore(ByteBuffer dst) throws IOException

This function does not read data from the underlying channel at all. It is just a way to fetch data which has already be received or decoded but was but was not yet returned to the user. This could be the case when the decoded data did not fit into the buffer the user passed to read(ByteBuffer).

Parameters

dst:ByteBuffer: the destiny of the read

Returns:int

the amount of remaining data

Exceptions

IOException:: when a error occurred during unwrapping

writeMore back to summary

writeMore	back to summary
public void writeMore() throws IOException Gets called when `isNeedWrite()` ()} requires a additional rite Exceptions IOException: may be thrown due to an error while writing

public void writeMore() throws IOException

Gets called when isNeedWrite() ()} requires a additional rite

Exceptions

IOException:: may be thrown due to an error while writing

public Interface WrappedByteChannel

Method Summary

Method Detail