Package io.deephaven.server.arrow

Class HierarchicalTableViewExchangeMarshaller

java.lang.Object

io.deephaven.server.arrow.HierarchicalTableViewExchangeMarshaller

All Implemented Interfaces:

ExchangeMarshaller

public class HierarchicalTableViewExchangeMarshaller
extends Object
implements ExchangeMarshaller

An ExchangeMarshaller for HierarchicalTableView. Subscriptions are supported, with each subsequent update providing a complete snapshot of the desired viewport. Snapshots are not permitted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HierarchicalTableViewExchangeMarshaller.Factory

Constructor Summary

Constructors

Constructor	Description
HierarchicalTableViewExchangeMarshaller(HierarchicalTableViewSubscription.Factory htvsFactory)

Method Summary

Modifier and Type	Method	Description
boolean	accept(Object export)	Does this marshaller accept the given export?
int	priority()	The priority of this marshaller.
void	snapshot(io.deephaven.barrage.flatbuf.BarrageSnapshotRequest snapshotRequest, BarrageSnapshotOptions options, Object export, BarragePerformanceLog.SnapshotMetricsHelper metrics, io.grpc.stub.StreamObserver<BarrageMessageWriter.MessageView> listener, String ticketLogName, BarrageMessageWriter.Factory streamGeneratorFactory)	Processes a snapshot request using the provided parameters.
ExchangeMarshaller.Subscription	subscribe(io.deephaven.barrage.flatbuf.BarrageSubscriptionRequest subscriptionRequest, BarrageSubscriptionOptions options, Object export, io.grpc.stub.StreamObserver<BarrageMessageWriter.MessageView> listener)	Subscribes to a Barrage stream using the provided subscription request and options.

Methods inherited from class java.lang.Object

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

Constructor Details

HierarchicalTableViewExchangeMarshaller

public HierarchicalTableViewExchangeMarshaller(HierarchicalTableViewSubscription.Factory htvsFactory)

Method Details

priority

public int priority()

Description copied from interface: ExchangeMarshaller

The priority of this marshaller.

All available marshallers are consulted in sequence, in ascending numerical priority. The first (lowest numerical priority) marshaller to accept an object is used.

Specified by:

priority in interface ExchangeMarshaller

Returns:

the priority of this marshaller

accept

public boolean accept(Object export)

Description copied from interface: ExchangeMarshaller

Does this marshaller accept the given export?

Specified by:

accept in interface ExchangeMarshaller

Parameters:

export - the object to test

Returns:

true if this marshaller should be used, false to use the remainder of the marshaller chain

snapshot

public void snapshot(io.deephaven.barrage.flatbuf.BarrageSnapshotRequest snapshotRequest,
 BarrageSnapshotOptions options,
 Object export,
 BarragePerformanceLog.SnapshotMetricsHelper metrics,
 io.grpc.stub.StreamObserver<BarrageMessageWriter.MessageView> listener,
 String ticketLogName,
 BarrageMessageWriter.Factory streamGeneratorFactory)

Description copied from interface: ExchangeMarshaller

Processes a snapshot request using the provided parameters.

Specified by:

snapshot in interface ExchangeMarshaller

Parameters:

snapshotRequest - the request specifying details for the snapshot operation

options - the configuration options for the snapshot, such as batch size or message size limits

export - the object to be exported as part of the snapshot

metrics - helper for recording and reporting snapshot performance metrics

listener - the observer to handle messages generated during the snapshot process

ticketLogName - the name of the ticket log associated with the snapshot request

streamGeneratorFactory - the factory to generate message streams for the snapshot operation

subscribe

public ExchangeMarshaller.Subscription subscribe(io.deephaven.barrage.flatbuf.BarrageSubscriptionRequest subscriptionRequest,
 BarrageSubscriptionOptions options,
 Object export,
 io.grpc.stub.StreamObserver<BarrageMessageWriter.MessageView> listener)

Description copied from interface: ExchangeMarshaller

Subscribes to a Barrage stream using the provided subscription request and options.

Specified by:

subscribe in interface ExchangeMarshaller

Parameters:

subscriptionRequest - the request specifying the details of the subscription

options - the options to configure the subscription

export - the exported object to be subscribed

listener - the listener to handle messages generated by the subscription

Returns:

a Subscription object to manage the lifecycle of the Barrage subscription