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

Syntax

Declaration

public abstract class MessagingFactory : ClientEntity, IMessageClientEntity, ICloseablePublic MustInherit Class MessagingFactory
    Inherits ClientEntity
    Implements IMessageClientEntity, ICloseable

Inheritance Hierarchy

Inherited Members

, , , , , ,
Abort()
Abort()
,
Abort()
Abort()
,
Close()
Close()
,
Close()
Close()
, , ,
Fault()
Fault()
,
Fault()
Fault()
, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Properties summary

Gets the base address of the messaging factory.

Gets a list of namespace endpoints.

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

Methods summary

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

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

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

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

Creates a new messaging factory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Creates a new MessagingFactory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Asynchronously creates a new messaging factory object.

Creates a new EventHubClient object using the specified path.

Creates a new MessagingFactory object from a connection string.

Creates a message receiver.

Creates a message receiver.

Asynchronously creates a message receiver.

Asynchronously creates a message receiver.

Creates a message sender.

Creates a message sender.

Asynchronously creates a message sender.

Asynchronously creates a message sender.

Creates a new queue client.

Creates a new queue client.

Creates a subscription client.

Creates a new subscription client.

Creates a new topic client.

Retrieves a copy of the settings of the messaging factory.

Executes the abort action.

Executes the accept message session.

Executes the accept session receiver action.

Executes the begin accept message session action.

Executes the begin accept session receiver action.

Executes the begin close action.

Executes the begin create message receiver action.

Executes the begin create message sender action.

Executes the begin create message sender action.

Executes the close action.

Executes the create event hub client action.

Executes the create message receiver action.

Executes the create message sender action.

Executes the create message sender action.

Executes the create queue client action.

Executes a create subscription client action.

Executes a create subscription client action.

Executes the create topic client action.

Executes the end accept message session action.

Executes the end accept session receiver action.

Executes the end close action.

Executes the end create message receiver action.

Executes the end create message sender action.

Asynchronously pairs a namespace.

Properties

  • Address
    Address

    Gets the base address of the messaging factory.

    public Uri Address { get; }Public ReadOnly Property Address As Uri

    Property Value

    • A URI that represents the base address of the messaging factory.

  • NamespaceEndpoints
    NamespaceEndpoints

    Gets a list of namespace endpoints.

    public IEnumerable<Uri> NamespaceEndpoints { get; }Public ReadOnly Property NamespaceEndpoints As IEnumerable(Of Uri)

    Property Value

  • PrefetchCount
    PrefetchCount

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

    public virtual int PrefetchCount { get; set; }Public Overridable Property PrefetchCount As Integer

    Property Value

    • The number of messages that the message receiver can simultaneously request.

