Package one.microstream.communication.types

Class Com

java.lang.Object

one.microstream.communication.types.Com

public class Com
extends Object

Method Summary

Modifier and Type	Method	Description
static byte[]	assembleSendableProtocolBytes(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter)
static byte[]	assembleSendableProtocolBytes(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter, int lengthCharCount)
static VarString	assembleSendableProtocolString(VarString vs, ComProtocol protocol, ComProtocolStringConverter protocolStringConverter, int lengthCharCount)
static VarString	assembleSendableProtocolString(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter, int lengthCharCount)
static void	bounce(ComHostChannel<SocketChannel> channel)	This method is catastrophically naive.
static ByteBuffer	bufferProtocol(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter)
static ByteBuffer	bufferProtocol(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter, int protocolLengthDigitCount)
static ByteOrder	byteOrder()
static ComClient<SocketChannel>	Client(int localHostPort, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComClient<SocketChannel>	Client(InetSocketAddress targetAddress, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComClient<SocketChannel>	Client(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComClientChannel<SocketChannel>	connect(int localHostPort, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComClientChannel<SocketChannel>	connect(InetSocketAddress targetAddress, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComClientChannel<SocketChannel>	connect(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComDefaultIdStrategy	DefaultIdStrategy(long startingObjectId)
static ComDefaultIdStrategy	DefaultIdStrategyClient()
static ComDefaultIdStrategy	DefaultIdStrategyHost()
static PersistenceIdStrategy	DefaultIdStrategyHostInitialization()
static long	defaultObjectIdBaseClient()
static long	defaultObjectIdBaseHost()
static int	defaultPort()	An arbitrary default port, mostly only viable for uber-simplicity demonstration purposes.
static int	defaultProtocolLengthDigitCount()
static ComFoundation.Default<?>	Foundation()
static ComHost<SocketChannel>	Host(int localHostPort, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComHost<SocketChannel>	Host(int localHostPort, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static ComHost<SocketChannel>	Host(InetSocketAddress targetAddress, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComHost<SocketChannel>	Host(InetSocketAddress targetAddress, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static ComHost<SocketChannel>	Host(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static ComHost<SocketChannel>	Host(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static InetSocketAddress	localHostSocketAddress()
static InetSocketAddress	localHostSocketAddress(int port)
static void	runHost(int localHostPort, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static void	runHost(int localHostPort, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static void	runHost(InetSocketAddress targetAddress, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static void	runHost(InetSocketAddress targetAddress, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator, ComHostChannelAcceptor<SocketChannel> channelAcceptor)
static void	runHost(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)
static void	runHost(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator, ComHostChannelAcceptor<SocketChannel> channelAcceptor)

Methods inherited from class java.lang.Object

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

Method Details

defaultObjectIdBaseHost

public static long defaultObjectIdBaseHost()

defaultObjectIdBaseClient

public static long defaultObjectIdBaseClient()

DefaultIdStrategy

public static ComDefaultIdStrategy DefaultIdStrategy(long startingObjectId)

DefaultIdStrategyHost

public static ComDefaultIdStrategy DefaultIdStrategyHost()

DefaultIdStrategyClient

public static ComDefaultIdStrategy DefaultIdStrategyClient()

DefaultIdStrategyHostInitialization

public static PersistenceIdStrategy DefaultIdStrategyHostInitialization()

byteOrder

public static ByteOrder byteOrder()

defaultPort

public static int defaultPort()

An arbitrary default port, mostly only viable for uber-simplicity demonstration purposes.

Returns:

the framework's default port.

localHostSocketAddress

public static InetSocketAddress localHostSocketAddress() throws ComException

Throws:

ComException

localHostSocketAddress

public static InetSocketAddress localHostSocketAddress(int port) throws ComException

Throws:

ComException

Foundation

public static ComFoundation.Default<?> Foundation()

defaultProtocolLengthDigitCount

public static int defaultProtocolLengthDigitCount()

bufferProtocol

public static ByteBuffer bufferProtocol(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter)

bufferProtocol

public static ByteBuffer bufferProtocol(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter, int protocolLengthDigitCount)

assembleSendableProtocolBytes

public static byte[] assembleSendableProtocolBytes(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter)

assembleSendableProtocolBytes

public static byte[] assembleSendableProtocolBytes(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter, int lengthCharCount)

assembleSendableProtocolString

public static VarString assembleSendableProtocolString(ComProtocol protocol, ComProtocolStringConverter protocolStringConverter, int lengthCharCount)

assembleSendableProtocolString

public static VarString assembleSendableProtocolString(VarString vs, ComProtocol protocol, ComProtocolStringConverter protocolStringConverter, int lengthCharCount)

bounce

public static void bounce(ComHostChannel<SocketChannel> channel) throws ComException

This method is catastrophically naive. And by design. Its only purpose and viability is to serve as an uber-simplicity default implementation for ComHostChannelAcceptor for framework demonstration purposes.

Used logic:

• uses SocketChannel.
• calls ComChannel.receive() on the passed channel.
• calls Object.toString() on the received instance to assemble its String representation.
• sends a new String echoing the string representation back to the sender.
• calls ComChannel.close() on the passed channel.

So this method depends on the mercy of whatever the received instance's Class Object.toString() implementation is and works only with strings and closes the channel after one sent message. It is absolutely not recommended to use this method for anything except basic demonstration purposes and as an API usage/learning example.

/!\ DO NOT USE THIS METHOD FOR PRODUCTION Purposes!

You have been warned.

Parameters:

channel - A one-shot ComHostChannel to receive and send exactely one message.

Throws:

ComException

Host

public static final ComHost<SocketChannel> Host(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)

Host

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

Host

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

Host

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

Host

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

Host

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

runHost

public static final void runHost(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)

runHost

public static final void runHost(int localHostPort, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)

runHost

public static final void runHost(InetSocketAddress targetAddress, ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)

runHost

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

runHost

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

runHost

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

Client

public static final ComClient<SocketChannel> Client(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)

Client

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

Client

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

connect

public static final ComClientChannel<SocketChannel> connect(ComPersistenceAdaptorCreator<SocketChannel> persistenceAdaptorCreator)

connect

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

connect

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