DuplexChannelFactory<TChannel> Class

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Source:

DuplexChannelFactory.cs

Provides the means to create and manage duplex channels of different types that are used by clients to send and receive messages to and from service endpoints.

generic <typename TChannel>
public ref class DuplexChannelFactory : System::ServiceModel::ChannelFactory<TChannel>

public class DuplexChannelFactory<TChannel> : System.ServiceModel.ChannelFactory<TChannel>

type DuplexChannelFactory<'Channel> = class
    inherit ChannelFactory<'Channel>

Public Class DuplexChannelFactory(Of TChannel)
Inherits ChannelFactory(Of TChannel)

Type Parameters

TChannel

The type of channel produced by the channel factory.

Inheritance

Object

CommunicationObject

ChannelFactory

ChannelFactory<TChannel>

DuplexChannelFactory<TChannel>

Derived

System.ServiceModel.Configuration.ConfigurationDuplexChannelFactory<TChannel>

Examples

The following sample shows how to create a channel factory and use it to create and manage channels.

// Construct InstanceContext to handle messages on the callback interface.
// An instance of ChatApp is created and passed to the InstanceContext.
    InstanceContext site = new InstanceContext(new ChatApp());

// Create the participant with the given endpoint configuration.
// Each participant opens a duplex channel to the mesh.
// Participant is an instance of the chat application that has opened a channel to the mesh.

    using (DuplexChannelFactory<IChatChannel> cf =
        new DuplexChannelFactory<IChatChannel>(site,"ChatEndpoint"))
    {
        X509Certificate2 issuer = GetCertificate(
            StoreName.CertificateAuthority,
            StoreLocation.CurrentUser, "CN=" + issuerName,
            X509FindType.FindBySubjectDistinguishedName);
        cf.Credentials.Peer.Certificate =
            GetCertificate(StoreName.My,
            StoreLocation.CurrentUser,
            "CN=" + member,
            X509FindType.FindBySubjectDistinguishedName);
        cf.Credentials.Peer.PeerAuthentication.CertificateValidationMode  =
            X509CertificateValidationMode.Custom;
        cf.Credentials.Peer.PeerAuthentication.CustomCertificateValidator =
            new IssuerBasedValidator();

        using (IChatChannel participant = cf.CreateChannel())
        {
    // Retrieve the PeerNode associated with the participant and register for online/offline events.
    // PeerNode represents a node in the mesh. Mesh is the named collection of connected nodes.
            IOnlineStatus ostat = participant.GetProperty<IOnlineStatus>();
            ostat.Online += new EventHandler(OnOnline);
            ostat.Offline += new EventHandler(OnOffline);

            Console.WriteLine("{0} is ready", member);
            Console.WriteLine("Press <ENTER> to send the chat message.");

    // Announce self to other participants.
            participant.Join(member);
            Console.ReadLine();
            participant.Chat(member, "Hi there - I am chatting");

            Console.WriteLine("Press <ENTER> to terminate this instance of chat.");
            Console.ReadLine();
    // Leave the mesh and close the client.
            participant.Leave(member);
        }
    }

Remarks

A duplex channel allows clients and servers to communicate with each other independently so that either can initiate calls to the other. A duplex service can send messages to the client endpoint, providing event-like behavior. Duplex communication occurs when a client establishes a session with a service and provides the service with a channel on which the service can send messages back to the client. The various CreateChannel methods are used to create these duplex channels. The duplex message pattern is one of three message patterns available to Windows Communication Foundation (WCF) services. The other two message patterns are one-way and request-reply.

For a general discussion of duplex services that allow clients to connect back to the service, see Duplex Services. For an outline and discussion of the steps involved in writing a Windows Communication Foundation (WCF) client application using a channel factory, see How to: Use the ChannelFactory. For a procedure describing how to create a Windows Communication Foundation (WCF) client in a client class that implements the callback interface to access a service that uses a duplex messaging pattern, see How to: Access Services with a Duplex Contract.

Constructors

DuplexChannelFactory<TChannel>(InstanceContext, Binding)	Initializes a new instance of the DuplexChannelFactory<TChannel> class with a context that implements the callback contract and a specified binding.
DuplexChannelFactory<TChannel>(InstanceContext, Binding, EndpointAddress)	Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract and a specified binding and endpoint address.
DuplexChannelFactory<TChannel>(InstanceContext, Binding, String)	Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified instance context, binding, and remote address.
DuplexChannelFactory<TChannel>(Type)	Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance.
DuplexChannelFactory<TChannel>(Type, Binding)	Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance and binding.
DuplexChannelFactory<TChannel>(Type, Binding, EndpointAddress)	Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance, binding, and remote address.
DuplexChannelFactory<TChannel>(Type, Binding, String)	Initializes a new instance of the DuplexChannelFactory<TChannel> class with the specified type of callback instance, binding, and remote address.
DuplexChannelFactory<TChannel>(Type, ServiceEndpoint)	Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance and service endpoint.

