ClientBase<TChannel> Class

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Source:

ClientBase.cs

Provides the base implementation used to create Windows Communication Foundation (WCF) client objects that can call services.

generic <typename TChannel>
 where TChannel : classpublic ref class ClientBase abstract : IAsyncDisposable, IDisposable, System::ServiceModel::ICommunicationObject

public abstract class ClientBase<TChannel> : IAsyncDisposable, IDisposable, System.ServiceModel.ICommunicationObject where TChannel : class

type ClientBase<'Channel (requires 'Channel : null)> = class
    interface IDisposable
    interface ICommunicationObject
    interface IAsyncDisposable

Public MustInherit Class ClientBase(Of TChannel)
Implements IAsyncDisposable, ICommunicationObject, IDisposable

Type Parameters

TChannel

The channel to be used to connect to the service.

Inheritance

Object

ClientBase<TChannel>

Derived

System.ServiceModel.Activities.WorkflowControlClient

System.ServiceModel.Activities.WorkflowUpdateableControlClient

System.ServiceModel.DuplexClientBase<TChannel>

Implements

ICommunicationObject IAsyncDisposable IDisposable

Examples

The following code example shows how the ServiceModel Metadata Utility Tool (Svcutil.exe) extends the ClientBase<TChannel> class to create a WCF client class.

public partial class SampleServiceClient : System.ServiceModel.ClientBase<ISampleService>, ISampleService
{

    public SampleServiceClient()
    {
    }

    public SampleServiceClient(string endpointConfigurationName) :
            base(endpointConfigurationName)
    {
    }

    public SampleServiceClient(string endpointConfigurationName, string remoteAddress) :
            base(endpointConfigurationName, remoteAddress)
    {
    }

    public SampleServiceClient(string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress) :
            base(endpointConfigurationName, remoteAddress)
    {
    }

    public SampleServiceClient(System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress) :
            base(binding, remoteAddress)
    {
    }

    public string SampleMethod(string msg)
    {
        return base.Channel.SampleMethod(msg);
    }
}

<System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")> _
Partial Public Class SampleServiceClient
    Inherits System.ServiceModel.ClientBase(Of ISampleService)
    Implements ISampleService

    Public Sub New()
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String)
        MyBase.New(endpointConfigurationName)
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As String)
        MyBase.New(endpointConfigurationName, remoteAddress)
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String, _
                   ByVal remoteAddress As System.ServiceModel.EndpointAddress)
        MyBase.New(endpointConfigurationName, remoteAddress)
    End Sub

    Public Sub New(ByVal binding As System.ServiceModel.Channels.Binding, _
                   ByVal remoteAddress As System.ServiceModel.EndpointAddress)
        MyBase.New(binding, remoteAddress)
    End Sub

    Public Function SampleMethod(ByVal msg As String) As String Implements ISampleService.SampleMethod
        Return MyBase.Channel.SampleMethod(msg)
    End Function
End Class

Remarks

Extend the ClientBase<TChannel> class to create a custom WCF client object that can be used to connect to a service. Typically, the WCF client base class is extended by a tool such as the ServiceModel Metadata Utility Tool (Svcutil.exe) on your behalf. For an example, see the Example section.

The ClientBase<TChannel> class can be used quickly and easily by developers who prefer objects to the use of the interfaces and the System.ServiceModel.ChannelFactory<TChannel> class. In all cases this class wraps or exposes the methods and functionality of the System.ServiceModel.ChannelFactory<TChannel> class and the System.ServiceModel.IClientChannel interface.

As when using the System.ServiceModel.ServiceHost class, you can create the class and modify the endpoint, channel factory, or security information prior to making any calls or calling Open. For more information, see WCF Client Overview and Accessing Services Using a WCF Client.

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

• Put your clean-up 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) to emulate what would have been the auto-generated IDisposable behavior.

Constructors

ClientBase<TChannel>()	Initializes a new instance of the ClientBase<TChannel> class using the default target endpoint from the application configuration file.
ClientBase<TChannel>(Binding, EndpointAddress)	Initializes a new instance of the ClientBase<TChannel> class using the specified binding and target address.
ClientBase<TChannel>(ServiceEndpoint)	Initializes a new instance of the ClientBase<TChannel> class using the specified ServiceEndpoint.

Properties

CacheSetting	Gets or sets the cache setting.
Channel	Gets the inner channel used to send messages to variously configured service endpoints.
ChannelFactory	Gets the underlying ChannelFactory<TChannel> object.
ClientCredentials	Gets the client credentials used to call an operation.
Endpoint	Gets the target endpoint for the service to which the WCF client can connect.
InnerChannel	Gets the underlying IClientChannel implementation.
State	Gets the current state of the ClientBase<TChannel> object.

Methods

Abort()	Causes the ClientBase<TChannel> object to transition immediately from its current state into the closed state.
Close()	Causes the ClientBase<TChannel> object to transition from its current state into the closed state.
CloseAsync()
CreateChannel()	Returns a new channel to the service.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetDefaultValueForInitialization<T>()	Replicates the behavior of the default keyword in C#.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InvokeAsync(ClientBase<TChannel>.BeginOperationDelegate, Object[], ClientBase<TChannel>.EndOperationDelegate, SendOrPostCallback, Object)	Provides support for implementing the event-based asynchronous pattern. For more information about this pattern, see Event-based Asynchronous Pattern Overview.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Open()	Causes the ClientBase<TChannel> object to transition from the created state into the opened state.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IAsyncDisposable.DisposeAsync()
ICommunicationObject.BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close the ClientBase<TChannel>.
ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close the ClientBase<TChannel> with a specified timeout.
ICommunicationObject.BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open the ClientBase<TChannel> object.
ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open the ClientBase<TChannel> object within a specified interval of time.
ICommunicationObject.Close()	Causes a communication object to transition from its current state into the closed state.
ICommunicationObject.Close(TimeSpan)	Causes the ClientBase<TChannel> object to transition from its current state into the closed state.
ICommunicationObject.Closed	The event handler that is invoked when the ClientBase<TChannel> object has transitioned from its current state to the closed state.
ICommunicationObject.Closing	The event handler that is invoked when the ClientBase<TChannel> object transitions from its current state to the closed state.
ICommunicationObject.EndClose(IAsyncResult)	Completes an asynchronous operation to close the ClientBase<TChannel> object.
ICommunicationObject.EndOpen(IAsyncResult)	Completes an asynchronous operation to open the ClientBase<TChannel> object.
ICommunicationObject.Faulted	The event handler that is invoked when a fault occurs while performing an operation on the ClientBase<TChannel> object.
ICommunicationObject.Open()	Causes a communication object to transition from the created state into the opened state.
ICommunicationObject.Open(TimeSpan)	Causes the ClientBase<TChannel> object to transition from the created state into the opened state within a specified interval of time.
ICommunicationObject.Opened	The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state.
ICommunicationObject.Opening	The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state.
IDisposable.Dispose()	Explicit implementation of the Dispose() method.

Extension Methods

ConfigureAwait(IAsyncDisposable, Boolean)

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