Skip to content

Commit fa016ac

Browse files
authored
update docs on buffered producer timeout (#34912)
1 parent 2ae2928 commit fa016ac

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,8 @@ def send_event(
576576
:keyword float timeout: The maximum wait time to send the event data in non-buffered mode or the
577577
maximum wait time to enqueue the event data into the buffer in buffered mode.
578578
In non-buffered mode, the default wait time specified when the producer
579-
was created will be used. In buffered mode, the default wait time is None.
579+
was created will be used. In buffered mode, the default wait time is None indicating that the event will be
580+
scheduled to send immediately.
580581
:keyword str partition_id: The specific partition ID to send to. Default is None, in which case the service
581582
will assign to all partitions using round-robin.
582583
A `TypeError` will be raised if partition_id is specified and event_data_batch is an `EventDataBatch` because

sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,8 @@ async def send_event(
557557
:keyword float timeout: The maximum wait time to send the event data in non-buffered mode or the
558558
maximum wait time to enqueue the event data into the buffer in buffered mode.
559559
In non-buffered mode, the default wait time specified when the producer
560-
was created will be used. In buffered mode, the default wait time is None.
560+
was created will be used. In buffered mode, the default wait time is None indicating that the event will be
561+
scheduled to send immediately.
561562
:keyword str partition_id: The specific partition ID to send to. Default is None, in which case the service
562563
will assign to all partitions using round-robin.
563564
A `TypeError` will be raised if partition_id is specified and event_data_batch is an `EventDataBatch` because

0 commit comments

Comments
 (0)