com.rethinkdb.net

Interface ConnectionSocket

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

public interface ConnectionSocket
extends java.io.Closeable

A connection socket into the server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConnectionSocket.AsyncFactory An asynchronous factory of sockets.
static interface	ConnectionSocket.Factory A factory of sockets.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection socket.
boolean	isOpen() Checks if the connection socket is open.
@NotNull java.nio.ByteBuffer	read(int length) Reads a defined amount of bytes, and wraps it in a ByteBuffer.
@NotNull java.lang.String	readCString(@Nullable java.lang.Long timeoutMs) Reads a null-terminated string, under a timeout.
void	write(@NotNull java.nio.ByteBuffer buffer) Writes the contents of the buffer into the socket.

Method Detail

isOpen

boolean isOpen()

Checks if the connection socket is open.

Returns:

true if the connection socket is open, false otherwise.

close

void close()

Closes the connection socket.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

write

void write(@NotNull
           @NotNull java.nio.ByteBuffer buffer)

Writes the contents of the buffer into the socket.

Parameters:

buffer - the contents to write.

read

@NotNull
@NotNull java.nio.ByteBuffer read(int length)

Reads a defined amount of bytes, and wraps it in a ByteBuffer.

Parameters:

length - the length of bytes to read.

Returns:

a ByteBuffer with the read contents.

readCString

@NotNull
@NotNull java.lang.String readCString(@Nullable
                                               @Nullable java.lang.Long timeoutMs)

Reads a null-terminated string, under a timeout. If time runs out, it throws instead.

Parameters:

timeoutMs - the timeout, in milliseconds

Returns:

the string.