SALES: 1-800-867-1380

MessagingFactory Class

 

Represents a messaging factory. This is the anchor class used for run-time operations that send and receive messages to and from Service Bus queues, topics, or subscriptions.

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

System.Object
  Microsoft.ServiceBus.Messaging.ClientEntity
    Microsoft.ServiceBus.Messaging.MessagingFactory

Public MustInherit Class MessagingFactory
	Inherits ClientEntity

NameDescription
System_CAPS_pubpropertyAddress

Gets the base address of the messaging factory.

System_CAPS_pubpropertyIsClosed

(Inherited from ClientEntity.)

System_CAPS_pubpropertyNamespaceEndpoints

Gets a list of namespace endpoints.

System_CAPS_pubpropertyPrefetchCount

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

System_CAPS_pubpropertyRetryPolicy

(Inherited from ClientEntity.)

System_CAPS_protpropertyThisLock

(Inherited from ClientEntity.)

NameDescription
System_CAPS_pubmethodAbort()

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

System_CAPS_pubmethodAcceptMessageSession()

Returns available sessions across all session-enabled subscriptions and queues in the service namespace.

System_CAPS_pubmethodAcceptMessageSession(TimeSpan)

Returns available sessions across all session-enabled subscriptions and queues in the service namespace.

System_CAPS_pubmethodAcceptMessageSessionAsync()

Asynchronously returns available sessions across all session-enabled subscriptions and queues in the service namespace.

System_CAPS_pubmethodAcceptMessageSessionAsync(TimeSpan)

Asynchronously returns available sessions across all session-enabled subscriptions and queues in the service namespace.

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_pubmethodSystem_CAPS_staticCreate()

Creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(IEnumerable(Of String))

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(IEnumerable(Of String), MessagingFactorySettings)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(IEnumerable(Of String), TokenProvider)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(IEnumerable(Of Uri))

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(IEnumerable(Of Uri), MessagingFactorySettings)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(IEnumerable(Of Uri), TokenProvider)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(String)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(String, MessagingFactorySettings)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(String, TokenProvider)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Uri)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Uri, MessagingFactorySettings)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Uri, TokenProvider)

Creates a new MessagingFactory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(IEnumerable(Of String))

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(IEnumerable(Of String), MessagingFactorySettings)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(IEnumerable(Of String), TokenProvider)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(IEnumerable(Of Uri))

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(IEnumerable(Of Uri), MessagingFactorySettings)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(IEnumerable(Of Uri), TokenProvider)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(String)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(String, MessagingFactorySettings)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(String, TokenProvider)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(Uri)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(Uri, MessagingFactorySettings)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodSystem_CAPS_staticCreateAsync(Uri, TokenProvider)

Asynchronously creates a new messaging factory object.

System_CAPS_pubmethodCreateEventHubClient(String)

Creates a new EventHubClient object using the specified path.

System_CAPS_pubmethodSystem_CAPS_staticCreateFromConnectionString(String)

Creates a new MessagingFactory object from a connection string.

System_CAPS_pubmethodCreateMessageReceiver(String)

Creates a message receiver.

System_CAPS_pubmethodCreateMessageReceiver(String, ReceiveMode)

Creates a message receiver.

System_CAPS_pubmethodCreateMessageReceiverAsync(String)

Asynchronously creates a message receiver.

System_CAPS_pubmethodCreateMessageReceiverAsync(String, ReceiveMode)

Asynchronously creates a message receiver.

System_CAPS_pubmethodCreateMessageSender(String)

Creates a message sender.

System_CAPS_pubmethodCreateMessageSender(String, String)

Creates a message sender.

System_CAPS_pubmethodCreateMessageSenderAsync(String)

Asynchronously creates a message sender.

System_CAPS_pubmethodCreateMessageSenderAsync(String, String)

Asynchronously creates a message sender.

System_CAPS_pubmethodCreateQueueClient(String)

Creates a new queue client.

System_CAPS_pubmethodCreateQueueClient(String, ReceiveMode)

Creates a new queue client.

System_CAPS_pubmethodCreateSubscriptionClient(String, String)

Creates a subscription client.

System_CAPS_pubmethodCreateSubscriptionClient(String, String, ReceiveMode)

Creates a new subscription client.

System_CAPS_pubmethodCreateTopicClient(String)

