EventHubReceiver.Receive メソッド

定義

名前空間:

Microsoft.ServiceBus.Messaging

アセンブリ:

Microsoft.ServiceBus.dll

パッケージ:

WindowsAzure.ServiceBus v6.2.2

オーバーロード

Receive()	Event Hubs イベント データを受信します。
Receive(Int32)	Event Hubs イベント データを、指定した数まで受信します。
Receive(TimeSpan)	指定されたタイムアウト値を持つ Event Hubs イベント データを受信します。
Receive(Int32, TimeSpan)	指定したタイムアウト値を持つ指定した数まで Event Hubs イベント データを受信します。

Receive()

Event Hubs イベント データを受信します。

public Microsoft.ServiceBus.Messaging.EventData Receive ();

member this.Receive : unit -> Microsoft.ServiceBus.Messaging.EventData

Public Function Receive () As EventData

戻り値

EventData

受信した EventData オブジェクトを返します。使用可能なイベント データがない場合は null を返します。

例外

MessagingException

サービスで一時的なエラーが発生した場合にスローされます。

MessagingCommunicationException

クライアントがサービスへの接続に問題がある場合にスローされます。

ServerBusyException

現在の名前空間がシステムに負荷がかかりすぎる場合にスローされます。

ReceiverDisconnectedException

値が大きい Epoch 別のレシーバーが、 で PartitionId指定された同じパーティションに現在のレシーバーとして接続されている場合にスローされます。

Receive(Int32)

Event Hubs イベント データを、指定した数まで受信します。

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

ユーザーが 1 回の呼び出しで受け入れるイベント データの最大量。

戻り値

IEnumerable<EventData>

受信した EventData コレクションを返します。 指定した時間内にイベントが返されない場合、または 以降 maxCount のすべてのイベントが返される場合、コレクションは空になります。

例外

MessagingException

サービスで一時的なエラーが発生した場合にスローされます。

MessagingCommunicationException

クライアントがサービスへの接続に問題がある場合にスローされます。

ServerBusyException

現在の名前空間がシステムに負荷がかかりすぎる場合にスローされます。

ReceiverDisconnectedException

値が大きい Epoch 別のレシーバーが、 で PartitionId指定された同じパーティションに現在のレシーバーとして接続されている場合にスローされます。

注釈

サービスは、ユーザーに戻る前にイベントの入力を待機 maxCount しません。 使用可能なイベントが発生するとすぐにが返されます。

Receive(TimeSpan)

指定されたタイムアウト値を持つ Event Hubs イベント データを受信します。

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

受信した EventData コレクションを返します。使用可能なイベント データがない場合は null を返します。

例外

MessagingException

サービスで一時的なエラーが発生した場合にスローされます。

MessagingCommunicationException

クライアントがサービスへの接続に問題がある場合にスローされます。

ServerBusyException

現在の名前空間がシステムに負荷がかかりすぎる場合にスローされます。

ReceiverDisconnectedException

値が大きい Epoch 別のレシーバーが、 で PartitionId指定された同じパーティションに現在のレシーバーとして接続されている場合にスローされます。

注釈

waitTime は、API が使用可能になるとすぐにデータを返すので、保証された待機時間ではありません。

Receive(Int32, TimeSpan)

指定したタイムアウト値を持つ指定した数まで Event Hubs イベント データを受信します。

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

ユーザーが 1 回の呼び出しで受け入れるイベント データの最大量。

waitTime

TimeSpan

ユーザーがイベント データの到着を待機する最大時間。

戻り値

IEnumerable<EventData>

受信した EventData コレクションを返します。 指定した時間内にイベントが返されない場合、または 以降 maxCount のすべてのイベントが返される場合、コレクションは空になります。

例外

MessagingException

サービスで一時的なエラーが発生した場合にスローされます。

MessagingCommunicationException

クライアントがサービスへの接続に問題がある場合にスローされます。

ServerBusyException

現在の名前空間がシステムに負荷がかかりすぎる場合にスローされます。

ReceiverDisconnectedException

値が大きい Epoch 別のレシーバーが、 で PartitionId指定された同じパーティションに現在のレシーバーとして接続されている場合にスローされます。

注釈

waitTime は、API が使用可能になるとすぐにデータを返すので、保証された待機時間ではありません。 また、サービスは、ユーザーに戻る前にイベントが入力されるのを待 maxCount つことはありません。 使用可能なイベントが発生するとすぐに が返されます。