Trait sea_streamer::Streamer

source ·

pub trait Streamer: Sized {
    type Error: Error;
    type Producer: Producer<Error = Self::Error>;
    type Consumer: Consumer<Error = Self::Error>;
    type ConnectOptions: ConnectOptions;
    type ConsumerOptions: ConsumerOptions;
    type ProducerOptions: ProducerOptions;

    // Required methods
    fn connect(
        streamer: StreamerUri,
        options: Self::ConnectOptions
    ) -> impl Future<Output = Result<Self, StreamErr<Self::Error>>> + Send;
    fn disconnect(
        self
    ) -> impl Future<Output = Result<(), StreamErr<Self::Error>>> + Send;
    fn create_generic_producer(
        &self,
        options: Self::ProducerOptions
    ) -> impl Future<Output = Result<Self::Producer, StreamErr<Self::Error>>> + Send;
    fn create_consumer(
        &self,
        streams: &[StreamKey],
        options: Self::ConsumerOptions
    ) -> impl Future<Output = Result<Self::Consumer, StreamErr<Self::Error>>> + Send;

    // Provided method
    fn create_producer(
        &self,
        stream: StreamKey,
        options: Self::ProducerOptions
    ) -> impl Future<Output = Result<Self::Producer, StreamErr<Self::Error>>> + Send { ... }
}

Expand description

Common interface of streamer clients.

Required Associated Types§

source

type ProducerOptions: ProducerOptions

Required Methods§

source

fn connect( streamer: StreamerUri, options: Self::ConnectOptions ) -> impl Future<Output = Result<Self, StreamErr<Self::Error>>> + Send

Establish a connection to the streaming server.

source

fn disconnect( self ) -> impl Future<Output = Result<(), StreamErr<Self::Error>>> + Send

Flush and disconnect from the streaming server.

source

fn create_generic_producer( &self, options: Self::ProducerOptions ) -> impl Future<Output = Result<Self::Producer, StreamErr<Self::Error>>> + Send

Create a producer that can stream to any stream key.

source

fn create_consumer( &self, streams: &[StreamKey], options: Self::ConsumerOptions ) -> impl Future<Output = Result<Self::Consumer, StreamErr<Self::Error>>> + Send

Create a consumer subscribing to the specified streams.

Provided Methods§

source

fn create_producer( &self, stream: StreamKey, options: Self::ProducerOptions ) -> impl Future<Output = Result<Self::Producer, StreamErr<Self::Error>>> + Send

Create a producer that streams to the specified stream.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source §

impl Streamer for KafkaStreamer

source §

async fn disconnect(self) -> Result<(), StreamErr<KafkaError>>

It will flush all producers

source §

async fn create_consumer( &self, streams: &[StreamKey], options: <KafkaStreamer as Streamer>::ConsumerOptions ) -> Result<<KafkaStreamer as Streamer>::Consumer, StreamErr<KafkaError>>

If ConsumerMode is RealTime, auto commit will be disabled and it always stream from latest. group_id must not be set.

If ConsumerMode is Resumable, it will use a group id unique to this host: on a physical machine, it will use the mac address. Inside a docker container, it will use the container id. So when the process restarts, it will resume from last committed offset. group_id must not be set.

If ConsumerMode is LoadBalanced, shards will be divided-and-assigned by the broker to consumers sharing the same group_id. group_id must already be set.

If you need to override the HOST ID, you can set the ENV var HOST_ID.

§