Creates a new topic client.

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 Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetSettings()

Retrieves a copy of the settings of the messaging factory.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodIncrementConnectionResetCount(Uri)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnAbort()

Executes the abort action.(Overrides ClientEntity.OnAbort().)

System_CAPS_protmethodOnAcceptMessageSession(ReceiveMode, TimeSpan, TimeSpan)

Executes the accept message session.

System_CAPS_protmethodOnAcceptSessionReceiver(String, String, ReceiveMode, TimeSpan)

Executes the accept session receiver action.

System_CAPS_protmethodOnBeginAcceptMessageSession(ReceiveMode, TimeSpan, TimeSpan, AsyncCallback, Object)

Executes the begin accept message session action.

System_CAPS_protmethodOnBeginAcceptSessionReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)

Executes the begin accept session receiver action.

System_CAPS_protmethodOnBeginClose(TimeSpan, AsyncCallback, Object)

Executes the begin close action.(Overrides ClientEntity.OnBeginClose(TimeSpan, AsyncCallback, Object).)

System_CAPS_protmethodOnBeginCreateMessageReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object)

Executes the begin create message receiver action.

System_CAPS_protmethodOnBeginCreateMessageSender(String, String, TimeSpan, AsyncCallback, Object)

Executes the begin create message sender action.

System_CAPS_protmethodOnBeginCreateMessageSender(String, TimeSpan, AsyncCallback, Object)

Executes the begin create message sender action.

System_CAPS_protmethodOnBeginOpen(TimeSpan, AsyncCallback, Object)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnClose(TimeSpan)

Executes the close action.(Overrides ClientEntity.OnClose(TimeSpan).)

System_CAPS_protmethodOnClosed()

(Inherited from ClientEntity.)

System_CAPS_protmethodOnCreateEventHubClient(String)

Executes the create event hub client action.

System_CAPS_protmethodOnCreateMessageReceiver(String, ReceiveMode, TimeSpan)

Executes the create message receiver action.

System_CAPS_protmethodOnCreateMessageSender(String, String, TimeSpan)

Executes the create message sender action.

System_CAPS_protmethodOnCreateMessageSender(String, TimeSpan)

Executes the create message sender action.

System_CAPS_protmethodOnCreateQueueClient(String, ReceiveMode)

Executes the create queue client action.

System_CAPS_protmethodOnCreateSubscriptionClient(String, ReceiveMode)

Executes a create subscription client action.

System_CAPS_protmethodOnCreateSubscriptionClient(String, String, ReceiveMode)

Executes a create subscription client action.

System_CAPS_protmethodOnCreateTopicClient(String)

Executes the create topic client action.

System_CAPS_protmethodOnEndAcceptMessageSession(IAsyncResult)

Executes the end accept message session action.

System_CAPS_protmethodOnEndAcceptSessionReceiver(IAsyncResult)

Executes the end accept session receiver action.

System_CAPS_protmethodOnEndClose(IAsyncResult)

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

System_CAPS_protmethodOnEndCreateMessageReceiver(IAsyncResult)

Executes the end create message receiver action.

System_CAPS_protmethodOnEndCreateMessageSender(IAsyncResult)

Executes the end create message sender action.

System_CAPS_protmethodOnEndOpen(IAsyncResult)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnFaulted()

(Inherited from ClientEntity.)

System_CAPS_protmethodOnOpen(TimeSpan)

(Inherited from ClientEntity.)

System_CAPS_protmethodOnOpened()

(Inherited from ClientEntity.)

System_CAPS_pubmethodPairNamespaceAsync(PairedNamespaceOptions)

Asynchronously pairs a namespace.

System_CAPS_pubmethodResetConnection()

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.)

Please note that any CreateXXXClient method, such as CreateQueueClient, does not create a new entity in the service namespace. It only retrieves a handle to an existing entity created earlier using the NamespaceManager object. If these entities do not exist in the namespace, you will receive an exception.

Also note that settings are only applied through constructor calls, and cannot be modified later.

// Base address of namespace you are connecting to
string Address = "sb://myapp.WindowsAzure.com/"; 
MessagingFactorySettings MsgFactorySettings = new MessagingFactorySettings();
// Specify operating timeout (optional)
MessagingFactory MsgFactory = MessagingFactory.Create(Address, MsgFactorySettings);

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

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2016 Microsoft