QueueClient Class

 

Represents the queue client object.

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

System::Object
  Microsoft.ServiceBus.Messaging::ClientEntity
    Microsoft.ServiceBus.Messaging::QueueClient

public ref class QueueClient abstract : ClientEntity

NameDescription
System_CAPS_pubpropertyIsClosed

(Inherited from ClientEntity.)

System_CAPS_pubpropertyMessagingFactory

Gets or sets the messaging factory.

System_CAPS_pubpropertyMode

Gets the message receive mode when processing the received message.

System_CAPS_pubpropertyPath

Gets or sets the full path name of the queue.

System_CAPS_pubpropertyPrefetchCount

Gets or sets the number of messages that the queue receiver can simultaneously request.

System_CAPS_pubpropertyRetryPolicy

(Inherited from ClientEntity.)

System_CAPS_protpropertyThisLock

(Inherited from ClientEntity.)

NameDescription
System_CAPS_pubmethodAbandon(Guid)

Discards the message and relinquishes the message lock ownership.

System_CAPS_pubmethodAbandon(Guid, IDictionary<String^, Object^>^)

Discards the message and relinquishes the message lock ownership.

System_CAPS_pubmethodAbandonAsync(Guid)

Asynchronously discards the message and relinquishes the message lock ownership.

System_CAPS_pubmethodAbandonAsync(Guid, IDictionary<String^, Object^>^)

Asynchronously discards the message and relinquishes the message lock ownership.

System_CAPS_pubmethodAbort()

Performs abort functionality on the messaging entity.(Inherited from ClientEntity.)

System_CAPS_pubmethodAcceptMessageSession()

Accepts a message session that allows grouping of related messages for processing in a single transaction.

System_CAPS_pubmethodAcceptMessageSession(String^)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.

System_CAPS_pubmethodAcceptMessageSession(String^, TimeSpan)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.

System_CAPS_pubmethodAcceptMessageSession(TimeSpan)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.

System_CAPS_pubmethodAcceptMessageSessionAsync()

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction.

System_CAPS_pubmethodAcceptMessageSessionAsync(String^)

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.

System_CAPS_pubmethodAcceptMessageSessionAsync(String^, TimeSpan)

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.

System_CAPS_pubmethodAcceptMessageSessionAsync(TimeSpan)

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.

System_CAPS_pubmethodCancelScheduledMessageAsync(Int64)

Cancels a scheduled message

System_CAPS_pubmethodClose()

Sends a cleanup message to Service Bus to signal the completion of the usage of an entity.(Inherited from ClientEntity.)

System_CAPS_pubmethodCloseAsync()

Sends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity.(Inherited from ClientEntity.)

System_CAPS_pubmethodComplete(Guid)

Completes processing of a message.

System_CAPS_pubmethodCompleteAsync(Guid)

Asynchronously completes processing of a message.

System_CAPS_pubmethodCompleteBatch(IEnumerable<Guid>^)

Completes processing of a message batch.

System_CAPS_pubmethodCompleteBatchAsync(IEnumerable<Guid>^)

Asynchronously completes processing of a message batch.

System_CAPS_pubmethodSystem_CAPS_staticCreate(String^)

Creates a new copy of QueueClient with specified path.

System_CAPS_pubmethodSystem_CAPS_staticCreate(String^, ReceiveMode)

Creates a new copy of QueueClient with specified path and mode.

System_CAPS_pubmethodSystem_CAPS_staticCreateFromConnectionString(String^)

Creates a new instance of QueueClient using the specified connection string.

System_CAPS_pubmethodSystem_CAPS_staticCreateFromConnectionString(String^, ReceiveMode)

Creates a new instance of QueueClient using the specified connection string and receiving mode.

System_CAPS_pubmethodSystem_CAPS_staticCreateFromConnectionString(String^, String^)

Creates a new copy of QueueClient from a connection string with the specified queue path. Use this overload only when the connection string does not use the EntityPath property.

System_CAPS_pubmethodSystem_CAPS_staticCreateFromConnectionString(String^, String^, ReceiveMode)

Creates a new instance of QueueClient from a connection string with the specified path and mode. Use this overload only when the connection string does not use the EntityPath property.

System_CAPS_pubmethodDeadLetter(Guid)

Moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetter(Guid, IDictionary<String^, Object^>^)

Moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetter(Guid, String^, String^)

Moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync(Guid)

