QueueClient.Receive Método

Definição

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Pacote:

WindowsAzure.ServiceBus v6.2.2

Sobrecargas

Receive()	Recebe uma mensagem usando o Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.
Receive(Int64)	Recebe uma mensagem adiada usando o Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. Esse método funciona apenas para mensagens adiadas, não regulares.
Receive(TimeSpan)	Recebe uma mensagem usando o Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive()

Recebe uma mensagem usando o Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

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

abstract member Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive () As BrokeredMessage

Retornos

BrokeredMessage

O BrokeredMessage que representa a mensagem recebida. Se nenhuma mensagem estiver disponível para ser recebida, o método retornará NULL e você poderá repetir a operação posteriormente.

Exceções

OperationCanceledException

Gerado se a entidade cliente tiver sido fechada ou anulada.

TimeoutException

Gerado se a mensagem receber a operação atingir o tempo limite.

UnauthorizedAccessException

Gerado se ocorrer um erro de E/S ou de segurança.

MessagingEntityNotFoundException

Gerada se a entidade de mensagens associada à operação não existir ou tiver sido excluída.

MessagingException

Gerado se o código do usuário tiver realizado algumas operações inesperadas ou o gateway do Barramento de Serviço estiver inativo. Verifique a mensagem de exceção do erro real.

Comentários

Um Null pode ser retornado por essa API se a operação excedeu o tempo limite especificado ou as operações foram bem-sucedidas, mas não há mais mensagens a serem recebidas.

Receive(Int64)

Recebe uma mensagem adiada usando o Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. Esse método funciona apenas para mensagens adiadas, não regulares.

public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (long sequenceNumber);

abstract member Receive : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive (sequenceNumber As Long) As BrokeredMessage

Parâmetros

sequenceNumber

Int64

O número de sequência da mensagem adiada a ser recebida.

Retornos

BrokeredMessage

O BrokeredMessage que representa a mensagem recebida. Se nenhuma mensagem estiver disponível para ser recebida, o método retornará NULL e você poderá repetir a operação posteriormente.

Exceções

OperationCanceledException

Gerado se a entidade cliente tiver sido fechada ou anulada.

Comentários

Um Null pode ser retornado por essa API se a operação excedeu o tempo limite especificado ou as operações foram bem-sucedidas, mas a mensagem com a sequência solicitadaNumber não poderá ser localizada.

Receive(TimeSpan)

Recebe uma mensagem usando o Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (TimeSpan serverWaitTime);

abstract member Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive (serverWaitTime As TimeSpan) As BrokeredMessage

Parâmetros

serverWaitTime

TimeSpan

O período de tempo que o servidor aguarda para receber uma mensagem antes de atingir o tempo limite.

Retornos

BrokeredMessage

O BrokeredMessage que representa a mensagem recebida. Se nenhuma mensagem estiver disponível para ser recebida, o método retornará NULL e você poderá repetir a operação posteriormente.

Exceções

ArgumentOutOfRangeException

Gerado se o serverWaitTime for negativo.

TimeoutException

Gerado se a mensagem receber a operação atingir o tempo limite.

OperationCanceledException

Gerado se a entidade cliente tiver sido fechada ou anulada.

UnauthorizedAccessException

Gerado se ocorrer um erro de E/S ou de segurança.

MessagingEntityNotFoundException

Gerada se a entidade de mensagens associada à operação não existir ou tiver sido excluída.

MessagingException

Gerado se o código do usuário tiver realizado algumas operações inesperadas ou o gateway do Barramento de Serviço estiver inativo. Verifique a mensagem de exceção do erro real.

Comentários

Um Null pode ser retornado por essa API se a operação excedeu o tempo limite especificado ou as operações foram bem-sucedidas, mas não há mais mensagens a serem recebidas.