Class NetMessagingTransportBindingElement

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll

Represents the binding element used to specify a net messaging transport for transmitting messages on the Service Bus.

public sealed class NetMessagingTransportBindingElement : TransportBindingElement, IPolicyExportExtension, IWsdlExportExtension

Inheritance

object

NetMessagingTransportBindingElement

Implements

IPolicyExportExtension

IWsdlExportExtension

Remarks

The NetMessagingTransportBindingElement supports creating IOutputChannel, IInputChannel, IInputChannel+ReceiveContext, IInputSessionChannel, and IInputSessionChannel+ReceiveContext. The session-aware channels (IInputSessionChannel, IInputSessionChannel+ReceiveContext) are for session support.

Constructors

NetMessagingTransportBindingElement()

Initializes a new instance of the NetMessagingTransportBindingElement class.

public NetMessagingTransportBindingElement()

Properties

PrefetchCount

Gets or sets the number of prefetch.

public int PrefetchCount { get; set; }

Property Value

int

The number of prefetch.

Remarks

Takes effect on the next receive call to the server

Scheme

Gets the URI scheme for the transport.

public override string Scheme { get; }

Property Value

string

The URI scheme for the transport.

SessionIdleTimeout

Gets or sets the timespan value that specifies period of inactivity that the session waits before timing out.

public TimeSpan SessionIdleTimeout { get; set; }

Property Value

TimeSpan

The timespan value. The default value is 1 minute.

TransportSettings

Gets or sets the transport settings for the net messaging.

public NetMessagingTransportSettings TransportSettings { get; set; }

Property Value

NetMessagingTransportSettings

The transport settings for the net messaging.

Methods

BuildChannelFactory<TChannel>(BindingContext)

Builds a channel factory.

public override IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)

Parameters

context BindingContext

The binding context.

Returns

IChannelFactory<TChannel>

The interface implemented by the channel factory.

Type Parameters

TChannel

Type of the channel.

Exceptions

ArgumentException

Thrown when TChannel isn't a supported channel type

ArgumentNullException

Thrown when context is null.

BuildChannelListener<TChannel>(BindingContext)

Builds a channel listener.

public override IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context) where TChannel : class, IChannel

Parameters

context BindingContext

The binding context.

Returns

IChannelListener<TChannel>

A implemented IChannelListener interface.

Type Parameters

TChannel

Type of the channel.

Remarks

Channel listeners and their associated channels are generally used by services that receive communications initiated by clients. Channel factories that implement the IChannelFactory interface, by contrast, provide the mechanisms used to create the channels through which communication with a service is initiated.

Exceptions

ArgumentNullException

Thrown when context is null.

ArgumentException

Thrown when TChannel isn't a supported channel type

CanBuildChannelFactory<T>(BindingContext)

Queries the channel factory can build 'context'.

public override bool CanBuildChannelFactory<T>(BindingContext context)

Parameters

context BindingContext

The binding context.

Returns

bool

Returns a value that indicates whether the binding element can build a channel factory for a specific type of channel.

Type Parameters

T

Type of the channel.

Exceptions

ArgumentNullException

Thrown when argument null.

CanBuildChannelListener<T>(BindingContext)

Queries if we can build channel listener 'context'.

public override bool CanBuildChannelListener<T>(BindingContext context) where T : class, IChannel

Parameters

context BindingContext

The binding context.

Returns

bool

Returns a value that indicates whether the binding element can build a channel listener for a specific type of channel.

Type Parameters

T

Generic type parameter.

Exceptions

ArgumentNullException

Thrown when argument null.

Clone()

Makes a deep copy of this binding element.

public override BindingElement Clone()

Returns

BindingElement

A copy of this binding element.

GetProperty<T>(BindingContext)

Gets a specific binding element property.

public override T GetProperty<T>(BindingContext context) where T : class

Parameters

context BindingContext

The binding context.

Returns

T

The property T

Type Parameters

T

Generic type parameter.

Exceptions

ArgumentNullException

Thrown when argument null.