你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
EventHubReceiver.Receive 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
重载
Receive() |
接收事件中心事件数据。 |
Receive(Int32) |
接收事件中心事件数据,最多达到指定计数。 |
Receive(TimeSpan) |
接收具有指定超时值的事件中心事件数据。 |
Receive(Int32, TimeSpan) |
接收事件中心事件数据,最大为具有指定超时值的指定计数。 |
Receive()
接收事件中心事件数据。
public Microsoft.ServiceBus.Messaging.EventData Receive ();
member this.Receive : unit -> Microsoft.ServiceBus.Messaging.EventData
Public Function Receive () As EventData
返回
返回接收 EventData 的对象,如果没有可用的事件数据,则返回 null。
例外
如果服务遇到暂时性错误,则引发。
如果客户端在连接到服务时遇到问题,则引发。
如果当前命名空间在系统上放置过多的负载,则引发。
如果另一个具有较高 Epoch 值的接收方作为当前接收方连接到 指定的 PartitionId同一分区,则引发。
适用于
Receive(Int32)
接收事件中心事件数据,最多达到指定计数。
public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData> Receive (int maxCount);
member this.Receive : int -> seq<Microsoft.ServiceBus.Messaging.EventData>
Public Function Receive (maxCount As Integer) As IEnumerable(Of EventData)
参数
- maxCount
- Int32
用户在一次调用中愿意接受的最大事件数据量。
返回
返回收到的 EventData 集合。 如果在指定时间内未返回任何事件,则集合为空,或者返回所有事件 maxCount
。
例外
如果服务遇到暂时性错误,则引发。
如果客户端在连接到服务时遇到问题,则引发。
如果当前命名空间在系统上放置过多的负载,则引发。
如果另一个具有较高 Epoch 值的接收方作为当前接收方连接到 指定的 PartitionId同一分区,则引发。
注解
在返回给用户之前,服务不会等待 maxCount
事件填充。 只要有任何可用事件,它就会立即返回。
适用于
Receive(TimeSpan)
接收具有指定超时值的事件中心事件数据。
public Microsoft.ServiceBus.Messaging.EventData Receive (TimeSpan waitTime);
member this.Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.EventData
Public Function Receive (waitTime As TimeSpan) As EventData
参数
- waitTime
- TimeSpan
用户愿意等待事件数据到达的最长时间。
返回
返回收到的 EventData 集合,如果没有可用的事件数据,则返回 null。
例外
如果服务遇到暂时性错误,则引发。
如果客户端在连接到服务时遇到问题,则引发。
如果当前命名空间在系统上放置过多的负载,则引发。
如果另一个具有较高 Epoch 值的接收方作为当前接收方连接到 指定的 PartitionId同一分区,则引发。
注解
waitTime
无法保证等待时间,因为 API 会在数据可用时立即返回数据。
适用于
Receive(Int32, TimeSpan)
接收事件中心事件数据,最大为具有指定超时值的指定计数。
public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData> Receive (int maxCount, TimeSpan waitTime);
member this.Receive : int * TimeSpan -> seq<Microsoft.ServiceBus.Messaging.EventData>
Public Function Receive (maxCount As Integer, waitTime As TimeSpan) As IEnumerable(Of EventData)
参数
- maxCount
- Int32
用户在一次调用中愿意接受的最大事件数据量。
- waitTime
- TimeSpan
用户愿意等待事件数据到达的最长时间。
返回
返回收到的 EventData 集合。 如果在指定时间内未返回任何事件,则集合为空,或者返回所有事件 maxCount
。
例外
如果服务遇到暂时性错误,则引发。
如果客户端在连接到服务时遇到问题,则引发。
如果当前命名空间在系统上放置过多的负载,则引发。
如果另一个具有较高 Epoch 值的接收方作为当前接收方连接到 指定的 PartitionId同一分区,则引发。
注解
waitTime
无法保证等待时间,因为 API 会在数据可用时立即返回数据。 此外,在返回给用户之前,服务不会等待 maxCount
事件填充。 只要有任何可用事件,它就会立即返回 。