Export (0) Print
Expand All

DuplexClientBase<TChannel> Class

Used to create a channel to a duplex service and associate that channel with a callback object.

System.Object
  System.ServiceModel.ClientBase<TChannel>
    System.ServiceModel.DuplexClientBase<TChannel>

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

public abstract class DuplexClientBase<TChannel> : ClientBase<TChannel>
where TChannel : class

Type Parameters

TChannel

The type of the channel to be created.

The DuplexClientBase<TChannel> type exposes the following members.

  NameDescription
Protected methodDuplexClientBase<TChannel>(InstanceContext)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object.
Protected methodDuplexClientBase<TChannel>(Object)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object.
Protected methodDuplexClientBase<TChannel>(InstanceContext, ServiceEndpoint)Initializes a new instance of the DuplexClientBase<TChannel> class with the specified callback object and service endpoint.
Protected methodDuplexClientBase<TChannel>(InstanceContext, String)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object and configuration name.
Protected methodDuplexClientBase<TChannel>(Object, ServiceEndpoint)Initializes a new instance of the DuplexClientBase<TChannel> class with the specified callback object and service endpoint.
Protected methodDuplexClientBase<TChannel>(Object, String)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object and configuration name.
Protected methodDuplexClientBase<TChannel>(InstanceContext, Binding, EndpointAddress)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, binding, and service endpoint address.
Protected methodDuplexClientBase<TChannel>(InstanceContext, String, EndpointAddress)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, configuration name, and service endpoint address.
Protected methodDuplexClientBase<TChannel>(InstanceContext, String, String)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, configuration name, and service endpoint address.
Protected methodDuplexClientBase<TChannel>(Object, Binding, EndpointAddress)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, binding, and service endpoint address.
Protected methodDuplexClientBase<TChannel>(Object, String, EndpointAddress)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, configuration name, and service endpoint address.
Protected methodDuplexClientBase<TChannel>(Object, String, String)Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, endpoint configuration name, and service endpoint address.
Top

  NameDescription
Protected propertyChannelGets the inner channel used to to send messages to variously configured service endpoints. (Inherited from ClientBase<TChannel>.)
Public propertyChannelFactoryGets the underlying ChannelFactory<TChannel> object. (Inherited from ClientBase<TChannel>.)
Public propertyClientCredentialsGets the client credentials used to call an operation. (Inherited from ClientBase<TChannel>.)
Public propertyEndpointGets the target endpoint for the service to which the client can connect. (Inherited from ClientBase<TChannel>.)
Public propertyInnerChannelGets the underlying IClientChannel implementation. (Inherited from ClientBase<TChannel>.)
Public propertyInnerDuplexChannelGets the inner duplex channel.
Public propertyStateGets the current state of the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Top

  NameDescription
