Class Channel.Config

java.lang.Object

org.apidesign.jvm.channel.Channel.Config

Enclosing class:

Channel<Data extends Channel.Config>

public abstract static class Channel.Config
extends Object

Set of methods necessary for construction of a Channel. Subclasses must have a public default constructor accessible via reflection from the Channel.create(JVM, Class) method.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Config()	Subclasses must have public default constructor.

Method Summary

Modifier and Type	Method	Description
abstract Object	read(ByteBuffer buf)	Deserializes bytes of a message into an object representing them.
abstract void	write(Object obj, ByteBuffer buf)	Configuration must be capable to serialize messages sent to the channel into byte[].

Methods inherited from class Object

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

Constructor Details

Config

protected Config()

Subclasses must have public default constructor.

Method Details

write

public abstract void write(Object obj,
 ByteBuffer buf)
                    throws IOException,
BufferOverflowException

Configuration must be capable to serialize messages sent to the channel into byte[]. The sibling function read(ByteBuffer) must then be capable to reconstruct the object back.

Parameters:

obj - the object with the message to transfer

buf - buffer to put the serialized form representing the provided object into

Throws:

IOException - if the conversion goes wrong

BufferOverflowException - when the Buffer.limit() is reached and needs to be increased

See Also:

• read(ByteBuffer)

read

public abstract Object read(ByteBuffer buf)
                     throws IOException

Deserializes bytes of a message into an object representing them. Operates in reverse to write(Object, ByteBuffer) function.

Parameters:

buf - the buffer with stored data

Returns:

object representing the message stored in the buffer

Throws:

IOException - if the conversion fails for some reason