ChannelDispatcher Class

Definition

A component that accepts channels and associates them with a service.

public ref class ChannelDispatcher : System::ServiceModel::Dispatcher::ChannelDispatcherBase
public class ChannelDispatcher : System.ServiceModel.Dispatcher.ChannelDispatcherBase
type ChannelDispatcher = class
    inherit ChannelDispatcherBase
Public Class ChannelDispatcher
Inherits ChannelDispatcherBase
Inheritance

Examples

Uri baseAddress = new Uri("http://localhost:8001/Simple");
ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress);

serviceHost.AddServiceEndpoint(
    typeof(ICalculator),
    new WSHttpBinding(),
    "CalculatorServiceObject");

// Enable MEX.
ServiceMetadataBehavior smb = new ServiceMetadataBehavior();
smb.HttpGetEnabled = true;
serviceHost.Description.Behaviors.Add(smb);

serviceHost.Open();        

IChannelListener icl = serviceHost.ChannelDispatchers[0].Listener;
ChannelDispatcher dispatcher = new ChannelDispatcher(icl);
Console.WriteLine("servicehost has {0} ChannelDispatchers", serviceHost.ChannelDispatchers.Count);
ChannelDispatcherCollection dispatchers = serviceHost.ChannelDispatchers;

foreach (ChannelDispatcher disp in dispatchers)
{
    Console.WriteLine("Binding name: " + disp.BindingName);
}

Console.WriteLine("The service is ready.");
Console.WriteLine("Press <ENTER> to terminate service.");
Console.WriteLine();
Console.ReadLine();

// Close the ServiceHostBase to shutdown the service.
serviceHost.Close();
Dim baseAddress As New Uri("http://localhost:8001/Simple")
Dim serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress)

serviceHost.AddServiceEndpoint(GetType(ICalculator), New WSHttpBinding(), "CalculatorServiceObject")

' Enable MEX.
Dim smb As New ServiceMetadataBehavior()
smb.HttpGetEnabled = True
serviceHost.Description.Behaviors.Add(smb)

serviceHost.Open()

Dim icl As IChannelListener = serviceHost.ChannelDispatchers(0).Listener
Dim dispatcher As New ChannelDispatcher(icl)
Console.WriteLine("servicehost has {0} ChannelDispatchers", serviceHost.ChannelDispatchers.Count)
Dim dispatchers As ChannelDispatcherCollection = serviceHost.ChannelDispatchers

For Each disp As ChannelDispatcher In dispatchers
    Console.WriteLine("Binding name: " & disp.BindingName)
Next disp

Console.WriteLine("The service is ready.")
Console.WriteLine("Press <ENTER> to terminate service.")
Console.WriteLine()
Console.ReadLine()

' Close the ServiceHostBase to shutdown the service.
serviceHost.Close()

Remarks

A ChannelDispatcher object associates an IChannelListener at a particular URI (called a listen URI) with an instance of a service. Each ServiceHost object can have many ChannelDispatcher objects, each associated with a different listener and listen URI for that service.

When a message arrives, the ChannelDispatcher queries each of the associated EndpointDispatcher objects whether the endpoint can accept the message, and passes the message to the one that can. The EndpointDispatcher object is responsible for processing messages from a ChannelDispatcher when the destination address of a message matches the AddressFilter property and the message action matches the ContractFilter property.

All properties that control the lifetime and behavior of a channel session are available for inspection or modification on the ChannelDispatcher object. In addition to the EndpointDispatcher, these include custom IChannelInitializer objects, the IChannelListener, the ServiceHost, the associated and InstanceContext.

Constructors

ChannelDispatcher(IChannelListener)

Initializes a new instance of the ChannelDispatcher class.

ChannelDispatcher(IChannelListener, String)

Initializes a new instance of the ChannelDispatcher class.

ChannelDispatcher(IChannelListener, String, IDefaultCommunicationTimeouts)

Initializes a new instance of the ChannelDispatcher class.

Properties

AsynchronousTransactedAcceptEnabled

Gets a value that indicates whether the transacted accept method calls on listener are asynchronous.

BindingName

Gets the name of the binding used to configure the service.

ChannelInitializers

Gets a set of IChannelInitializer objects that you can use to inspect and add state to channels when they are first created.

DefaultCloseTimeout

Gets the default interval of time allowed for the channel dispatcher to close.

DefaultOpenTimeout

Gets the default interval of time allowed for the channel dispatcher to open.

Endpoints

Gets the endpoint dispatchers which forward messages to the channel endpoints.

ErrorHandlers

Gets a set of IErrorHandler objects that can be used to insert custom error handling functionality for an endpoint.

Host

Gets the host for the service associated with the dispatcher.

