Export (0) Print
Expand All

QueueClient.Receive Method (TimeSpan)

Receives a message using the InternalReceiver().

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

public final function Receive(
	serverWaitTime : TimeSpan
) : BrokeredMessage

Parameters

serverWaitTime
Type: System.TimeSpan
The time span the server waits for receiving a message before it times out.

Return Value

Type: Microsoft.ServiceBus.Messaging.BrokeredMessage
The BrokeredMessage that represents the received message. If no message is available to be received, the method returns NULL, and you can retry the operation at a later time.

ExceptionCondition
ArgumentOutOfRangeException

Thrown if the serverWaitTime is negative.

TimeoutException

Thrown if the message receive operation times out.

OperationCanceledException

Thrown if the client entity has been closed or aborted.

UnauthorizedAccessException

Thrown if an I/O or security error occurs.

MessagingEntityNotFoundException

Thrown if the messaging entity associated with the operation does not exist or it has been deleted.

MessagingException

Thrown if the user code has performed some unexpected operations, or the Service Bus gateway is down. Check the exception message for the actual error.

If Zero is passed in serverWaitTime, then there will be no wait time. Instead the Service Bus will fetch whatever messages are immediately available, or return null as a result.

Community Additions

ADD
Show:
© 2014 Microsoft