DuplexClientBase<TChannel> DuplexClientBase<TChannel> DuplexClientBase<TChannel> DuplexClientBase<TChannel> Class

Definition

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

generic <typename TChannel>
 where TChannel : classpublic ref class DuplexClientBase : System::ServiceModel::ClientBase<TChannel>
public class DuplexClientBase<TChannel> : System.ServiceModel.ClientBase<TChannel> where TChannel : class
type DuplexClientBase<'Channel (requires 'Channel : null)> = class
    inherit ClientBase<'Channel (requires 'Channel : null)>
Public Class DuplexClientBase(Of TChannel)
Inherits ClientBase(Of TChannel)
Type Parameters
TChannel

The type of the channel to be created.

Inheritance
DuplexClientBase<TChannel>DuplexClientBase<TChannel>DuplexClientBase<TChannel>DuplexClientBase<TChannel>

Examples

The following example shows the use in the client of a duplex WCF 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();
    }
  }
}

Imports Microsoft.VisualBasic
Imports System
Imports System.ServiceModel
Imports System.ServiceModel.Channels
Imports System.Threading

Namespace Microsoft.WCF.Documentation
  <CallbackBehaviorAttribute(IncludeExceptionDetailInFaults:= True, UseSynchronizationContext:=True, ValidateMustUnderstand:=True)> _
  Public Class Client
	  Implements SampleDuplexHelloCallback
	Private waitHandle As AutoResetEvent

	Public Sub New()
	  waitHandle = New AutoResetEvent(False)
	End Sub

	Public Sub Run()
	  ' Picks up configuration from the configuration file.
	  Dim wcfClient As New SampleDuplexHelloClient(New InstanceContext(Me), "WSDualHttpBinding_SampleDuplexHello")
	  Try
		Console.ForegroundColor = ConsoleColor.White
		Console.WriteLine("Enter a greeting to send and press ENTER: ")
		Console.Write(">>> ")
		Console.ForegroundColor = ConsoleColor.Green
		Dim greeting As String = Console.ReadLine()
		Console.ForegroundColor = ConsoleColor.White
		Console.WriteLine("Called service with: " & Constants.vbCrLf & Constants.vbTab & greeting)
		wcfClient.Hello(greeting)
		Console.WriteLine("Execution passes service call and moves to the WaitHandle.")
		Me.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 timeProblem As TimeoutException
		Console.WriteLine("The service operation timed out. " & timeProblem.Message)
		Console.ReadLine()
	  Catch commProblem As CommunicationException
		Console.WriteLine("There was a communication problem. " & commProblem.Message)
		Console.ReadLine()
	  End Try
	End Sub
	Public Shared Sub Main()
	  Dim client As New Client()
	  client.Run()
	End Sub

	Public Sub Reply(ByVal response As String) Implements SampleDuplexHelloCallback.Reply
	  Console.WriteLine("Received output.")
	  Console.WriteLine(Constants.vbCrLf & Constants.vbTab & response)
	  Me.waitHandle.Set()
	End Sub
  End Class
End Namespace

Remarks

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

Constructors

DuplexClientBase<TChannel>(InstanceContext) DuplexClientBase<TChannel>(InstanceContext) DuplexClientBase<TChannel>(InstanceContext) DuplexClientBase<TChannel>(InstanceContext)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object.

DuplexClientBase<TChannel>(InstanceContext, Binding, EndpointAddress) DuplexClientBase<TChannel>(InstanceContext, Binding, EndpointAddress) DuplexClientBase<TChannel>(InstanceContext, Binding, EndpointAddress) DuplexClientBase<TChannel>(InstanceContext, Binding, EndpointAddress)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, binding, and service endpoint address.

DuplexClientBase<TChannel>(InstanceContext, ServiceEndpoint) DuplexClientBase<TChannel>(InstanceContext, ServiceEndpoint) DuplexClientBase<TChannel>(InstanceContext, ServiceEndpoint) DuplexClientBase<TChannel>(InstanceContext, ServiceEndpoint)

Initializes a new instance of the DuplexClientBase<TChannel> class with the specified callback object and service endpoint.

