one.microstream.communication.binary.types

Class ComBinary

java.lang.Object

one.microstream.communication.binary.types.ComBinary

public class ComBinary
extends Object

Method Summary

Modifier and Type	Method and Description
static int	chunkHeaderLength() The length of the fixed-size chunk header.
static ComClient<SocketChannel>	Client()
static ComClient<SocketChannel>	Client(InetSocketAddress targetAddress)
static ComClient<SocketChannel>	Client(int localHostPort)
static ComClientChannel<SocketChannel>	connect()
static ComClientChannel<SocketChannel>	connect(InetSocketAddress targetAddress)
static ComClientChannel<SocketChannel>	connect(int localHostPort)
static ComPersistenceAdaptorBinary.Creator.Default	DefaultPersistenceAdaptorCreator()
static ComFoundation.Default<?>	Foundation()
static long	getChunkHeaderContentLength(ByteBuffer directByteBuffer, boolean switchedByteOrder)
static ComHost<SocketChannel>	Host()
static ComHost<SocketChannel>	Host(ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static ComHost<SocketChannel>	Host(InetSocketAddress targetAddress)
static ComHost<SocketChannel>	Host(InetSocketAddress targetAddress, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static ComHost<SocketChannel>	Host(int localHostPort)
static ComHost<SocketChannel>	Host(int localHostPort, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static int	operationTimeout()
static ByteBuffer	readChunk(SocketChannel channel, ByteBuffer defaultBuffer, boolean switchedByteOrder)
static void	runHost()
static void	runHost(ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static void	runHost(InetSocketAddress targetAddress)
static void	runHost(InetSocketAddress targetAddress, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static void	runHost(int localHostPort)
static void	runHost(int localHostPort, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static ByteBuffer	setChunkHeaderContentLength(ByteBuffer directByteBuffer, long contentLength, boolean switchedByteOrder)
static void	writeChunk(SocketChannel channel, ByteBuffer headerBuffer, ByteBuffer[] buffers)

Methods inherited from class java.lang.Object

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

Method Detail

chunkHeaderLength

public static int chunkHeaderLength()

The length of the fixed-size chunk header.

So far, the header only consists of one field holding the length of the chunk content. See Binary.lengthLength(). In the future, the header might contain validation values like protocol name, version, byte order, etc.
Maybe, the consequence will be a dynamically sized header, meaning there

Returns:

The length of the fixed-size chunk header.

getChunkHeaderContentLength

public static long getChunkHeaderContentLength(ByteBuffer directByteBuffer,
                                               boolean switchedByteOrder)

setChunkHeaderContentLength

public static ByteBuffer setChunkHeaderContentLength(ByteBuffer directByteBuffer,
                                                     long contentLength,
                                                     boolean switchedByteOrder)

operationTimeout

public static int operationTimeout()

readChunk

public static ByteBuffer readChunk(SocketChannel channel,
                                   ByteBuffer defaultBuffer,
                                   boolean switchedByteOrder)
                            throws one.microstream.com.ComException,
                                   one.microstream.com.ComExceptionTimeout

Throws:

one.microstream.com.ComException

one.microstream.com.ComExceptionTimeout

writeChunk

public static void writeChunk(SocketChannel channel,
                              ByteBuffer headerBuffer,
                              ByteBuffer[] buffers)
                       throws one.microstream.com.ComException,
                              one.microstream.com.ComExceptionTimeout

Throws:

one.microstream.com.ComException

one.microstream.com.ComExceptionTimeout

DefaultPersistenceAdaptorCreator

public static ComPersistenceAdaptorBinary.Creator.Default DefaultPersistenceAdaptorCreator()

Foundation

public static ComFoundation.Default<?> Foundation()

Host

public static final ComHost<SocketChannel> Host()

Host

public static final ComHost<SocketChannel> Host(int localHostPort)

Host

public static final ComHost<SocketChannel> Host(InetSocketAddress targetAddress)

Host

public static final ComHost<SocketChannel> Host(ComHostChannelAcceptor<SocketChannel> channelAcceptor)

Host

public static final ComHost<SocketChannel> Host(int localHostPort,
                                                ComHostChannelAcceptor<SocketChannel> channelAcceptor)

Host

public static final ComHost<SocketChannel> Host(InetSocketAddress targetAddress,
                                                ComHostChannelAcceptor<SocketChannel> channelAcceptor)

runHost

public static final void runHost()

runHost

public static final void runHost(int localHostPort)

runHost

public static final void runHost(InetSocketAddress targetAddress)

runHost

public static final void runHost(ComHostChannelAcceptor<SocketChannel> channelAcceptor)

runHost

public static final void runHost(int localHostPort,
                                 ComHostChannelAcceptor<SocketChannel> channelAcceptor)

runHost

public static final void runHost(InetSocketAddress targetAddress,
                                 ComHostChannelAcceptor<SocketChannel> channelAcceptor)

Client

public static final ComClient<SocketChannel> Client()

Client

public static final ComClient<SocketChannel> Client(int localHostPort)

Client

public static final ComClient<SocketChannel> Client(InetSocketAddress targetAddress)

connect

public static final ComClientChannel<SocketChannel> connect()

connect

public static final ComClientChannel<SocketChannel> connect(int localHostPort)

connect

public static final ComClientChannel<SocketChannel> connect(InetSocketAddress targetAddress)