Struct ActiveSubscribe

pub struct ActiveSubscribe {
    pub conn_id: ConnectionId,
    pub session_uuid: Uuid,
    pub cluster_id: ClusterId,
    pub depends_on: BTreeSet<GlobalId>,
    pub channel: UnboundedSender<PeekResponseUnary>,
    pub emit_progress: bool,
    pub as_of: Timestamp,
    pub arity: usize,
    pub start_time: EpochMillis,
    pub output: SubscribeOutput,
}

A description of an active subscribe from coord’s perspective

Fields

conn_id: ConnectionId

The ID of the connection which created the subscribe.

session_uuid: Uuid

The UUID of the session which created the subscribe.

cluster_id: ClusterId

The ID of the cluster on which the subscribe is running.

depends_on: BTreeSet<GlobalId>

The IDs of the objects on which the subscribe depends.

channel: UnboundedSender<PeekResponseUnary>

Channel on which to send responses to the client.

emit_progress: bool

Whether progress information should be emitted.

as_of: Timestamp

The logical timestamp at which the subscribe began execution.

arity: usize

The number of columns in the relation that was subscribed to.

start_time: EpochMillis

The time when the subscribe started.

output: SubscribeOutput

How to present the subscribe’s output.

Implementations

impl ActiveSubscribe

pub fn initialize(&self)

Initializes the subscription.

This method must be called exactly once, after constructing an ActiveSubscribe and before calling process_response.

fn send_progress_message(&self, upper: &Antichain<Timestamp>)

pub fn process_response(&self, batch: SubscribeBatch) -> bool

Processes a subscribe response from the controller.

Returns true if the subscribe is finished.

pub fn retire(self, reason: ActiveComputeSinkRetireReason)

Retires the subscribe with the specified reason.

This method must be called on every subscribe before it is dropped. It informs the end client that the subscribe is finished for the specified reason.

fn send(&self, response: PeekResponseUnary)

Sends a message to the client if the subscribe has not already completed and if the client has not already gone away.

Trait Implementations

impl Debug for ActiveSubscribe

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.