DuplexClientBase<TChannel>(InstanceContext, String) DuplexClientBase<TChannel>(InstanceContext, String) DuplexClientBase<TChannel>(InstanceContext, String) DuplexClientBase<TChannel>(InstanceContext, String)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object and configuration name.

DuplexClientBase<TChannel>(InstanceContext, String, EndpointAddress) DuplexClientBase<TChannel>(InstanceContext, String, EndpointAddress) DuplexClientBase<TChannel>(InstanceContext, String, EndpointAddress) DuplexClientBase<TChannel>(InstanceContext, String, EndpointAddress)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, configuration name, and service endpoint address.

DuplexClientBase<TChannel>(InstanceContext, String, String) DuplexClientBase<TChannel>(InstanceContext, String, String) DuplexClientBase<TChannel>(InstanceContext, String, String) DuplexClientBase<TChannel>(InstanceContext, String, String)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, configuration name, and service endpoint address.

DuplexClientBase<TChannel>(Object) DuplexClientBase<TChannel>(Object) DuplexClientBase<TChannel>(Object) DuplexClientBase<TChannel>(Object)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object.

DuplexClientBase<TChannel>(Object, Binding, EndpointAddress) DuplexClientBase<TChannel>(Object, Binding, EndpointAddress) DuplexClientBase<TChannel>(Object, Binding, EndpointAddress) DuplexClientBase<TChannel>(Object, Binding, EndpointAddress)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, binding, and service endpoint address.

DuplexClientBase<TChannel>(Object, ServiceEndpoint) DuplexClientBase<TChannel>(Object, ServiceEndpoint) DuplexClientBase<TChannel>(Object, ServiceEndpoint) DuplexClientBase<TChannel>(Object, ServiceEndpoint)

Initializes a new instance of the DuplexClientBase<TChannel> class with the specified callback object and service endpoint.

DuplexClientBase<TChannel>(Object, String) DuplexClientBase<TChannel>(Object, String) DuplexClientBase<TChannel>(Object, String) DuplexClientBase<TChannel>(Object, String)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object and configuration name.

DuplexClientBase<TChannel>(Object, String, EndpointAddress) DuplexClientBase<TChannel>(Object, String, EndpointAddress) DuplexClientBase<TChannel>(Object, String, EndpointAddress) DuplexClientBase<TChannel>(Object, String, EndpointAddress)

Initializes a new instance of the DuplexClientBase<TChannel> class using the specified callback object, configuration name, and service endpoint address.

DuplexClientBase<TChannel>(Object, String, String) DuplexClientBase<TChannel>(Object, String, String) DuplexClientBase<TChannel>(Object, String, String) DuplexClientBase<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.

Properties

Channel Channel Channel Channel

Gets the inner channel used to send messages to variously configured service endpoints.

(Inherited from ClientBase<TChannel>)
ChannelFactory ChannelFactory ChannelFactory ChannelFactory

Gets the underlying ChannelFactory<TChannel> object.

(Inherited from ClientBase<TChannel>)
ClientCredentials ClientCredentials ClientCredentials ClientCredentials

Gets the client credentials used to call an operation.

(Inherited from ClientBase<TChannel>)
Endpoint Endpoint Endpoint Endpoint

Gets the target endpoint for the service to which the WCF client can connect.

(Inherited from ClientBase<TChannel>)
InnerChannel InnerChannel InnerChannel InnerChannel

Gets the underlying IClientChannel implementation.

(Inherited from ClientBase<TChannel>)
InnerDuplexChannel InnerDuplexChannel InnerDuplexChannel InnerDuplexChannel

Gets the inner duplex channel.

State State State State

Gets the current state of the ClientBase<TChannel> object.

(Inherited from ClientBase<TChannel>)

Methods

Abort() Abort() Abort() Abort()

Causes the ClientBase<TChannel> object to transition immediately from its current state into the closed state.

(Inherited from ClientBase<TChannel>)
Close() Close() Close() Close()

Causes the ClientBase<TChannel> object to transition from its current state into the closed state.

(Inherited from ClientBase<TChannel>)
CreateChannel() CreateChannel() CreateChannel() CreateChannel()

Returns a channel to the service associated with the callback object passed to the constructor.

DisplayInitializationUI() DisplayInitializationUI() DisplayInitializationUI() DisplayInitializationUI()

Instructs the inner channel to display a user interface if one is required to initialize the channel prior to using it.

(Inherited from ClientBase<TChannel>)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetDefaultValueForInitialization<T>() GetDefaultValueForInitialization<T>() GetDefaultValueForInitialization<T>() GetDefaultValueForInitialization<T>()

Replicates the behavior of the default keyword in C#.

(Inherited from ClientBase<TChannel>)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
InvokeAsync(ClientBase<TChannel>, Object[], ClientBase<TChannel>, SendOrPostCallback, Object) InvokeAsync(ClientBase<TChannel>, Object[], ClientBase<TChannel>, SendOrPostCallback, Object) InvokeAsync(ClientBase<TChannel>, Object[], ClientBase<TChannel>, SendOrPostCallback, Object) InvokeAsync(ClientBase<TChannel>, Object[], ClientBase<TChannel>, SendOrPostCallback, Object)

Provides support for implementing the event-based asynchronous pattern. For more information about this pattern, see Event-based Asynchronous Pattern Overview.

(Inherited from ClientBase<TChannel>)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Open() Open() Open() Open()

Causes the ClientBase<TChannel> object to transition from the created state into the opened state.

(Inherited from ClientBase<TChannel>)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

ICommunicationObject.BeginClose(AsyncCallback, Object) ICommunicationObject.BeginClose(AsyncCallback, Object) ICommunicationObject.BeginClose(AsyncCallback, Object) ICommunicationObject.BeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close the ClientBase<TChannel>.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close the ClientBase<TChannel> with a specified timeout.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.BeginOpen(AsyncCallback, Object) ICommunicationObject.BeginOpen(AsyncCallback, Object) ICommunicationObject.BeginOpen(AsyncCallback, Object) ICommunicationObject.BeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open the ClientBase<TChannel> object.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open the ClientBase<TChannel> object within a specified interval of time.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.Close() ICommunicationObject.Close() ICommunicationObject.Close() ICommunicationObject.Close() Inherited from ClientBase<TChannel>
ICommunicationObject.Close(TimeSpan) ICommunicationObject.Close(TimeSpan) ICommunicationObject.Close(TimeSpan) ICommunicationObject.Close(TimeSpan)

Causes the ClientBase<TChannel> object to transition from its current state into the closed state.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.EndClose(IAsyncResult) ICommunicationObject.EndClose(IAsyncResult) ICommunicationObject.EndClose(IAsyncResult) ICommunicationObject.EndClose(IAsyncResult)

Completes an asynchronous operation to close the ClientBase<TChannel> object.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.EndOpen(IAsyncResult) ICommunicationObject.EndOpen(IAsyncResult) ICommunicationObject.EndOpen(IAsyncResult) ICommunicationObject.EndOpen(IAsyncResult)

Completes an asynchronous operation to open the ClientBase<TChannel> object.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.Open() ICommunicationObject.Open() ICommunicationObject.Open() ICommunicationObject.Open() Inherited from ClientBase<TChannel>
ICommunicationObject.Open(TimeSpan) ICommunicationObject.Open(TimeSpan) ICommunicationObject.Open(TimeSpan) ICommunicationObject.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>)
IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose()

Explicit implementation of the Dispose() method.

(Inherited from ClientBase<TChannel>)

Events

ICommunicationObject.Closed ICommunicationObject.Closed ICommunicationObject.Closed ICommunicationObject.Closed

The event handler that is invoked when the ClientBase<TChannel> object has transitioned from its current state to the closed state.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.Closing ICommunicationObject.Closing ICommunicationObject.Closing ICommunicationObject.Closing

The event handler that is invoked when the ClientBase<TChannel> object transitions from its current state to the closed state.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.Faulted ICommunicationObject.Faulted ICommunicationObject.Faulted ICommunicationObject.Faulted

The event handler that is invoked when a fault occurs while performing an operation on the ClientBase<TChannel> object.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.Opened ICommunicationObject.Opened ICommunicationObject.Opened ICommunicationObject.Opened

The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state.

(Inherited from ClientBase<TChannel>)
ICommunicationObject.Opening ICommunicationObject.Opening ICommunicationObject.Opening ICommunicationObject.Opening

The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state.

(Inherited from ClientBase<TChannel>)

Applies to