Asynchronously moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync(Guid, IDictionary<String^, Object^>^)

Asynchronously moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync(Guid, String^, String^)

Asynchronously moves the undelivered message to the dead letter queue.

System_CAPS_pubmethodDefer(Guid)

Suspends the processing of a message.

System_CAPS_pubmethodDefer(Guid, IDictionary<String^, Object^>^)

Suspends the processing of a message.

System_CAPS_pubmethodDeferAsync(Guid)

Asynchronously suspends the processing of a message.

System_CAPS_pubmethodDeferAsync(Guid, IDictionary<String^, Object^>^)

Asynchronously suspends the processing of a message.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFault()

For internal use only. Do not inherit from this class.(Inherited from ClientEntity.)

System_CAPS_protmethodFinalize()

(Inherited from ClientEntity.)

System_CAPS_pubmethodSystem_CAPS_staticFormatDeadLetterPath(String^)

Builds a format name from the specified dead letter queue path.

System_CAPS_pubmethodSystem_CAPS_staticFormatTransferDeadLetterPath(String^)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetMessageSessions()

Gets the message sessions, enabling you to browse sessions on queues.

System_CAPS_pubmethodGetMessageSessions(DateTime)

Retrieves all message sessions whose session state was updated since lastUpdatedTime.

System_CAPS_pubmethodGetMessageSessionsAsync()

Asynchronously gets the message sessions, enabling you to browse sessions on queues.

System_CAPS_pubmethodGetMessageSessionsAsync(DateTime)

Asynchronously retrieves all message sessions whose session state was updated since lastUpdatedTime.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnAbort()

Executes upon calling the Abort event.(Overrides ClientEntity::OnAbort().)

System_CAPS_protmethodOnBeginAcceptMessageSession(String^, ReceiveMode, Int32, TimeSpan, TimeSpan, AsyncCallback^, Object^)

System_CAPS_protmethodOnBeginClose(TimeSpan, AsyncCallback^, Object^)

Executes when the Close operation is called.(Overrides ClientEntity::OnBeginClose(TimeSpan, AsyncCallback^, Object^).)

System_CAPS_protmethodOnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback^, Object^)

Executes the begin create receiver action.

System_CAPS_protmethodOnBeginCreateReceiver(String^, ReceiveMode, TimeSpan, AsyncCallback^, Object^)

Executes the begin create receiver action.

System_CAPS_protmethodOnBeginCreateSender(TimeSpan, AsyncCallback^, Object^)

Executes the begin create sender action.

System_CAPS_protmethodOnBeginGetMessageSessions(DateTime, AsyncCallback^, Object^)

Executes the BeginGetMessageSessions action.

System_CAPS_protmethodOnBeginOpen(TimeSpan, AsyncCallback^, Object^)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnClose(TimeSpan)

Executes upon calling the Close action.(Overrides ClientEntity::OnClose(TimeSpan).)

System_CAPS_protmethodOnClosed()

(Inherited from ClientEntity.)

System_CAPS_protmethodOnEndAcceptMessageSession(IAsyncResult^)

Executes upon calling the EndAcceptMessageSession operation.

System_CAPS_protmethodOnEndClose(IAsyncResult^)

Executes the end close action.(Overrides ClientEntity::OnEndClose(IAsyncResult^).)

System_CAPS_protmethodOnEndCreateReceiver(IAsyncResult^)

Executes the end create receiver action.

System_CAPS_protmethodOnEndCreateSender(IAsyncResult^)

Executes the end create sender action.

System_CAPS_protmethodOnEndGetMessageSessions(IAsyncResult^)

Executes the end get message action.

System_CAPS_protmethodOnEndOpen(IAsyncResult^)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnFaulted()

(Inherited from ClientEntity.)

System_CAPS_pubmethodOnMessage(Action<BrokeredMessage^>^)

Processes a message in an event-driven message pump.

System_CAPS_pubmethodOnMessage(Action<BrokeredMessage^>^, OnMessageOptions^)

Processes a message in an event-driven message pump, with the given set of OnMessageOptions options.

System_CAPS_pubmethodOnMessageAsync(Func<BrokeredMessage^, Task^>^)

Asynchronously processes a message.

System_CAPS_pubmethodOnMessageAsync(Func<BrokeredMessage^, Task^>^, OnMessageOptions^)

Asynchronously processes a message.

System_CAPS_protmethodOnOpen(TimeSpan)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnOpened()

