Package io.deephaven.client.impl

Interface BarrageSubscription

All Known Implementing Classes:
BarrageSubscriptionImpl
public interface BarrageSubscription
A BarrageSubscription represents a subscription over a table that may or may not be filtered to a viewport of the remote source table.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    BarrageSubscription.Factory
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Future<Table>
    entireTable()
    Request a full subscription of the data and populate a Table with the incrementally updating data that is received.
    Future<Table>
    partialTable(@Nullable Index viewport, @Nullable BitSet columns)
    Request a partial subscription of the data limited by viewport or column set and populate a Table with the data that is received.
    Future<Table>
    partialTable(@Nullable Index viewport, @Nullable BitSet columns, boolean reverseViewport)
    Request a partial subscription of the data limited by viewport or column set and populate a Table with the data that is received.
    Future<Table>
    snapshotEntireTable()
    Request a full snapshot of the data and populate a Table with the incrementally updating data that is received.
    Future<Table>
    snapshotPartialTable(@Nullable Index viewport, @Nullable BitSet columns)
    Request a partial snapshot of the data limited by viewport or column set and populate a Table with the data that is received.
    Future<Table>
    snapshotPartialTable(Index viewport, BitSet columns, boolean reverseViewport)
    Request a partial snapshot of the data limited by viewport or column set and populate a Table with the data that is received.

  • Method Details

    • entireTable

      Future<Table> entireTable()
      Request a full subscription of the data and populate a Table with the incrementally updating data that is received. The returned future will block until all rows for the subscribed table are available.
      Returns:
      a Future that will be populated with the result Table

    • partialTable

      Future<Table> partialTable(@Nullable @Nullable Index viewport, @Nullable @Nullable BitSet columns)
      Request a partial subscription of the data limited by viewport or column set and populate a Table with the data that is received. The returned future will block until the subscribed table viewport is satisfied.
      Parameters:
      viewport - the position-space viewport to use for the subscription
      columns - the columns to include in the subscription
      Returns:
      a Future that will be populated with the result Table

    • partialTable

      Future<Table> partialTable(@Nullable @Nullable Index viewport, @Nullable @Nullable BitSet columns, boolean reverseViewport)
      Request a partial subscription of the data limited by viewport or column set and populate a Table with the data that is received. Allows the viewport to be reversed. The returned future will block until the subscribed table viewport is satisfied.
      Parameters:
      viewport - the position-space viewport to use for the subscription
      columns - the columns to include in the subscription
      reverseViewport - Whether to treat posRowSet as offsets from LongSizedDataStructure.size() rather than 0
      Returns:
      a Future that will be populated with the result Table

    • snapshotEntireTable

      Future<Table> snapshotEntireTable()
      Request a full snapshot of the data and populate a Table with the incrementally updating data that is received. The returned future will block until all rows for the snapshot table are available.
      Returns:
      a Future that will be populated with the result Table

    • snapshotPartialTable

      Future<Table> snapshotPartialTable(@Nullable @Nullable Index viewport, @Nullable @Nullable BitSet columns)
      Request a partial snapshot of the data limited by viewport or column set and populate a Table with the data that is received. The returned future will block until the snapshot table viewport is satisfied.
      Parameters:
      viewport - the position-space viewport to use for the subscription
      columns - the columns to include in the subscription
      Returns:
      a Future that will be populated with the result Table

    • snapshotPartialTable

      Future<Table> snapshotPartialTable(Index viewport, BitSet columns, boolean reverseViewport)
      Request a partial snapshot of the data limited by viewport or column set and populate a Table with the data that is received. Allows the viewport to be reversed. The returned future will block until the snapshot table viewport is satisfied.
      Parameters:
      viewport - the position-space viewport to use for the subscription
      columns - the columns to include in the subscription
      reverseViewport - Whether to treat posRowSet as offsets from LongSizedDataStructure.size() rather than 0
      Returns:
      a Future that will be populated with the result Table