Properties

Credentials	Gets the credentials used by clients to communicate a service endpoint over the channels produced by the factory. (Inherited from ChannelFactory)
DefaultCloseTimeout	Gets the default interval of time provided for a close operation to complete. (Inherited from ChannelFactory)
DefaultOpenTimeout	Gets the default interval of time provided for an open operation to complete. (Inherited from ChannelFactory)
Endpoint	Gets the service endpoint to which the channels produced by the factory connect. (Inherited from ChannelFactory)
IsDisposed	Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject)
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)

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject)
ApplyConfiguration(String)	Initializes the channel factory with the behaviors provided by a specified configuration file and with those in the service endpoint of the channel factory. (Inherited from ChannelFactory)
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)
CreateChannel()	Creates a channel of a specified type to a specified endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannel(EndpointAddress)	Creates a channel that is used to send messages to a service at a specific endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannel(EndpointAddress, Uri)	Creates a duplex channel between a service and a callback instance on the client.
CreateChannel(InstanceContext)	Creates a duplex channel between a service and a callback instance on the client.
CreateChannel(InstanceContext, EndpointAddress)	Creates a duplex channel between a service and a callback instance on the client.
CreateChannel(InstanceContext, EndpointAddress, Uri)	Creates a duplex channel between a service and a callback instance on the client.
CreateChannelWithActAsToken(SecurityToken)	Creates a channel that is used to send messages to a service with an act as security token. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithActAsToken(SecurityToken, EndpointAddress)	Creates a channel that is used to send messages to a service with an act as security token at a specific endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithActAsToken(SecurityToken, EndpointAddress, Uri)	Creates a channel that is used to send messages to a service with an act as security token at a specific endpoint address through a specified transport address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithIssuedToken(SecurityToken)	Creates a channel that is used to send messages to a service with an issued security token. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithIssuedToken(SecurityToken, EndpointAddress)	Creates a channel that is used to send messages to a service with an issued security token at a specific endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithIssuedToken(SecurityToken, EndpointAddress, Uri)	Creates a channel that is used to send messages to a service with an issued security token at a specific endpoint address through a specified transport address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithOnBehalfOfToken(SecurityToken)	Creates a channel that is used to send messages to a service with an on behalf of security token. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithOnBehalfOfToken(SecurityToken, EndpointAddress)	Creates a channel that is used to send messages to a service with an on behalf of security token at a specific endpoint address. (Inherited from ChannelFactory<TChannel>)
CreateChannelWithOnBehalfOfToken(SecurityToken, EndpointAddress, Uri)	Creates a channel that is used to send messages to a service with an on behalf of security token at a specific endpoint address through a specified transport address. (Inherited from ChannelFactory<TChannel>)
CreateDescription()	Creates a description of the service endpoint. (Inherited from ChannelFactory<TChannel>)
CreateFactory()	Builds the channel factory for the current endpoint of the factory. (Inherited from ChannelFactory)
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)
EnsureOpened()	Opens the current channel factory if it is not yet opened. (Inherited from ChannelFactory)
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)
GetProperty<T>()	Returns the typed object requested, if present, from the appropriate layer in the channel stack, or null if not present. (Inherited from ChannelFactory)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitializeEndpoint(Binding, EndpointAddress)	Initializes the service endpoint of the channel factory with a specified binding and address. (Inherited from ChannelFactory)
InitializeEndpoint(ServiceEndpoint)	Initializes the service endpoint of the channel factory with a specified endpoint. (Inherited from ChannelFactory)
InitializeEndpoint(String, EndpointAddress)	Initializes the service endpoint of the channel factory with a specified address and configuration. (Inherited from ChannelFactory)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Terminates the inner channel factory of the current channel factory. (Inherited from ChannelFactory)
OnBeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous close operation on the inner channel factory of the current channel factory that has a state object associated with it. (Inherited from ChannelFactory)
OnBeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous open operation on the inner channel factory of the current channel factory that has a state object associated with it. (Inherited from ChannelFactory)
OnClose(TimeSpan)	Calls close on the inner channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory)
OnClosed()	Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject)
OnClosing()	Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject)
OnEndClose(IAsyncResult)	Completes an asynchronous close operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory)
OnEndOpen(IAsyncResult)	Completes an asynchronous open operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory)
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)	Calls open on the inner channel factory of the current channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory)
OnOpened()	Initializes a read-only copy of the ClientCredentials object for the channel factory. (Inherited from ChannelFactory)
OnOpening()	Builds the inner channel factory for the current channel. (Inherited from ChannelFactory)
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)

Explicit Interface Implementations

IAsyncDisposable.DisposeAsync()	(Inherited from ChannelFactory)
IDisposable.Dispose()	Closes the current channel factory. (Inherited from ChannelFactory)

Extension Methods

ConfigureAwait(IAsyncDisposable, Boolean)

Configures how awaits on the tasks returned from an async disposable will be performed.