TopicClient Class

Definition

An anchor class used to access a TopicDescription to perform run-time operations.

public abstract class TopicClient : Microsoft.ServiceBus.Messaging.ClientEntity
Inheritance
TopicClient

Properties

IsSubQueue

Gets or sets a value that indicates whether the message receiver is created from a subqueue.

MessagingFactory

Gets or sets the messaging factory that was used in creating this TopicClient object.

Path

Gets or sets the full pathname of the file.

Methods

CancelScheduledMessageAsync(Int64)

Cancels a scheduled message

Create(String)

Creates a new instance of TopicClient.

CreateFromConnectionString(String)

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

CreateFromConnectionString(String, String)

Creates a new instance of TopicClient using the specified connection string and path to the topic. Use this overload only when the connection string does not use the EntityPath property.

FormatTransferDeadLetterPath(String)

A utility method that, given the topic path and subscription name, forms a full path that points to the dead letter queue of the topic's transfer topic.

OnAbort()

Executes the abort action.

OnBeginClose(TimeSpan, AsyncCallback, Object)

Executes the begin close action.

OnBeginCreateSender(TimeSpan, AsyncCallback, Object)

Executes the begin create sender action.

OnClose(TimeSpan)

Executes the close action.

OnEndClose(IAsyncResult)

Executes the end close action.

OnEndCreateSender(IAsyncResult)

Executes the end create sender action.

Peek()

Peeks a BrokeredMessage from current queue/topic.

Peek(Int64)

Peeks a BrokeredMessage from current queue/topic.

PeekAsync()
PeekAsync(Int64)
PeekBatch(Int32)

Peeks a BrokeredMessage from current queue/topic.

PeekBatch(Int64, Int32)
PeekBatchAsync(Int32)
PeekBatchAsync(Int64, Int32)
ScheduleMessageAsync(BrokeredMessage, DateTimeOffset)

Sends a scheduled message

Send(BrokeredMessage)

Sends a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalSender.

SendAsync(BrokeredMessage)

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

SendBatch(IEnumerable<BrokeredMessage>)

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

SendBatchAsync(IEnumerable<BrokeredMessage>)

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

Abort() Inherited from ClientEntity
Close() Inherited from ClientEntity
CloseAsync() Inherited from ClientEntity
Fault() Inherited from ClientEntity
IsClosed Inherited from ClientEntity
OnBeginOpen(TimeSpan, AsyncCallback, Object) Inherited from ClientEntity
OnClosed() Inherited from ClientEntity
OnEndOpen(IAsyncResult) Inherited from ClientEntity
OnFaulted() Inherited from ClientEntity
OnOpen(TimeSpan) Inherited from ClientEntity
OnOpened() Inherited from ClientEntity
RetryPolicy Inherited from ClientEntity
ThisLock Inherited from ClientEntity
ThrowIfClosed() Inherited from ClientEntity
ThrowIfDisposed() Inherited from ClientEntity
ThrowIfDisposedOrImmutable() Inherited from ClientEntity
ThrowIfDisposedOrNotOpen() Inherited from ClientEntity
ThrowIfFaulted() Inherited from ClientEntity

Extension Methods

IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to

See Also