Package io.deephaven.client.impl

Class BarrageSession

java.lang.Object

io.deephaven.client.impl.FlightSession

io.deephaven.client.impl.BarrageSession

All Implemented Interfaces:

BarrageSnapshot.Factory, BarrageSubscription.Factory, AutoCloseable

public class BarrageSession
extends FlightSession
implements BarrageSubscription.Factory, BarrageSnapshot.Factory

Field Summary

Fields inherited from class io.deephaven.client.impl.FlightSession

client, session

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BarrageSession(SessionImpl session, org.apache.arrow.flight.FlightClient client)

Method Summary

Modifier and Type	Method	Description
DeephavenChannel	channel()	The authenticated channel.
static BarrageSession	create(SessionImpl session, org.apache.arrow.memory.BufferAllocator incomingAllocator, io.grpc.ManagedChannel channel)
static BarrageSession	of(SessionImpl session, org.apache.arrow.memory.BufferAllocator incomingAllocator, io.grpc.ManagedChannel channel)	Creates a barrage session.
BarrageSnapshot	snapshot(TableHandle tableHandle, BarrageSnapshotOptions options)	Sources a barrage snapshot from a TableHandle.
BarrageSnapshot	snapshot(TableSpec tableSpec, BarrageSnapshotOptions options)	Sources a barrage snapshot from a TableSpec.
BarrageSubscription	subscribe(TableHandle tableHandle, BarrageSubscriptionOptions options)	Sources a barrage subscription from a TableHandle.
BarrageSubscription	subscribe(TableSpec tableSpec, BarrageSubscriptionOptions options)	Sources a barrage subscription from a TableSpec.

Methods inherited from class io.deephaven.client.impl.FlightSession

addToInputTable, addToInputTable, close, deleteFromInputTable, deleteFromInputTable, list, put, put, putExport, putExport, putExportManual, putExportManual, release, schema, schema, session, startExchange, stream

Methods inherited from class java.lang.Object

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

Constructor Details

BarrageSession

protected BarrageSession(SessionImpl session,
 org.apache.arrow.flight.FlightClient client)

Method Details

of

public static BarrageSession of(SessionImpl session,
 org.apache.arrow.memory.BufferAllocator incomingAllocator,
 io.grpc.ManagedChannel channel)

Creates a barrage session. Closing the barrage session does not close channel.

Parameters:

session - the session

incomingAllocator - the incoming allocator

channel - the managed channel

Returns:

the barrage session

create

@InternalUseOnly
public static BarrageSession create(SessionImpl session,
 org.apache.arrow.memory.BufferAllocator incomingAllocator,
 io.grpc.ManagedChannel channel)

See Also:

• of(SessionImpl, BufferAllocator, ManagedChannel)

ApiNote:

This method exists to be called by the Python API. It will be removed in the future if we can make JPY capable of selecting the right factory method to use when the same method is present in the class hierarchy multiple times.

subscribe

public BarrageSubscription subscribe(TableSpec tableSpec,
 BarrageSubscriptionOptions options)
                              throws TableHandle.TableHandleException,
InterruptedException

Description copied from interface: BarrageSubscription.Factory

Sources a barrage subscription from a TableSpec.

Specified by:

subscribe in interface BarrageSubscription.Factory

Parameters:

tableSpec - the tableSpec to resolve and then subscribe to

options - the options configuring the details of this subscription

Returns:

the BarrageSubscription

Throws:

TableHandle.TableHandleException

InterruptedException

subscribe

public BarrageSubscription subscribe(TableHandle tableHandle,
 BarrageSubscriptionOptions options)

Description copied from interface: BarrageSubscription.Factory

Sources a barrage subscription from a TableHandle. A new reference of the handle is created. The original tableHandle is still owned by the caller.

Specified by:

subscribe in interface BarrageSubscription.Factory

Parameters:

tableHandle - the table handle to subscribe to

options - the options configuring the details of this subscription

Returns:

the BarrageSubscription

snapshot

public BarrageSnapshot snapshot(TableSpec tableSpec,
 BarrageSnapshotOptions options)
                         throws TableHandle.TableHandleException,
InterruptedException

Description copied from interface: BarrageSnapshot.Factory

Sources a barrage snapshot from a TableSpec.

Specified by:

snapshot in interface BarrageSnapshot.Factory

Parameters:

tableSpec - the tableSpec to resolve and then snapshot

options - the options configuring the details of this snapshot

Returns:

the BarrageSnapshot

Throws:

TableHandle.TableHandleException

InterruptedException

snapshot

public BarrageSnapshot snapshot(TableHandle tableHandle,
 BarrageSnapshotOptions options)

Description copied from interface: BarrageSnapshot.Factory

Sources a barrage snapshot from a TableHandle. A new reference of the handle is created. The original tableHandle is still owned by the caller.

Specified by:

snapshot in interface BarrageSnapshot.Factory

Parameters:

tableHandle - the table handle to snapshot

options - the options configuring the details of this snapshot

Returns:

the BarrageSnapshot

channel

public DeephavenChannel channel()

The authenticated channel.

Returns:

the authenticated channel