Public methodAbortCauses the ClientBase<TChannel> object to transition immediately from its current state into the closed state. (Inherited from ClientBase<TChannel>.)
Public methodCloseCauses the ClientBase<TChannel> object to transition from its current state into the closed state. (Inherited from ClientBase<TChannel>.)
Protected methodCreateChannelReturns a channel to the service associated with the callback object passed to the constructor. (Overrides ClientBase<TChannel>.CreateChannel().)
Public methodDisplayInitializationUIInstructs the inner channel to display a user interface if one is required to initialize the channel prior to using it. (Inherited from ClientBase<TChannel>.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetDefaultValueForInitialization<T>Replicates the behavior of the default keyword in C#. (Inherited from ClientBase<TChannel>.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInvokeAsyncProvides support for implementing the event-based asynchronous pattern. For more information about this pattern, see Event-based Asynchronous Pattern Overview. (Inherited from ClientBase<TChannel>.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOpenCauses the ClientBase<TChannel> object to transition from the created state into the opened state. (Inherited from ClientBase<TChannel>.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICommunicationObject.BeginClose(AsyncCallback, Object)Begins an asynchronous operation to close the ClientBase<TChannel>. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close the ClientBase<TChannel> with a specified timeout. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.BeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open the ClientBase<TChannel> object within a specified interval of time. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.Close(TimeSpan)Causes the ClientBase<TChannel> object to transition from its current state into the closed state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.ClosedThe event handler that is invoked when the ClientBase<TChannel> object has transitioned from its current state to the closed state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.ClosingThe event handler that is invoked when the ClientBase<TChannel> object transitions from its current state to the closed state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.EndCloseCompletes an asynchronous operation to close the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.EndOpenCompletes an asynchronous operation to open the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.FaultedThe event handler that is invoked when a fault occurs while performing an operation on the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodICommunicationObject.Open(TimeSpan)Causes the ClientBase<TChannel> object to transition from the created state into the opened state within a specified interval of time. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.OpenedThe event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate eventICommunicationObject.OpeningThe event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state. (Inherited from ClientBase<TChannel>.)
Explicit interface implemetationPrivate methodIDisposable.DisposeExplicit implementation of the Dispose method. (Inherited from ClientBase<TChannel>.)
Top

Use the DuplexClientBase<TChannel> class to create a channel to a service that specifies a callback object. The DuplexClientBase<TChannel> object wraps a System.ServiceModel.DuplexChannelFactory<TChannel> object, which provides the connectivity for the object. You can use either type to connect to a duplex service. For more information about duplex services, see Duplex Services.

Special note for Managed C++ users deriving from this class:

  • Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor.

  • Avoid destructors: they cause the compiler to auto-generate IDisposable

  • Avoid non-reference members: they can cause the compiler to auto-generate IDisposable

  • Avoid finalizers; but if you include one, you should suppress the build warning and call SuppressFinalize(Object) and the finalizer itself from (On)(Begin)Close (and/or OnAbort) in order to emulate what would have been the auto-generated IDisposable behavior.

The following example shows the use in the client of a duplex client type, the SampleDuplexHelloClient, to pass a new System.ServiceModel.InstanceContext object with the callback object to listen for callbacks.


using System;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.Threading;

namespace Microsoft.WCF.Documentation
{
  [CallbackBehaviorAttribute(
   IncludeExceptionDetailInFaults= true, 
    UseSynchronizationContext=true,
    ValidateMustUnderstand=true
  )]
  public class Client : SampleDuplexHelloCallback
  {
    AutoResetEvent waitHandle;

    public Client()
    {
      waitHandle = new AutoResetEvent(false);
    }

    public void Run()
    {
      // Picks up configuration from the configuration file.
      SampleDuplexHelloClient wcfClient
        = new SampleDuplexHelloClient(new InstanceContext(this), "WSDualHttpBinding_SampleDuplexHello");
      try
      {
        Console.ForegroundColor = ConsoleColor.White;
        Console.WriteLine("Enter a greeting to send and press ENTER: ");
        Console.Write(">>> ");
        Console.ForegroundColor = ConsoleColor.Green;
        string greeting = Console.ReadLine();
        Console.ForegroundColor = ConsoleColor.White;
        Console.WriteLine("Called service with: \r\n\t" + greeting);
        wcfClient.Hello(greeting);
        Console.WriteLine("Execution passes service call and moves to the WaitHandle.");
        this.waitHandle.WaitOne();
        Console.ForegroundColor = ConsoleColor.Blue;
        Console.WriteLine("Set was called.");
        Console.Write("Press ");
        Console.ForegroundColor = ConsoleColor.Red;
        Console.Write("ENTER");
        Console.ForegroundColor = ConsoleColor.Blue;
        Console.Write(" to exit...");
        Console.ReadLine();
      }
      catch (TimeoutException timeProblem)
      {
        Console.WriteLine("The service operation timed out. " + timeProblem.Message);
        Console.ReadLine();
      }
      catch (CommunicationException commProblem)
      {
        Console.WriteLine("There was a communication problem. " + commProblem.Message);
        Console.ReadLine();
      }
    }
    public static void Main()
    {
      Client client = new Client();
      client.Run();
    }

    public void Reply(string response)
    {
      Console.WriteLine("Received output.");
      Console.WriteLine("\r\n\t" + response);
      this.waitHandle.Set();
    }
  }
}


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft