ClientBase<TChannel> Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides the base implementation used to create Silverlight 5 client objects (proxies) that can call services.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public MustInherit Class ClientBase(Of TChannel As Class) _
    Implements ICommunicationObject
public abstract class ClientBase<TChannel> : ICommunicationObject
where TChannel : class

Type Parameters

  • TChannel
    The channel used to connect to the service that identifies the type of service contract encapsulated by this proxy.

The ClientBase<TChannel> type exposes the following members.

Constructors

  Name Description
Protected methodSupported by Silverlight for Windows Phone ClientBase<TChannel>() Initializes a new instance of the ClientBase<TChannel> class using the default target endpoint from the application configuration file.
Protected methodSupported by Silverlight for Windows Phone ClientBase<TChannel>(String) Initializes a new instance of the ClientBase<TChannel> class using the configuration information specified in the application configuration file by endpointConfigurationName.
Protected methodSupported by Silverlight for Windows Phone ClientBase<TChannel>(Binding, EndpointAddress) Initializes a new instance of the ClientBase<TChannel> class using a specified binding and target address.
Protected methodSupported by Silverlight for Windows Phone ClientBase<TChannel>(String, EndpointAddress) Initializes a new instance of the ClientBase<TChannel> class using the specified target address and endpoint information.
Protected methodSupported by Silverlight for Windows Phone ClientBase<TChannel>(String, String) Initializes a new instance of the ClientBase<TChannel> class.

Top

Properties

  Name Description
Protected propertySupported by Silverlight for Windows Phone Channel Gets the inner channel used to communicate with the service.
Public propertySupported by Silverlight for Windows Phone ChannelFactory Gets the underlying ChannelFactory<TChannel> object.
Public propertySupported by Silverlight for Windows Phone ClientCredentials Gets the client credentials used to call an operation.
Public propertySupported by Silverlight for Windows Phone Endpoint Gets the target endpoint for the service to which the Silverlight 5 client can connect.
Public propertySupported by Silverlight for Windows Phone InnerChannel Gets the underlying IClientChannel implementation.
Public propertySupported by Silverlight for Windows Phone State Gets the current state of the ClientBase<TChannel> object.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone Abort Causes the ClientBase<TChannel> object to transition immediately from its current state into the closed state.
Protected methodSupported by Silverlight for Windows Phone CreateChannel Returns a new channel from the client to the service.
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone GetDefaultValueForInitialization<T> Replicates the behavior of the default keyword in C#.
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone InvokeAsync Provides support for implementing the event-based asynchronous pattern. For more information about
this pattern, see Event-based Asynchronous Pattern Overview.
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close the ClientBase<TChannel>.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close the ClientBase<TChannel> with a specified time-out.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to open the ClientBase<TChannel> object.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to open the ClientBase<TChannel> object within a specified interval of time.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.Close() Causes the ClientBase<TChannel> object to transition from its current state into the closed state.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.Close(TimeSpan) Causes the ClientBase<TChannel> object to transition from its current state into the closed state.
Explicit interface implemetationPrivate event ICommunicationObject.Closed The event handler that is invoked when the ClientBase<TChannel> object has transitioned from its current state to the closed state.
Explicit interface implemetationPrivate event ICommunicationObject.Closing The event handler that is invoked when the ClientBase<TChannel> object transitions from its current state to the closed state.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.EndClose Completes an asynchronous operation to close the ClientBase<TChannel> object.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.EndOpen Completes an asynchronous operation to open the ClientBase<TChannel> object.
Explicit interface implemetationPrivate event ICommunicationObject.Faulted The event handler that is invoked when a fault occurs while performing an operation on the ClientBase<TChannel> object.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.Open() Causes the ClientBase<TChannel> object to transition from the created state into the opened state.
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows Phone ICommunicationObject.Open(TimeSpan) Causes the ClientBase<TChannel> object to transition from the created state into the opened state within a specified interval of time.
Explicit interface implemetationPrivate event ICommunicationObject.Opened The event handler that is invoked when the ClientBase<TChannel> object has transitioned from the created state to the opened state.
Explicit interface implemetationPrivate event ICommunicationObject.Opening The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state.

Top

Remarks

Extend the ClientBase<TChannel> class to create a custom Silverlight 5 client object (proxy) that can be used to connect to a service.

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.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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