Package io.deephaven.plugin.type

Class ObjectTypeBase

java.lang.Object

io.deephaven.plugin.PluginBase

io.deephaven.plugin.type.ObjectTypeBase

All Implemented Interfaces:

Plugin, Registration, ObjectType

Direct Known Subclasses:

EchoObjectType, ObjectTypeBase.FetchOnly, ObjectTypeClassBase

public abstract class ObjectTypeBase
extends PluginBase
implements ObjectType

Abstract base class for object type plugins, providing some simple implementation details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectTypeBase.FetchOnly	Abstract base class for object type plugins that can only be fetched (and will not have later responses or accept later requests).

Nested classes/interfaces inherited from interface io.deephaven.plugin.type.ObjectType

ObjectType.MessageStream

Nested classes/interfaces inherited from interface io.deephaven.plugin.Plugin

Plugin.Visitor<T>

Nested classes/interfaces inherited from interface io.deephaven.plugin.Registration

Registration.Callback

Constructor Summary

Constructors

Constructor	Description
ObjectTypeBase()

Method Summary

Modifier and Type	Method	Description
final ObjectType.MessageStream	clientConnection(Object object, ObjectType.MessageStream connection)	Signals creation of a client stream to the provided object.
abstract ObjectType.MessageStream	compatibleClientConnection(Object object, ObjectType.MessageStream connection)	Signals creation of a client stream to the provided object.
final <T, V extends Plugin.Visitor<T>> T	walk(V visitor)

Methods inherited from class io.deephaven.plugin.PluginBase

registerInto

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.plugin.type.ObjectType

isType, name

Methods inherited from interface io.deephaven.plugin.Plugin

registerInto

Constructor Details

ObjectTypeBase

public ObjectTypeBase()

Method Details

clientConnection

public final ObjectType.MessageStream clientConnection(Object object,
 ObjectType.MessageStream connection)
                                                throws ObjectCommunicationException

Description copied from interface: ObjectType

Signals creation of a client stream to the provided object. The returned MessageStream implementation will be called with each received message from the client, and can call the provided connection instance to send messages as needed to the client.

Specified by:

clientConnection in interface ObjectType

Parameters:

object - the object to create a connection for

connection - a stream to send objects to the client

Returns:

a stream to receive objects from the client

Throws:

ObjectCommunicationException - may throw an exception received from ObjectType.MessageStream.onData(ByteBuffer, Object...) calls

compatibleClientConnection

public abstract ObjectType.MessageStream compatibleClientConnection(Object object,
 ObjectType.MessageStream connection)
                                                             throws ObjectCommunicationException

Signals creation of a client stream to the provided object. The returned MessageStream implementation will be called with each received message from the client, and can call the provided connection instance to send messages as needed to the client.

Parameters:

object - the object to create a connection for

connection - a stream to send objects to the client

Returns:

a stream to receive objects from the client

Throws:

ObjectCommunicationException - may throw an exception received from ObjectType.MessageStream.onData(ByteBuffer, Object...) calls

walk

public final <T,
V extends Plugin.Visitor<T>> T walk(V visitor)

Specified by:

walk in interface Plugin