Package io.deephaven.client.impl

Class CustomObject

java.lang.Object

io.deephaven.client.impl.CustomObject

All Implemented Interfaces:

HasExportId, HasPathId, HasTicketId, HasTypedTicket, ObjectService.Bidirectional, ObjectService.Fetchable, ServerObject, Closeable, AutoCloseable

public final class CustomObject
extends Object
implements ObjectService.Fetchable, ObjectService.Bidirectional

A custom server object that may be ObjectService.Fetchable or ObjectService.Bidirectional. The client is responsible for implementing the necessarily retrieval logic according to the specific type().

See Also:

• deephaven-core#4486
• deephaven-core#4487
• deephaven-core#4488

Method Summary

Modifier and Type	Method	Description
final void	close()	Releases this without waiting for the result.
ObjectService.MessageStream<ClientData>	connect(ObjectService.MessageStream<ServerData> receiveStream)	Initiates a connection for a bidirectional message stream for this.
final ExportId	exportId()	Get the export ID.
CompletableFuture<ServerData>	fetch()	Fetches this.
final PathId	pathId()	Get the path ID.
final CompletableFuture<Void>	release()	Releases this.
final TicketId	ticketId()	Get the ticket ID.
final String	toString()
String	type()	The type.
final TypedTicket	typedTicket()	Get the typed ticket.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.client.impl.HasExportId

exportId

Methods inherited from interface io.deephaven.client.impl.HasPathId

pathId

Methods inherited from interface io.deephaven.client.impl.HasTicketId

ticketId

Methods inherited from interface io.deephaven.client.impl.HasTypedTicket

typedTicket

Methods inherited from interface io.deephaven.client.impl.ServerObject

close, release

Method Details

type

public String type()

Description copied from interface: ObjectService.Fetchable

The type.

Specified by:

type in interface ObjectService.Bidirectional

Specified by:

type in interface ObjectService.Fetchable

Returns:

the type

fetch

public CompletableFuture<ServerData> fetch()

Description copied from interface: ObjectService.Fetchable

Fetches this. The resulting object is managed separately from this.

Specified by:

fetch in interface ObjectService.Fetchable

Returns:

the future

See Also:

• for the lower-level interface

connect

public ObjectService.MessageStream<ClientData> connect(ObjectService.MessageStream<ServerData> receiveStream)

Description copied from interface: ObjectService.Bidirectional

Initiates a connection for a bidirectional message stream for this. The returned ServerData messages are managed separately from this.

This provides a generic stream feature for Deephaven instances to use to add arbitrary functionality. This API lets a client open a stream to a particular object on the server, to be mediated by a server side plugin. In theory this could effectively be used to "tunnel" a custom gRPC call, but in practice there are a few deliberate shortcomings that still make this possible, but not trivial.

Presently it is required that the server respond immediately, at least to acknowledge that the object was correctly contacted (as opposed to waiting for a pending ticket, or dealing with network lag, etc). This is a small (and possibly not required, but convenient) departure from a offering a gRPC stream (a server-streaming or bidi-streaming call need not send a message right away).

Specified by:

connect in interface ObjectService.Bidirectional

Parameters:

receiveStream - the stream where the client will receive messages

Returns:

the stream where the client will send messages

See Also:

• for the lower-level interface

exportId

public final ExportId exportId()

Description copied from interface: HasExportId

Get the export ID.

Specified by:

exportId in interface HasExportId

Returns:

the export ID

pathId

public final PathId pathId()

Description copied from interface: HasPathId

Get the path ID.

Specified by:

pathId in interface HasPathId

Returns:

the path ID

ticketId

public final TicketId ticketId()

Description copied from interface: HasTicketId

Get the ticket ID.

Specified by:

ticketId in interface HasTicketId

Returns:

the ticket ID

typedTicket

public final TypedTicket typedTicket()

Description copied from interface: HasTypedTicket

Get the typed ticket.

Specified by:

typedTicket in interface HasTypedTicket

Returns:

the typed ticket

release

public final CompletableFuture<Void> release()

Description copied from interface: ServerObject

Releases this. After releasing, callers should not use this object nor HasExportId.exportId() for additional RPC calls.

Specified by:

release in interface ServerObject

Returns:

the future

See Also:

• Session.release(ExportId)

close

public final void close()

Description copied from interface: ServerObject

Releases this without waiting for the result. After closing, callers should not use this object nor HasExportId.exportId() for additional RPC calls. For more control, see ServerObject.release().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ServerObject

toString

public final String toString()

Overrides:

toString in class Object