Skip to main content

SessionWindowOperator

Struct SessionWindowOperator 

Source
pub struct SessionWindowOperator<A: Aggregator> { /* private fields */ }
Expand description

Session window operator.

Groups events by activity periods separated by gaps. Each unique key maintains its own session state independently.

§Session Lifecycle

  1. Start: First event for a key creates a new session
  2. Extend: Events within gap period extend the session
  3. Close: Timer fires when gap expires, emitting results
  4. Merge: Late data may merge previously separate sessions

§State Management

Session state is stored using prefixed keys:

  • ses:<key_hash> - Session metadata (start, end, key)
  • sac:<key_hash> - Accumulator state

§Emit Strategies

  • OnWatermark: Emit when watermark passes session end
  • OnUpdate: Emit after every state update
  • OnWindowClose: Only emit on final closure
  • Changelog: Emit CDC records with Z-set weights
  • Final: Suppress all intermediate, drop late data

Implementations§

Source§

impl<A: Aggregator> SessionWindowOperator<A>

Source

pub fn new(gap: Duration, aggregator: A, allowed_lateness: Duration) -> Self

Creates a new session window operator.

§Arguments
  • gap - The inactivity gap that closes a session
  • aggregator - Aggregation function to apply within sessions
  • allowed_lateness - Grace period for late data after session close
§Panics

Panics if gap or allowed lateness does not fit in i64.

Source

pub fn with_id( gap: Duration, aggregator: A, allowed_lateness: Duration, operator_id: String, ) -> Self

Creates a new session window operator with a custom operator ID.

§Panics

Panics if gap or allowed lateness does not fit in i64.

Source

pub fn set_key_column(&mut self, column_index: usize)

Sets the key column for per-key session tracking.

If not set, a single global session is maintained.

Source

pub fn key_column(&self) -> Option<usize>

Returns the key column index if set.

Source

pub fn set_emit_strategy(&mut self, strategy: EmitStrategy)

Sets the emit strategy for this operator.

Source

pub fn emit_strategy(&self) -> &EmitStrategy

Returns the current emit strategy.

Source

pub fn set_late_data_config(&mut self, config: LateDataConfig)

Sets the late data handling configuration.

Source

pub fn late_data_config(&self) -> &LateDataConfig

Returns the current late data configuration.

Source

pub fn late_data_metrics(&self) -> &LateDataMetrics

Returns the late data metrics.

Source

pub fn reset_late_data_metrics(&mut self)

Resets the late data metrics counters.

Source

pub fn gap_ms(&self) -> i64

Returns the gap timeout in milliseconds.

Source

pub fn allowed_lateness_ms(&self) -> i64

Returns the allowed lateness in milliseconds.

Source

pub fn active_session_count(&self) -> usize

Returns the number of active sessions.

Trait Implementations§

Source§

impl<A: Aggregator> Operator for SessionWindowOperator<A>

Source§

fn process(&mut self, event: &Event, ctx: &mut OperatorContext<'_>) -> OutputVec

Process an incoming event
Source§

fn on_timer(&mut self, timer: Timer, ctx: &mut OperatorContext<'_>) -> OutputVec

Handle timer expiration
Source§

fn checkpoint(&self) -> OperatorState

Checkpoint the operator’s state
Source§

fn restore(&mut self, state: OperatorState) -> Result<(), OperatorError>

Restore from a checkpoint Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,