Methods

  • AcceptMessageSession()
    AcceptMessageSession()

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

    public MessageSession AcceptMessageSession()Public Function AcceptMessageSession As MessageSession

    Returns

  • AcceptMessageSession(TimeSpan)
    AcceptMessageSession(TimeSpan)

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

    public MessageSession AcceptMessageSession(TimeSpan serverWaitTime)Public Function AcceptMessageSession(serverWaitTime As TimeSpan) As MessageSession

    Parameters

    Returns

  • AcceptMessageSessionAsync()
    AcceptMessageSessionAsync()

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

    public Task<MessageSession> AcceptMessageSessionAsync()Public Function AcceptMessageSessionAsync As Task(Of MessageSession)

    Returns

  • AcceptMessageSessionAsync(TimeSpan)
    AcceptMessageSessionAsync(TimeSpan)

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

    public Task<MessageSession> AcceptMessageSessionAsync(TimeSpan serverWaitTime)Public Function AcceptMessageSessionAsync(serverWaitTime As TimeSpan) As Task(Of MessageSession)

    Parameters

    Returns

  • Create()
    Create()

    Creates a new messaging factory object.

    public static MessagingFactory Create()Public Shared Function Create As MessagingFactory

    Returns

  • Create(IEnumerable<String>)
    Create(IEnumerable(Of String))

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(IEnumerable<string> addresses)Public Shared Function Create(addresses As IEnumerable(Of String)) As MessagingFactory

    Parameters

    Returns

  • Create(IEnumerable<String>, MessagingFactorySettings)
    Create(IEnumerable(Of String), MessagingFactorySettings)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(IEnumerable<string> addresses, MessagingFactorySettings factorySettings)Public Shared Function Create(addresses As IEnumerable(Of String), factorySettings As MessagingFactorySettings) As MessagingFactory

    Parameters

    Returns

  • Create(IEnumerable<String>, TokenProvider)
    Create(IEnumerable(Of String), TokenProvider)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(IEnumerable<string> addresses, TokenProvider tokenProvider)Public Shared Function Create(addresses As IEnumerable(Of String), tokenProvider As TokenProvider) As MessagingFactory

    Parameters

    Returns

  • Create(IEnumerable<Uri>)
    Create(IEnumerable(Of Uri))

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(IEnumerable<Uri> addresses)Public Shared Function Create(addresses As IEnumerable(Of Uri)) As MessagingFactory

    Parameters

    Returns

  • Create(IEnumerable<Uri>, MessagingFactorySettings)
    Create(IEnumerable(Of Uri), MessagingFactorySettings)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(IEnumerable<Uri> addresses, MessagingFactorySettings factorySettings)Public Shared Function Create(addresses As IEnumerable(Of Uri), factorySettings As MessagingFactorySettings) As MessagingFactory

    Parameters

    Returns

  • Create(IEnumerable<Uri>, TokenProvider)
    Create(IEnumerable(Of Uri), TokenProvider)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(IEnumerable<Uri> addresses, TokenProvider tokenProvider)Public Shared Function Create(addresses As IEnumerable(Of Uri), tokenProvider As TokenProvider) As MessagingFactory

    Parameters

    Returns

  • Create(String)
    Create(String)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(string address)Public Shared Function Create(address As String) As MessagingFactory

    Parameters

    • address

      The base address of the service namespace.

    Returns

  • Create(String, MessagingFactorySettings)
    Create(String, MessagingFactorySettings)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(string address, MessagingFactorySettings factorySettings)Public Shared Function Create(address As String, factorySettings As MessagingFactorySettings) As MessagingFactory

    Parameters

    Returns

    Exceptions

  • Create(String, TokenProvider)
    Create(String, TokenProvider)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(string address, TokenProvider tokenProvider)Public Shared Function Create(address As String, tokenProvider As TokenProvider) As MessagingFactory

    Parameters

    Returns

    Exceptions

  • Create(Uri)
    Create(Uri)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(Uri address)Public Shared Function Create(address As Uri) As MessagingFactory

    Parameters

    • address

      The namespace base address.

    Returns

  • Create(Uri, MessagingFactorySettings)
    Create(Uri, MessagingFactorySettings)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(Uri address, MessagingFactorySettings factorySettings)Public Shared Function Create(address As Uri, factorySettings As MessagingFactorySettings) As MessagingFactory

    Parameters

    Returns

    Exceptions

  • Create(Uri, TokenProvider)
    Create(Uri, TokenProvider)

    Creates a new MessagingFactory object.

    public static MessagingFactory Create(Uri address, TokenProvider tokenProvider)Public Shared Function Create(address As Uri, tokenProvider As TokenProvider) As MessagingFactory

    Parameters

    Returns

    Exceptions

  • CreateAsync(IEnumerable<String>)
    CreateAsync(IEnumerable(Of String))

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(IEnumerable<string> addresses)Public Shared Function CreateAsync(addresses As IEnumerable(Of String)) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(IEnumerable<String>, MessagingFactorySettings)
    CreateAsync(IEnumerable(Of String), MessagingFactorySettings)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(IEnumerable<string> addresses, MessagingFactorySettings factorySettings)Public Shared Function CreateAsync(addresses As IEnumerable(Of String), factorySettings As MessagingFactorySettings) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(IEnumerable<String>, TokenProvider)
    CreateAsync(IEnumerable(Of String), TokenProvider)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(IEnumerable<string> addresses, TokenProvider tokenProvider)Public Shared Function CreateAsync(addresses As IEnumerable(Of String), tokenProvider As TokenProvider) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(IEnumerable<Uri>)
    CreateAsync(IEnumerable(Of Uri))

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(IEnumerable<Uri> addresses)Public Shared Function CreateAsync(addresses As IEnumerable(Of Uri)) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(IEnumerable<Uri>, MessagingFactorySettings)
    CreateAsync(IEnumerable(Of Uri), MessagingFactorySettings)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(IEnumerable<Uri> addresses, MessagingFactorySettings factorySettings)Public Shared Function CreateAsync(addresses As IEnumerable(Of Uri), factorySettings As MessagingFactorySettings) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(IEnumerable<Uri>, TokenProvider)
    CreateAsync(IEnumerable(Of Uri), TokenProvider)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(IEnumerable<Uri> addresses, TokenProvider tokenProvider)Public Shared Function CreateAsync(addresses As IEnumerable(Of Uri), tokenProvider As TokenProvider) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(String)
    CreateAsync(String)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(string address)Public Shared Function CreateAsync(address As String) As Task(Of MessagingFactory)

    Parameters

    • address

      The base address of the service namespace.

    Returns

  • CreateAsync(String, MessagingFactorySettings)
    CreateAsync(String, MessagingFactorySettings)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(string address, MessagingFactorySettings factorySettings)Public Shared Function CreateAsync(address As String, factorySettings As MessagingFactorySettings) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(String, TokenProvider)
    CreateAsync(String, TokenProvider)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(string address, TokenProvider tokenProvider)Public Shared Function CreateAsync(address As String, tokenProvider As TokenProvider) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(Uri)
    CreateAsync(Uri)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(Uri address)Public Shared Function CreateAsync(address As Uri) As Task(Of MessagingFactory)

    Parameters

    • address

      The namespace base address.

    Returns

  • CreateAsync(Uri, MessagingFactorySettings)
    CreateAsync(Uri, MessagingFactorySettings)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(Uri address, MessagingFactorySettings factorySettings)Public Shared Function CreateAsync(address As Uri, factorySettings As MessagingFactorySettings) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateAsync(Uri, TokenProvider)
    CreateAsync(Uri, TokenProvider)

    Asynchronously creates a new messaging factory object.

    public static Task<MessagingFactory> CreateAsync(Uri address, TokenProvider tokenProvider)Public Shared Function CreateAsync(address As Uri, tokenProvider As TokenProvider) As Task(Of MessagingFactory)

    Parameters

    Returns

  • CreateEventHubClient(String)
    CreateEventHubClient(String)

    Creates a new EventHubClient object using the specified path.

    public EventHubClient CreateEventHubClient(string path)Public Function CreateEventHubClient(path As String) As EventHubClient

    Parameters

    Returns

    Exceptions

  • CreateFromConnectionString(String)
    CreateFromConnectionString(String)

    Creates a new MessagingFactory object from a connection string.

    public static MessagingFactory CreateFromConnectionString(string connectionString)Public Shared Function CreateFromConnectionString(connectionString As String) As MessagingFactory

    Parameters

    Returns

  • CreateMessageReceiver(String)
    CreateMessageReceiver(String)

    Creates a message receiver.

    public MessageReceiver CreateMessageReceiver(string entityPath)Public Function CreateMessageReceiver(entityPath As String) As MessageReceiver

    Parameters

    Returns

  • CreateMessageReceiver(String, ReceiveMode)
    CreateMessageReceiver(String, ReceiveMode)

    Creates a message receiver.

    public MessageReceiver CreateMessageReceiver(string entityPath, ReceiveMode receiveMode)Public Function CreateMessageReceiver(entityPath As String, receiveMode As ReceiveMode) As MessageReceiver

    Parameters

    Returns

  • CreateMessageReceiverAsync(String)
    CreateMessageReceiverAsync(String)

    Asynchronously creates a message receiver.

    public Task<MessageReceiver> CreateMessageReceiverAsync(string entityPath)Public Function CreateMessageReceiverAsync(entityPath As String) As Task(Of MessageReceiver)

    Parameters

    Returns

  • CreateMessageReceiverAsync(String, ReceiveMode)
    CreateMessageReceiverAsync(String, ReceiveMode)

    Asynchronously creates a message receiver.

    public Task<MessageReceiver> CreateMessageReceiverAsync(string entityPath, ReceiveMode receiveMode)Public Function CreateMessageReceiverAsync(entityPath As String, receiveMode As ReceiveMode) As Task(Of MessageReceiver)

    Parameters

    Returns

  • CreateMessageSender(String)
    CreateMessageSender(String)

    Creates a message sender.

    public MessageSender CreateMessageSender(string entityPath)Public Function CreateMessageSender(entityPath As String) As MessageSender

    Parameters

    Returns

  • CreateMessageSender(String, String)
    CreateMessageSender(String, String)

    Creates a message sender.

    public MessageSender CreateMessageSender(string transferDestinationEntityPath, string viaEntityPath)Public Function CreateMessageSender(transferDestinationEntityPath As String, viaEntityPath As String) As MessageSender

    Parameters

    • transferDestinationEntityPath

      The transfer destination entity path.

    • viaEntityPath

      The via-entity path.

    Returns

  • CreateMessageSenderAsync(String)
    CreateMessageSenderAsync(String)

    Asynchronously creates a message sender.

    public Task<MessageSender> CreateMessageSenderAsync(string entityPath)Public Function CreateMessageSenderAsync(entityPath As String) As Task(Of MessageSender)

    Parameters

    Returns

  • CreateMessageSenderAsync(String, String)
    CreateMessageSenderAsync(String, String)

    Asynchronously creates a message sender.

    public Task<MessageSender> CreateMessageSenderAsync(string transferDestinationEntityPath, string viaEntityPath)Public Function CreateMessageSenderAsync(transferDestinationEntityPath As String, viaEntityPath As String) As Task(Of MessageSender)

    Parameters

    • transferDestinationEntityPath

      The transfer destination entity path.

    • viaEntityPath

      The via-entity path.

    Returns

  • CreateQueueClient(String)
    CreateQueueClient(String)

    Creates a new queue client.

    public QueueClient CreateQueueClient(string path)Public Function CreateQueueClient(path As String) As QueueClient

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Returns

    Exceptions

  • CreateQueueClient(String, ReceiveMode)
    CreateQueueClient(String, ReceiveMode)

    Creates a new queue client.

    public QueueClient CreateQueueClient(string path, ReceiveMode receiveMode)Public Function CreateQueueClient(path As String, receiveMode As ReceiveMode) As QueueClient

    Parameters

    Returns

    Exceptions

  • CreateSubscriptionClient(String, String)
    CreateSubscriptionClient(String, String)

    Creates a subscription client.

    public SubscriptionClient CreateSubscriptionClient(string topicPath, string name)Public Function CreateSubscriptionClient(topicPath As String, name As String) As SubscriptionClient

    Parameters

    • topicPath

      The topic path relative to the service namespace.

    • name

      The name of the subscription.

    Returns

    Exceptions

  • CreateSubscriptionClient(String, String, ReceiveMode)
    CreateSubscriptionClient(String, String, ReceiveMode)

    Creates a new subscription client.

    public SubscriptionClient CreateSubscriptionClient(string topicPath, string name, ReceiveMode receiveMode)Public Function CreateSubscriptionClient(topicPath As String, name As String, receiveMode As ReceiveMode) As SubscriptionClient

    Parameters

    Returns

    Exceptions

  • CreateTopicClient(String)
    CreateTopicClient(String)

    Creates a new topic client.

    public TopicClient CreateTopicClient(string path)Public Function CreateTopicClient(path As String) As TopicClient

    Parameters

    • path

      The topic path relative to the service namespace base address.

    Returns

    Exceptions

  • GetSettings()
    GetSettings()

    Retrieves a copy of the settings of the messaging factory.

    public MessagingFactorySettings GetSettings()Public Function GetSettings As MessagingFactorySettings

    Returns

  • IncrementConnectionResetCount(Uri)
    IncrementConnectionResetCount(Uri)
    protected void IncrementConnectionResetCount(Uri endpoint)Protected Sub IncrementConnectionResetCount(endpoint As Uri)

    Parameters

  • OnAbort()
    OnAbort()

    Executes the abort action.

    protected override void OnAbort()Protected Overrides Sub OnAbort
  • OnAcceptMessageSession(ReceiveMode, TimeSpan, TimeSpan)
    OnAcceptMessageSession(ReceiveMode, TimeSpan, TimeSpan)

    Executes the accept message session.

    protected virtual MessageSession OnAcceptMessageSession(ReceiveMode receiveMode, TimeSpan serverWaitTime, TimeSpan timeout)Protected Overridable Function OnAcceptMessageSession(receiveMode As ReceiveMode, serverWaitTime As TimeSpan, timeout As TimeSpan) As MessageSession

    Parameters

    Returns

  • OnAcceptSessionReceiver(String, String, ReceiveMode, TimeSpan)
    OnAcceptSessionReceiver(String, String, ReceiveMode, TimeSpan)

    Executes the accept session receiver action.

    protected virtual MessageSession OnAcceptSessionReceiver(string entityName, string sessionId, ReceiveMode receiveMode, TimeSpan timeout)Protected Overridable Function OnAcceptSessionReceiver(entityName As String, sessionId As String, receiveMode As ReceiveMode, timeout As TimeSpan) As MessageSession

    Parameters

    Returns

  • OnBeginAcceptMessageSession(ReceiveMode, TimeSpan, TimeSpan, AsyncCallback, Object)
    OnBeginAcceptMessageSession(ReceiveMode, TimeSpan, TimeSpan, AsyncCallback, Object)

    Executes the begin accept message session action.

    protected abstract IAsyncResult OnBeginAcceptMessageSession(ReceiveMode receiveMode, TimeSpan serverWaitTime, TimeSpan timeout, AsyncCallback callback, object state)Protected MustOverride Function OnBeginAcceptMessageSession(receiveMode As ReceiveMode, serverWaitTime As TimeSpan, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    Returns

  • OnBeginAcceptSessionReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)
    OnBeginAcceptSessionReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)

    Executes the begin accept session receiver action.

    protected abstract IAsyncResult OnBeginAcceptSessionReceiver(string entityName, string sessionId, ReceiveMode receiveMode, TimeSpan timeout, AsyncCallback callback, object state)Protected MustOverride Function OnBeginAcceptSessionReceiver(entityName As String, sessionId As String, receiveMode As ReceiveMode, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    Returns

  • OnBeginClose(TimeSpan, AsyncCallback, Object)
    OnBeginClose(TimeSpan, AsyncCallback, Object)

    Executes the begin close action.

    protected override IAsyncResult OnBeginClose(TimeSpan timeout, AsyncCallback callback, object state)Protected Overrides Function OnBeginClose(timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    Returns

  • OnBeginCreateMessageReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object)
    OnBeginCreateMessageReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object)

    Executes the begin create message receiver action.

    protected abstract IAsyncResult OnBeginCreateMessageReceiver(string entityName, ReceiveMode receiveMode, TimeSpan timeout, AsyncCallback callback, object state)Protected MustOverride Function OnBeginCreateMessageReceiver(entityName As String, receiveMode As ReceiveMode, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    Returns

  • OnBeginCreateMessageSender(String, String, TimeSpan, AsyncCallback, Object)
    OnBeginCreateMessageSender(String, String, TimeSpan, AsyncCallback, Object)

    Executes the begin create message sender action.

    protected abstract IAsyncResult OnBeginCreateMessageSender(string transferDestinationEntityName, string viaEntityName, TimeSpan timeout, AsyncCallback callback, object state)Protected MustOverride Function OnBeginCreateMessageSender(transferDestinationEntityName As String, viaEntityName As String, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    Returns

  • OnBeginCreateMessageSender(String, TimeSpan, AsyncCallback, Object)
    OnBeginCreateMessageSender(String, TimeSpan, AsyncCallback, Object)

    Executes the begin create message sender action.

    protected virtual IAsyncResult OnBeginCreateMessageSender(string entityName, TimeSpan timeout, AsyncCallback callback, object state)Protected Overridable Function OnBeginCreateMessageSender(entityName As String, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    Returns

  • OnClose(TimeSpan)
    OnClose(TimeSpan)

    Executes the close action.

    protected override void OnClose(TimeSpan timeout)Protected Overrides Sub OnClose(timeout As TimeSpan)

    Parameters

  • OnCreateEventHubClient(String)
    OnCreateEventHubClient(String)

    Executes the create event hub client action.

    protected virtual EventHubClient OnCreateEventHubClient(string path)Protected Overridable Function OnCreateEventHubClient(path As String) As EventHubClient

    Parameters

    Returns

  • OnCreateMessageReceiver(String, ReceiveMode, TimeSpan)
    OnCreateMessageReceiver(String, ReceiveMode, TimeSpan)

    Executes the create message receiver action.

    protected virtual MessageReceiver OnCreateMessageReceiver(string entityName, ReceiveMode receiveMode, TimeSpan timeout)Protected Overridable Function OnCreateMessageReceiver(entityName As String, receiveMode As ReceiveMode, timeout As TimeSpan) As MessageReceiver

    Parameters

    Returns

  • OnCreateMessageSender(String, String, TimeSpan)
    OnCreateMessageSender(String, String, TimeSpan)

    Executes the create message sender action.

    protected virtual MessageSender OnCreateMessageSender(string transferDestinationEntityName, string viaEntityName, TimeSpan timeout)Protected Overridable Function OnCreateMessageSender(transferDestinationEntityName As String, viaEntityName As String, timeout As TimeSpan) As MessageSender

    Parameters

    Returns

  • OnCreateMessageSender(String, TimeSpan)
    OnCreateMessageSender(String, TimeSpan)

    Executes the create message sender action.

    protected virtual MessageSender OnCreateMessageSender(string entityName, TimeSpan timeout)Protected Overridable Function OnCreateMessageSender(entityName As String, timeout As TimeSpan) As MessageSender

    Parameters

    Returns

  • OnCreateQueueClient(String, ReceiveMode)
    OnCreateQueueClient(String, ReceiveMode)

    Executes the create queue client action.

    protected virtual QueueClient OnCreateQueueClient(string path, ReceiveMode receiveMode)Protected Overridable Function OnCreateQueueClient(path As String, receiveMode As ReceiveMode) As QueueClient

    Parameters

    Returns

  • OnCreateSubscriptionClient(String, ReceiveMode)
    OnCreateSubscriptionClient(String, ReceiveMode)

    Executes a create subscription client action.

    protected virtual SubscriptionClient OnCreateSubscriptionClient(string subscriptionPath, ReceiveMode receiveMode)Protected Overridable Function OnCreateSubscriptionClient(subscriptionPath As String, receiveMode As ReceiveMode) As SubscriptionClient

    Parameters

    Returns

  • OnCreateSubscriptionClient(String, String, ReceiveMode)
    OnCreateSubscriptionClient(String, String, ReceiveMode)

    Executes a create subscription client action.

    protected virtual SubscriptionClient OnCreateSubscriptionClient(string topicPath, string name, ReceiveMode receiveMode)Protected Overridable Function OnCreateSubscriptionClient(topicPath As String, name As String, receiveMode As ReceiveMode) As SubscriptionClient

    Parameters

    Returns

  • OnCreateTopicClient(String)
    OnCreateTopicClient(String)

    Executes the create topic client action.

    protected virtual TopicClient OnCreateTopicClient(string path)Protected Overridable Function OnCreateTopicClient(path As String) As TopicClient

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Returns

  • OnEndAcceptMessageSession(IAsyncResult)
    OnEndAcceptMessageSession(IAsyncResult)

    Executes the end accept message session action.

    protected abstract MessageSession OnEndAcceptMessageSession(IAsyncResult result)Protected MustOverride Function OnEndAcceptMessageSession(result As IAsyncResult) As MessageSession

    Parameters

    Returns

  • OnEndAcceptSessionReceiver(IAsyncResult)
    OnEndAcceptSessionReceiver(IAsyncResult)

    Executes the end accept session receiver action.

    protected abstract MessageSession OnEndAcceptSessionReceiver(IAsyncResult result)Protected MustOverride Function OnEndAcceptSessionReceiver(result As IAsyncResult) As MessageSession

    Parameters

    Returns

  • OnEndClose(IAsyncResult)
    OnEndClose(IAsyncResult)

    Executes the end close action.

    protected override void OnEndClose(IAsyncResult result)Protected Overrides Sub OnEndClose(result As IAsyncResult)

    Parameters

  • OnEndCreateMessageReceiver(IAsyncResult)
    OnEndCreateMessageReceiver(IAsyncResult)

    Executes the end create message receiver action.

    protected abstract MessageReceiver OnEndCreateMessageReceiver(IAsyncResult result)Protected MustOverride Function OnEndCreateMessageReceiver(result As IAsyncResult) As MessageReceiver

    Parameters

    Returns

  • OnEndCreateMessageSender(IAsyncResult)
    OnEndCreateMessageSender(IAsyncResult)

    Executes the end create message sender action.

    protected abstract MessageSender OnEndCreateMessageSender(IAsyncResult result)Protected MustOverride Function OnEndCreateMessageSender(result As IAsyncResult) As MessageSender

    Parameters

    Returns

  • PairNamespaceAsync(PairedNamespaceOptions)
    PairNamespaceAsync(PairedNamespaceOptions)

    Asynchronously pairs a namespace.

    public Task PairNamespaceAsync(PairedNamespaceOptions options)Public Function PairNamespaceAsync(options As PairedNamespaceOptions) As Task

    Parameters

    Returns

    • The result of the operation.

  • ResetConnection()
    ResetConnection()
    public virtual void ResetConnection()Public Overridable Sub ResetConnection

Details

Assembly

Microsoft.ServiceBus.dll