IncludeExceptionDetailInFaults

Gets or sets a value that indicates whether to include the details about an exception in a fault.

IsDisposed

Gets a value that indicates whether the communication object has been disposed.

(Inherited from CommunicationObject)
IsTransactedAccept

Gets a value that indicates whether the accept method calls on the listener are done under a transaction.

IsTransactedReceive

Gets a value that indicates whether the receive method calls on the listener are done under a transaction.

Listener

Gets the listener associated with the channel dispatcher.

ManualAddressing

Gets or sets a value that indicates whether the channel dispatcher adds addressing headers to request-reply messages.

MaxPendingReceives

Gets or sets the maximum pending messages per channel.

MaxTransactedBatchSize

Gets or sets the maximum size for a transacted batch.

MessageVersion

Gets or sets the SOAP message and WS-Addressing versions that are used or expected.

ReceiveContextEnabled

Gets or sets whether ReceiveContext is enabled.

ReceiveSynchronously

Gets or sets a value that specifies whether the dispatcher uses synchronous calls to read messages from channels.

SendAsynchronously

Gets or sets whether messages are sent asynchronously.

ServiceThrottle

Gets or sets the service throttle for the service associated with the channel dispatcher.

State

Gets a value that indicates the current state of the communication object.

(Inherited from CommunicationObject)
ThisLock

Gets the mutually exclusive lock that protects the class instance during a state transition.

(Inherited from CommunicationObject)
TransactionIsolationLevel

Gets or sets the default isolation level for transactions.

TransactionTimeout

Gets or sets a value that specifies the default timeout for new transactions created by the dispatcher on behalf of the service.

Methods

Abort()

Causes a communication object to transition immediately from its current state into the closing state.

(Inherited from CommunicationObject)
Attach(ServiceHostBase)

Attaches the channel dispatcher to the host.

BeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.

(Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.

(Inherited from CommunicationObject)
BeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.

(Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.

(Inherited from CommunicationObject)
Close()

Causes a communication object to transition from its current state into the closed state.

(Inherited from CommunicationObject)
Close(TimeSpan)

Causes a communication object to transition from its current state into the closed state within a specified interval of time.

(Inherited from CommunicationObject)
CloseInput()

Stops the listener from accepting new channels.

Detach(ServiceHostBase)

Detaches the service host from the channel dispatcher.

EndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.

(Inherited from CommunicationObject)
EndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.

(Inherited from CommunicationObject)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Fault()

Causes a communication object to transition from its current state into the faulted state.

(Inherited from CommunicationObject)
GetCommunicationObjectType()

Gets the type of communication object.

(Inherited from CommunicationObject)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnAbort()

Aborts the listener associated with the dispatcher.

OnBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a channel listener for the dispatcher that must be completed within a specified interval of time.

OnBeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a channel listener for the dispatcher that must be completed within a specified interval of time.

OnClose(TimeSpan)

Closes the channel listener associated with the dispatcher within a specified interval of time.

OnClosed()

Provides a trace of the closing of the endpoint dispatchers associated with the channel dispatcher.

OnClosing()

Invoked during the transition of a communication object into the closing state.

(Inherited from CommunicationObject)
OnEndClose(IAsyncResult)

Completes an asynchronous operation to close a channel listener for the dispatcher.

OnEndOpen(IAsyncResult)

Completes an asynchronous operation to open a channel listener for the dispatcher.

OnFaulted()

Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation.

(Inherited from CommunicationObject)
OnOpen(TimeSpan)

Opens the listener associated with the channel dispatcher.

OnOpened()

Populates and validates filter table used to dispatch to the endpoints.

OnOpening()

Checks whether the channel dispatcher is attached to a host.

Open()

Causes a communication object to transition from the created state into the opened state.

(Inherited from CommunicationObject)
Open(TimeSpan)

Causes a communication object to transition from the created state into the opened state within a specified interval of time.

(Inherited from CommunicationObject)
ThrowIfDisposed()

Throws an exception if the communication object is disposed.

(Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable()

Throws an exception if the communication object the State property is not set to the Created state.

(Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen()

Throws an exception if the communication object is not in the Opened state.

(Inherited from CommunicationObject)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Events

Closed

Occurs when a communication object transitions into the closed state.

(Inherited from CommunicationObject)
Closing

Occurs when a communication object transitions into the closing state.

(Inherited from CommunicationObject)
Faulted

Occurs when a communication object transitions into the faulted state.

(Inherited from CommunicationObject)
Opened

Occurs when a communication object transitions into the opened state.

(Inherited from CommunicationObject)
Opening

Occurs when a communication object transitions into the opening state.

(Inherited from CommunicationObject)

Applies to