DuplexChannelFactory(TChannel) Class (System.ServiceModel)

Switch View :
ScriptFree
.NET Framework Class Library
DuplexChannelFactory<TChannel> Class

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.

Inheritance Hierarchy

System.Object
  System.ServiceModel.Channels.CommunicationObject
    System.ServiceModel.ChannelFactory
      System.ServiceModel.ChannelFactory<TChannel>
        System.ServiceModel.DuplexChannelFactory<TChannel>
          System.ServiceModel.Configuration.ConfigurationDuplexChannelFactory<TChannel>

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

Visual Basic
Public Class DuplexChannelFactory(Of TChannel) _
	Inherits ChannelFactory(Of TChannel)
C#
public class DuplexChannelFactory<TChannel> : ChannelFactory<TChannel>

Visual C++
generic<typename TChannel>
public ref class DuplexChannelFactory : public ChannelFactory<TChannel>
F#
type DuplexChannelFactory<'TChannel> =  
    class
        inherit ChannelFactory<'TChannel>
    end

Type Parameters

TChannel

The type of channel produced by the channel factory.

The DuplexChannelFactory<TChannel> type exposes the following members.

Constructors

  Name Description
Public method DuplexChannelFactory<TChannel>(InstanceContext) Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified instance context.
Public method DuplexChannelFactory<TChannel>(Object) Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract.
Public method DuplexChannelFactory<TChannel>(Type) Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance.
Public method 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.
Public method DuplexChannelFactory<TChannel>(InstanceContext, ServiceEndpoint) Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract and a specified endpoint.
Public method DuplexChannelFactory<TChannel>(InstanceContext, String) Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract and a specified configuration.
Public method DuplexChannelFactory<TChannel>(Object, Binding) Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract and a specified binding.
Public method DuplexChannelFactory<TChannel>(Object, ServiceEndpoint) Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract and a specified endpoint.
Public method DuplexChannelFactory<TChannel>(Object, String) Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract and a specified configuration.
Public method DuplexChannelFactory<TChannel>(Type, Binding) Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance and binding.
Public method DuplexChannelFactory<TChannel>(Type, ServiceEndpoint) Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance and service endpoint.
Public method DuplexChannelFactory<TChannel>(Type, String) Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance and configuration.
Public method 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.
Public method DuplexChannelFactory<TChannel>(InstanceContext, Binding, String) Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified instance context, binding, and remote address.
Public method DuplexChannelFactory<TChannel>(InstanceContext, String, EndpointAddress) Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract and a specified configuration and endpoint address.
Public method DuplexChannelFactory<TChannel>(Object, 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.
Public method DuplexChannelFactory<TChannel>(Object, Binding, String) Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified callback object, binding, and remote address.
Public method DuplexChannelFactory<TChannel>(Object, String, EndpointAddress) Initializes a new instance of the DuplexChannelFactory<TChannel> class with an object that implements the callback contract, and a specified configuration and endpoint address.
Public method DuplexChannelFactory<TChannel>(Type, Binding, EndpointAddress) Initializes a new instance of the DuplexChannelFactory<TChannel> class with specified type of callback instance, binding, and remote address.
Public method 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.
Public method DuplexChannelFactory<TChannel>(Type, String, EndpointAddress) Initializes a new instance of the DuplexChannelFactory<TChannel> class with the specified type of callback instance, configuration, and remote address.
Top
Properties

  Name Description
Public property Credentials Gets the credentials used by clients to communicate a service endpoint over the channels produced by the factory. (Inherited from ChannelFactory.)
Protected property DefaultCloseTimeout Gets the default interval of time provided for a close operation to complete. (Inherited from ChannelFactory.)
Protected property DefaultOpenTimeout Gets the default interval of time provided for an open operation to complete. (Inherited from ChannelFactory.)
Public property Endpoint Gets the service endpoint to which the channels produced by the factory connect. (Inherited from ChannelFactory.)
Protected property IsDisposed Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public property State Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected property ThisLock Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top
Methods

  Name Description
Public method Abort Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Protected method ApplyConfiguration 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.)
Public method BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public method BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public method BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public method Close() Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public method 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.)
Public method CreateChannel() Creates a channel of a specified type to a specified endpoint address. (Inherited from ChannelFactory<TChannel>.)
Public method CreateChannel(EndpointAddress) Creates a channel that is used to send messages to a service at a specific endpoint address. (Inherited from ChannelFactory<TChannel>.)
Public method CreateChannel(InstanceContext) Creates a duplex channel between a service and a callback instance on the client.
Public method CreateChannel(EndpointAddress, Uri) Creates a duplex channel between a service and a callback instance on the client. (Overrides ChannelFactory<TChannel>.CreateChannel(EndpointAddress, Uri).)
Public method CreateChannel(InstanceContext, EndpointAddress) Creates a duplex channel between a service and a callback instance on the client.
Public method Static member CreateChannel(InstanceContext, String) Creates a duplex channel between a service and a callback instance on the client.
Public method Static member CreateChannel(Object, String) Creates a duplex channel between a service and a callback instance on the client.
Public method Static member CreateChannel(InstanceContext, Binding, EndpointAddress) Creates a duplex channel between a service and a callback instance on the client.
Public method CreateChannel(InstanceContext, EndpointAddress, Uri) Creates a duplex channel between a service and a callback instance on the client.
Public method Static member CreateChannel(Object, Binding, EndpointAddress) Creates a duplex channel between a service and a callback instance on the client.
Public method Static member CreateChannel(InstanceContext, Binding, EndpointAddress, Uri) Creates a duplex channel between a service and a callback instance on the client.
Public method Static member CreateChannel(Object, Binding, EndpointAddress, Uri) Creates a duplex channel between a service and a callback instance on the client.
Protected method CreateDescription Creates a description of the service endpoint. (Inherited from ChannelFactory<TChannel>.)
Protected method CreateFactory Builds the channel factory for the current endpoint of the factory. (Inherited from ChannelFactory.)
Public method EndClose Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method EndOpen Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Protected method EnsureOpened Opens the current channel factory if it is not yet opened. (Inherited from ChannelFactory.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Fault Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetCommunicationObjectType Gets the type of communication object. (Inherited from CommunicationObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method 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.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method InitializeEndpoint(ServiceEndpoint) Initializes the service endpoint of the channel factory with a specified endpoint. (Inherited from ChannelFactory.)
Protected method InitializeEndpoint(Binding, EndpointAddress) Initializes the service endpoint of the channel factory with a specified binding and address. (Inherited from ChannelFactory.)
Protected method InitializeEndpoint(String, EndpointAddress) Initializes the service endpoint of the channel factory with a specified address and configuration. (Inherited from ChannelFactory.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnAbort Terminates the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected method OnBeginClose 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.)
Protected method OnBeginOpen 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.)
Protected method OnClose Calls close on the inner channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory.)
Protected method OnClosed Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method OnClosing Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method OnEndClose Completes an asynchronous close operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected method OnEndOpen Completes an asynchronous open operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected method 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.)
Protected method OnOpen 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.)
Protected method OnOpened Initializes a read-only copy of the ClientCredentials object for the channel factory. (Inherited from ChannelFactory.)
Protected method OnOpening Builds the inner channel factory for the current channel. (Inherited from ChannelFactory.)
Public method Open() Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public method 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.)
Protected method ThrowIfDisposed Throws an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrImmutable Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrNotOpen Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Events

  Name Description
Public event Closed Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public event Closing Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public event Faulted Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public event Opened Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public event Opening Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Top
Explicit Interface Implementations

  Name Description
Explicit interface implemetation Private method IDisposable.Dispose Closes the current channel factory. (Inherited from ChannelFactory.)
Top
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 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 client application using a channel factory, see How to: Use the ChannelFactory. For a procedure describing how to create a 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.

Examples

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

C#

	    // 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);
				}
			}


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety

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

Reference