Struct WebSocketSourceServer 

pub struct WebSocketSourceServer { /* private fields */ }

WebSocket source connector in server mode.

Binds a TCP listener and accepts incoming WebSocket connections. All clients’ messages feed into the same bounded channel for poll_batch() consumption.

Implementations

impl WebSocketSourceServer

pub fn new( schema: SchemaRef, config: WebSocketSourceConfig, registry: Option<&Registry>, ) -> Self

Creates a new WebSocket source connector in server mode.

pub fn state(&self) -> ConnectorState

Returns the current connector state.

pub fn connected_clients(&self) -> u64

Returns the number of currently connected clients.

Trait Implementations

impl Debug for WebSocketSourceServer

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

Formats the value using the given formatter.

impl SourceConnector for WebSocketSourceServer

fn open<'life0, 'life1, 'async_trait>( &'life0 mut self, config: &'life1 ConnectorConfig, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called once before polling begins.

fn poll_batch<'life0, 'async_trait>( &'life0 mut self, max_records: usize, ) -> Pin<Box<dyn Future<Output = Result<Option<SourceBatch>, ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Ok(None) = no data currently available; runtime retries after a delay. max_records is a hint — implementations may return fewer.

fn schema(&self) -> SchemaRef

Arrow schema of records this source produces.

fn checkpoint(&self) -> SourceCheckpoint

Returned checkpoint must contain enough info to resume from the current position after a restart.

fn restore<'life0, 'life1, 'async_trait>( &'life0 mut self, checkpoint: &'life1 SourceCheckpoint, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called during recovery before polling resumes.

fn health_check(&self) -> HealthStatus

Defaults to Unknown; connectors should override.

fn metrics(&self) -> ConnectorMetrics

Current connector metrics snapshot.

fn data_ready_notify(&self) -> Option<Arc<Notify>>

Returns a [Notify] handle that is signalled when new data is available.

fn supports_replay(&self) -> bool

Whether this source supports replay from a checkpointed position.

fn close<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Close the connection and release resources.

fn discover_schema<'life0, 'life1, 'async_trait>( &'life0 mut self, _properties: &'life1 HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Resolve the source schema from the WITH (...) properties before DDL reaches the planner. Implementations that hit the network (e.g. Kafka fetching an Avro schema from a Schema Registry) must bound their I/O with a timeout and leave the schema empty on failure rather than hang.

fn as_schema_provider(&self) -> Option<&dyn SchemaProvider>

Returns this connector as a SchemaProvider, if supported.

fn as_schema_registry_aware(&self) -> Option<&dyn SchemaRegistryAware>

Returns this connector as a SchemaRegistryAware, if supported.

fn checkpoint_requested(&self) -> Option<Arc<AtomicBool>>

Returns a shared flag that the source sets to true when it requests an immediate checkpoint.

fn notify_epoch_committed<'life0, 'async_trait>( &'life0 mut self, _epoch: u64, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Acknowledge that epoch has been durably committed.