Struct rdkafka::producer::future_producer::FutureProducer
source · pub struct FutureProducer<C = DefaultClientContext, R = DefaultRuntime>where
C: ClientContext + 'static,{ /* private fields */ }
Expand description
A producer that returns a Future
for every message being produced.
Since message production in rdkafka is asynchronous, the caller cannot
immediately know if the delivery of the message was successful or not. The
FutureProducer provides this information in a Future
, which will be
completed once the information becomes available.
This producer has an internal polling thread and as such it doesn’t need to
be polled. It can be cheaply cloned to get a reference to the same
underlying producer. The internal polling thread will be terminated when the
FutureProducer
goes out of scope.
Implementations§
source§impl<C, R> FutureProducer<C, R>where
C: ClientContext + 'static,
R: AsyncRuntime,
impl<C, R> FutureProducer<C, R>where
C: ClientContext + 'static,
R: AsyncRuntime,
sourcepub async fn send<K, P, T>(
&self,
record: FutureRecord<'_, K, P>,
queue_timeout: T,
) -> OwnedDeliveryResult
pub async fn send<K, P, T>( &self, record: FutureRecord<'_, K, P>, queue_timeout: T, ) -> OwnedDeliveryResult
Sends a message to Kafka, returning the result of the send.
The queue_timeout
parameter controls how long to retry for if the
librdkafka producer queue is full. Set it to Timeout::Never
to retry
forever or Timeout::After(0)
to never block. If the timeout is reached
and the queue is still full, an RDKafkaErrorCode::QueueFull
error will
be reported in the OwnedDeliveryResult
.
Keep in mind that queue_timeout
only applies to the first phase of the
send operation. Once the message is queued, the underlying librdkafka
client has separate timeout parameters that apply, like
delivery.timeout.ms
.
See also the FutureProducer::send_result
method, which will not
retry the queue operation if the queue is full.
sourcepub fn send_result<'a, K, P>(
&self,
record: FutureRecord<'a, K, P>,
) -> Result<DeliveryFuture, (KafkaError, FutureRecord<'a, K, P>)>
pub fn send_result<'a, K, P>( &self, record: FutureRecord<'a, K, P>, ) -> Result<DeliveryFuture, (KafkaError, FutureRecord<'a, K, P>)>
Like FutureProducer::send
, but if enqueuing fails, an error will be
returned immediately, alongside the FutureRecord
provided.
Trait Implementations§
source§impl<C, R> Clone for FutureProducer<C, R>where
C: ClientContext + 'static,
impl<C, R> Clone for FutureProducer<C, R>where
C: ClientContext + 'static,
source§fn clone(&self) -> FutureProducer<C, R>
fn clone(&self) -> FutureProducer<C, R>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<R> FromClientConfig for FutureProducer<DefaultClientContext, R>where
R: AsyncRuntime,
impl<R> FromClientConfig for FutureProducer<DefaultClientContext, R>where
R: AsyncRuntime,
source§fn from_config(
config: &ClientConfig,
) -> KafkaResult<FutureProducer<DefaultClientContext, R>>
fn from_config( config: &ClientConfig, ) -> KafkaResult<FutureProducer<DefaultClientContext, R>>
source§impl<C, R> FromClientConfigAndContext<C> for FutureProducer<C, R>where
C: ClientContext + 'static,
R: AsyncRuntime,
impl<C, R> FromClientConfigAndContext<C> for FutureProducer<C, R>where
C: ClientContext + 'static,
R: AsyncRuntime,
source§fn from_config_and_context(
config: &ClientConfig,
context: C,
) -> KafkaResult<FutureProducer<C, R>>
fn from_config_and_context( config: &ClientConfig, context: C, ) -> KafkaResult<FutureProducer<C, R>>
source§impl<C, R> Producer<FutureProducerContext<C>> for FutureProducer<C, R>where
C: ClientContext + 'static,
R: AsyncRuntime,
impl<C, R> Producer<FutureProducerContext<C>> for FutureProducer<C, R>where
C: ClientContext + 'static,
R: AsyncRuntime,
source§fn client(&self) -> &Client<FutureProducerContext<C>>
fn client(&self) -> &Client<FutureProducerContext<C>>
Client
underlying this producer.source§fn flush<T: Into<Timeout>>(&self, timeout: T) -> KafkaResult<()>
fn flush<T: Into<Timeout>>(&self, timeout: T) -> KafkaResult<()>
source§fn in_flight_count(&self) -> i32
fn in_flight_count(&self) -> i32
source§fn init_transactions<T: Into<Timeout>>(&self, timeout: T) -> KafkaResult<()>
fn init_transactions<T: Into<Timeout>>(&self, timeout: T) -> KafkaResult<()>
source§fn begin_transaction(&self) -> KafkaResult<()>
fn begin_transaction(&self) -> KafkaResult<()>
source§fn send_offsets_to_transaction<T: Into<Timeout>>(
&self,
offsets: &TopicPartitionList,
cgm: &ConsumerGroupMetadata,
timeout: T,
) -> KafkaResult<()>
fn send_offsets_to_transaction<T: Into<Timeout>>( &self, offsets: &TopicPartitionList, cgm: &ConsumerGroupMetadata, timeout: T, ) -> KafkaResult<()>
source§fn commit_transaction<T: Into<Timeout>>(&self, timeout: T) -> KafkaResult<()>
fn commit_transaction<T: Into<Timeout>>(&self, timeout: T) -> KafkaResult<()>
source§fn abort_transaction<T: Into<Timeout>>(&self, timeout: T) -> KafkaResult<()>
fn abort_transaction<T: Into<Timeout>>(&self, timeout: T) -> KafkaResult<()>
source§fn context(&self) -> &Arc<C>
fn context(&self) -> &Arc<C>
ProducerContext
used to create this
producer.Auto Trait Implementations§
impl<C, R> Freeze for FutureProducer<C, R>
impl<C = DefaultClientContext, R = TokioRuntime> !RefUnwindSafe for FutureProducer<C, R>
impl<C, R> Send for FutureProducer<C, R>where
R: Send,
impl<C, R> Sync for FutureProducer<C, R>where
R: Sync,
impl<C, R> Unpin for FutureProducer<C, R>where
R: Unpin,
impl<C = DefaultClientContext, R = TokioRuntime> !UnwindSafe for FutureProducer<C, R>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)