Package io.deephaven.plugin.type
Class ObjectTypeClassBase.FetchOnly<T>
java.lang.Object
io.deephaven.plugin.PluginBase
io.deephaven.plugin.type.ObjectTypeBase
io.deephaven.plugin.type.ObjectTypeClassBase<T>
io.deephaven.plugin.type.ObjectTypeClassBase.FetchOnly<T>
- Type Parameters:
T
- the class type
- All Implemented Interfaces:
Plugin
,Registration
,ObjectType
- Direct Known Subclasses:
FigureWidgetTypePlugin
- Enclosing class:
- ObjectTypeClassBase<T>
Abstract base class for object type plugins that can only be fetched (and will not have later responses or accept
later requests). For bidirectional messages, see
ObjectTypeClassBase
.-
Nested Class Summary
Nested classes/interfaces inherited from class io.deephaven.plugin.type.ObjectTypeClassBase
ObjectTypeClassBase.FetchOnly<T>
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 -
Method Summary
Modifier and TypeMethodDescriptionfinal ObjectType.MessageStream
clientConnectionImpl
(T object, ObjectType.MessageStream connection) abstract void
writeToImpl
(Exporter exporter, T object, OutputStream out) Serializesobject
as bytes toout
.Methods inherited from class io.deephaven.plugin.type.ObjectTypeClassBase
clazz, compatibleClientConnection, isType, name, toString
Methods inherited from class io.deephaven.plugin.type.ObjectTypeBase
clientConnection, walk
Methods inherited from class io.deephaven.plugin.PluginBase
registerInto
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface io.deephaven.plugin.Plugin
registerInto
-
Constructor Details
-
FetchOnly
-
-
Method Details
-
clientConnectionImpl
public final ObjectType.MessageStream clientConnectionImpl(T object, ObjectType.MessageStream connection) throws ObjectCommunicationException - Specified by:
clientConnectionImpl
in classObjectTypeClassBase<T>
- Throws:
ObjectCommunicationException
-
writeToImpl
Serializesobject
as bytes toout
. Must only be called witha compatible object
. Server-side objects that should be sent as references to the client (but not themselves serialized in this payload) can be exported using theexporter
- each returnedExporter.Reference
will have anindex
, denoting its position on the array of exported objects to be received by the client.- Parameters:
exporter
- the exporterobject
- the compatible objectout
- the output stream- Throws:
IOException
- if output stream operations failed, the export will then fail, and the client will get a generic error
-