ChannelDispatcher Class

 

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

Namespace:   System.ServiceModel.Dispatcher
Assembly:  System.ServiceModel (in System.ServiceModel.dll)


public class ChannelDispatcher : ChannelDispatcherBase

NameDescription
System_CAPS_pubmethodChannelDispatcher(IChannelListener)

Initializes a new instance of the ChannelDispatcher class.

System_CAPS_pubmethodChannelDispatcher(IChannelListener, String)

Initializes a new instance of the ChannelDispatcher class.

System_CAPS_pubmethodChannelDispatcher(IChannelListener, String, IDefaultCommunicationTimeouts)

Initializes a new instance of the ChannelDispatcher class.

NameDescription
System_CAPS_pubpropertyAsynchronousTransactedAcceptEnabled

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

System_CAPS_pubpropertyBindingName

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

System_CAPS_pubpropertyChannelInitializers

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

System_CAPS_protpropertyDefaultCloseTimeout

Gets the default interval of time allowed for the channel dispatcher to close.(Overrides CommunicationObject.DefaultCloseTimeout.)

System_CAPS_protpropertyDefaultOpenTimeout

Gets the default interval of time allowed for the channel dispatcher to open.(Overrides CommunicationObject.DefaultOpenTimeout.)

System_CAPS_pubpropertyEndpoints

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

System_CAPS_pubpropertyErrorHandlers

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

System_CAPS_pubpropertyHost

Gets the host for the service associated with the dispatcher.(Overrides ChannelDispatcherBase.Host.)

System_CAPS_pubpropertyIncludeExceptionDetailInFaults

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

System_CAPS_protpropertyIsDisposed

Gets a value that indicates whether the communication object has been disposed.(Inherited from CommunicationObject.)

System_CAPS_pubpropertyIsTransactedAccept

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

System_CAPS_pubpropertyIsTransactedReceive

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

System_CAPS_pubpropertyListener

Gets the listener associated with the channel dispatcher.(Overrides ChannelDispatcherBase.Listener.)

System_CAPS_pubpropertyManualAddressing

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

System_CAPS_pubpropertyMaxPendingReceives

Gets or sets the maximum pending messages per channel.

System_CAPS_pubpropertyMaxTransactedBatchSize

Gets or sets the maximum size for a transacted batch.

System_CAPS_pubpropertyMessageVersion

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

System_CAPS_pubpropertyReceiveContextEnabled

Gets or sets whether ReceiveContext is enabled.

System_CAPS_pubpropertyReceiveSynchronously

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

System_CAPS_pubpropertySendAsynchronously

Gets or sets whether messages are sent asynchronously.

System_CAPS_pubpropertyServiceThrottle

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

System_CAPS_pubpropertyState

Gets a value that indicates the current state of the communication object.(Inherited from CommunicationObject.)

System_CAPS_protpropertyThisLock

Gets the mutually exclusive lock that protects the class instance during a state transition.(Inherited from CommunicationObject.)

System_CAPS_pubpropertyTransactionIsolationLevel

Gets or sets the default isolation level for transactions.

System_CAPS_pubpropertyTransactionTimeout

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

NameDescription
System_CAPS_pubmethodAbort()

Causes a communication object to transition immediately from its current state into the closing state.(Inherited from CommunicationObject.)

System_CAPS_protmethodAttach(ServiceHostBase)

Attaches the channel dispatcher to the host.(Overrides ChannelDispatcherBase.Attach(ServiceHostBase).)

System_CAPS_pubmethodBeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.(Inherited from CommunicationObject.)

System_CAPS_pubmethodClose()

Causes a communication object to transition from its current state into the closed state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodClose(TimeSpan)

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

System_CAPS_pubmethodCloseInput()

Stops the listener from accepting new channels.(Overrides ChannelDispatcherBase.CloseInput().)

System_CAPS_protmethodDetach(ServiceHostBase)

Detaches the service host from the channel dispatcher.(Overrides ChannelDispatcherBase.Detach(ServiceHostBase).)

System_CAPS_pubmethodEndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodEndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFault()

Causes a communication object to transition from its current state into the faulted state.(Inherited from CommunicationObject.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodGetCommunicationObjectType()

Gets the type of communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnAbort()

Aborts the listener associated with the dispatcher.(Overrides CommunicationObject.OnAbort().)

System_CAPS_protmethodOnBeginClose(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.(Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)

System_CAPS_protmethodOnBeginOpen(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.(Overrides CommunicationObject.OnBeginOpen(TimeSpan, AsyncCallback, Object).)

System_CAPS_protmethodOnClose(TimeSpan)

Closes the channel listener associated with the dispatcher within a specified interval of time.(Overrides CommunicationObject.OnClose(TimeSpan).)

System_CAPS_protmethodOnClosed()

Provides a trace of the closing of the endpoint dispatchers associated with the channel dispatcher.(Overrides CommunicationObject.OnClosed().)

System_CAPS_protmethodOnClosing()

Invoked during the transition of a communication object into the closing state.(Inherited from CommunicationObject.)

System_CAPS_protmethodOnEndClose(IAsyncResult)

Completes an asynchronous operation to close a channel listener for the dispatcher.(Overrides CommunicationObject.OnEndClose(IAsyncResult).)

System_CAPS_protmethodOnEndOpen(IAsyncResult)

Completes an asynchronous operation to open a channel listener for the dispatcher.(Overrides CommunicationObject.OnEndOpen(IAsyncResult).)

System_CAPS_protmethodOnFaulted()

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

System_CAPS_protmethodOnOpen(TimeSpan)

Opens the listener associated with the channel dispatcher.(Overrides CommunicationObject.OnOpen(TimeSpan).)

System_CAPS_protmethodOnOpened()

Populates and validates filter table used to dispatch to the endpoints.(Overrides CommunicationObject.OnOpened().)

System_CAPS_protmethodOnOpening()

Checks whether the channel dispatcher is attached to a host.(Overrides CommunicationObject.OnOpening().)

System_CAPS_pubmethodOpen()

Causes a communication object to transition from the created state into the opened state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodOpen(TimeSpan)

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

System_CAPS_protmethodThrowIfDisposed()

Throws an exception if the communication object is disposed.(Inherited from CommunicationObject.)

System_CAPS_protmethodThrowIfDisposedOrImmutable()

Throws an exception if the communication object the State property is not set to the Created state.(Inherited from CommunicationObject.)

System_CAPS_protmethodThrowIfDisposedOrNotOpen()

Throws an exception if the communication object is not in the Opened state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventClosed

Occurs when a communication object transitions into the closed state.(Inherited from CommunicationObject.)

System_CAPS_pubeventClosing

Occurs when a communication object transitions into the closing state.(Inherited from CommunicationObject.)

System_CAPS_pubeventFaulted

Occurs when a communication object transitions into the faulted state.(Inherited from CommunicationObject.)

System_CAPS_pubeventOpened

Occurs when a communication object transitions into the opened state.(Inherited from CommunicationObject.)

System_CAPS_pubeventOpening

Occurs when a communication object transitions into the opening state.(Inherited from CommunicationObject.)

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.

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

.NET Framework
Available since 3.0

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

Return to top
Show: