Struct dataflow_types::client::controller::Controller

pub struct Controller<C> {
    client: C,
    source_descriptions: BTreeMap<GlobalId, Option<SourceDesc>>,
    compute_since_uppers: SinceUpperMap,
    storage_since_uppers: SinceUpperMap,
}

A client that maintains soft state and validates commands, in addition to forwarding them.

Fields

client: C

The underlying client,

source_descriptions: BTreeMap<GlobalId, Option<SourceDesc>>

Sources that have been created.

A None variant means that the source was dropped before it was first created.

compute_since_uppers: SinceUpperMap

Tracks since and upper frontiers for indexes and sinks.

storage_since_uppers: SinceUpperMap

Tracks since and upper frontiers for sources and tables.

Implementations

impl<C: Client> Controller<C>

pub async fn send(&mut self, cmd: Command)

pub async fn recv(&mut self) -> Option<Response>

impl<C> Controller<C>

pub fn new(client: C) -> Self

Create a new controller from a client it should wrap.

pub fn source_description_for(&self, id: GlobalId) -> Option<&SourceDesc>

Returns the source description for a given identifier.

The response does not distinguish between an as yet uncreated source description, and one that has been created and then dropped (or dropped without creation). There is a distinction and the client is aware of it, and could plausibly return this information if we had a use for it.

pub fn index_since_upper_for(
    &self,
    id: GlobalId
) -> Option<(AntichainRef<'_, Timestamp>, AntichainRef<'_, Timestamp>)>

Returns the pair of since and upper for a maintained index, if it exists.

The since frontier indicates that the maintained data are certainly valid for times greater or equal to the frontier, but they may not be for other times. Attempting to create a dataflow using this id with an as_of that is not at least since will result in an error.

The upper frontier indicates that the data are reported available for all times not greater or equal to the frontier. Dataflows with an as_of greater or equal to this frontier may not immediately produce results.

pub fn source_since_upper_for(
    &self,
    id: GlobalId
) -> Option<(AntichainRef<'_, Timestamp>, AntichainRef<'_, Timestamp>)>

Returns the pair of since and upper for a source, if it exists.

The since frontier indicates that the maintained data are certainly valid for times greater or equal to the frontier, but they may not be for other times. Attempting to create a dataflow using this id with an as_of that is not at least since will result in an error.

The upper frontier indicates that the data are reported available for all times not greater or equal to the frontier. Dataflows with an as_of greater or equal to this frontier may not immediately produce results.

Trait Implementations

impl<C: Client> Client for Controller<C>

fn send<'life0, 'async_trait>(
    &'life0 mut self,
    cmd: Command
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sends a command to the dataflow server.

fn recv<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Option<Response>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Receives the next response from the dataflow server.