(Inherited from ClientEntity.)

System_CAPS_pubmethodPeek()

Returns without removing the first message in the queue.

System_CAPS_pubmethodPeek(Int64)

Returns without removing the first message in the queue.

System_CAPS_pubmethodPeekAsync()

Asynchronously returns without removing the first message in the queue.

System_CAPS_pubmethodPeekAsync(Int64)

Asynchronously returns without removing the first message in the queue.

System_CAPS_pubmethodPeekBatch(Int32)

Peeks a batch of messages.

System_CAPS_pubmethodPeekBatch(Int64, Int32)

Peeks a batch of messages.

System_CAPS_pubmethodPeekBatchAsync(Int32)

Asynchronously peeks a batch of message.

System_CAPS_pubmethodPeekBatchAsync(Int64, Int32)

Asynchronously peeks a batch of message.

System_CAPS_pubmethodReceive()
System_CAPS_pubmethodReceive(Int64)
System_CAPS_pubmethodReceive(TimeSpan)
System_CAPS_pubmethodReceiveAsync()

Asynchronously receives a message using the P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

System_CAPS_pubmethodReceiveAsync(Int64)

Asynchronously receives a message using the P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

System_CAPS_pubmethodReceiveAsync(TimeSpan)

Asynchronously receives a message using the P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

System_CAPS_pubmethodReceiveBatch(IEnumerable<Int64>^)

Receives a message batch.

System_CAPS_pubmethodReceiveBatch(Int32)

Receives a message batch.

System_CAPS_pubmethodReceiveBatch(Int32, TimeSpan)

Receives a message batch.

System_CAPS_pubmethodReceiveBatchAsync(IEnumerable<Int64>^)

Asynchronously receives a message batch.

System_CAPS_pubmethodReceiveBatchAsync(Int32)

Asynchronously receives a message batch.

System_CAPS_pubmethodReceiveBatchAsync(Int32, TimeSpan)

Asynchronously receives a message batch.

System_CAPS_pubmethodRegisterSessionHandler(Type^)

Registers the session handler with specific type.

System_CAPS_pubmethodRegisterSessionHandler(Type^, SessionHandlerOptions^)

Registers the session handler with specific type and handler options.

System_CAPS_pubmethodRegisterSessionHandlerAsync(Type^)

Asynchronously registers the session handler with specific type.

System_CAPS_pubmethodRegisterSessionHandlerAsync(Type^, SessionHandlerOptions^)

Asynchronously registers the session handler with specific type and handler options.

System_CAPS_pubmethodRegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory^, SessionHandlerOptions^)

Registers a message session handler factory with specified options.

System_CAPS_pubmethodRegisterSessionHandlerFactory(IMessageSessionHandlerFactory^, SessionHandlerOptions^)

Registers a message session handler factory with specified options.

System_CAPS_pubmethodRegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory^, SessionHandlerOptions^)

Asynchronously registers a message session handler factory.

System_CAPS_pubmethodRegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory^, SessionHandlerOptions^)

Asynchronously registers a message session handler factory.

System_CAPS_pubmethodRenewMessageLock(Guid)

System_CAPS_pubmethodRenewMessageLockAsync(Guid)

System_CAPS_pubmethodScheduleMessageAsync(BrokeredMessage^, DateTimeOffset)

Sends a scheduled message

System_CAPS_pubmethodSend(BrokeredMessage^)
System_CAPS_pubmethodSendAsync(BrokeredMessage^)

Asynchronously sends a message using the P:Microsoft.ServiceBus.Messaging.QueueClient.InternalSender.

System_CAPS_pubmethodSendBatch(IEnumerable<BrokeredMessage^>^)

Sends a set of brokered messages (for batch processing).

System_CAPS_pubmethodSendBatchAsync(IEnumerable<BrokeredMessage^>^)

Asynchronously sends a set of brokered messages (for batch processing).

System_CAPS_protmethodThrowIfClosed()

(Inherited from ClientEntity.)

System_CAPS_protmethodThrowIfDisposed()

(Inherited from ClientEntity.)

System_CAPS_protmethodThrowIfDisposedOrImmutable()

(Inherited from ClientEntity.)

System_CAPS_protmethodThrowIfDisposedOrNotOpen()

(Inherited from ClientEntity.)

System_CAPS_protmethodThrowIfFaulted()

(Inherited from ClientEntity.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: