Export (0) Print
Expand All

IClientChannel Interface

Defines the behavior of outbound request and request/reply channels used by client applications.

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

public interface IClientChannel : IContextChannel, 
	IChannel, ICommunicationObject, IExtensibleObject<IContextChannel>, IDisposable

The IClientChannel type exposes the following members.

  NameDescription
Public propertySupported by Portable Class LibraryAllowInitializationUIGets or sets a value indicating whether DisplayInitializationUI attempts to call the System.ServiceModel.Dispatcher.IInteractiveChannelInitializer objects in the ClientRuntime.InteractiveChannelInitializers property or throws if that collection is not empty.
Public propertySupported by Portable Class LibraryAllowOutputBatchingGets or sets a value that instructs to store a set of messages before giving the messages to the transport. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibraryDidInteractiveInitializationGets a value indicating whether a call was done to a user interface to obtain credential information.
Public propertySupported by Portable Class LibraryExtensionsGets a collection of extension objects for this extensible object. (Inherited from IExtensibleObject<T>.)
Public propertySupported by Portable Class LibraryInputSessionGets the input session for the channel. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibraryLocalAddressGets the local endpoint for the channel. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibraryOperationTimeoutGets or sets the time period within which an operation must complete or an exception is thrown. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibraryOutputSessionGets the output session associated with the channel, if any. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibraryRemoteAddressGets the remote address associated with the channel. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibrarySessionIdReturns an identifier for the current session, if any. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibraryStateGets the current state of the communication-oriented object. (Inherited from ICommunicationObject.)
Public propertySupported by Portable Class LibraryViaGets the URI that contains the transport address to which messages are sent on the client channel.
Top

  NameDescription
Public methodSupported by Portable Class LibraryAbortCauses a communication object to transition immediately from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryBeginDisplayInitializationUIAn asynchronous call to begin using a user interface to obtain credential information.
Public methodSupported by Portable Class LibraryBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryClose()Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryClose(TimeSpan)Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryDisplayInitializationUIA call to a user interface to obtain credential information.
Public methodSupported by Portable Class LibraryDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodSupported by Portable Class LibraryEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryEndDisplayInitializationUICalled when the call to BeginDisplayInitializationUI has finished.
Public methodSupported by Portable Class LibraryEndOpenCompletes an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryGetProperty<T>Returns a typed object requested, if present, from the appropriate layer in the channel stack. (Inherited from IChannel.)
Public methodSupported by Portable Class LibraryOpen()Causes a communication object to transition from the created state into the opened state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibraryOpen(TimeSpan)Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from ICommunicationObject.)
Top

  NameDescription
Public eventSupported by Portable Class LibraryClosedOccurs when the communication object completes its transition from the closing state into the closed state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibraryClosingOccurs when the communication object first enters the closing state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibraryFaultedOccurs when the communication object first enters the faulted state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibraryOpenedOccurs when the communication object completes its transition from the opening state into the opened state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibraryOpeningOccurs when the communication object first enters the opening state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibraryUnknownMessageReceivedThis is a reserved event.
Top

The IClientChannel interface defines the operations supported by all channels returned by a call to ChannelFactory<TChannel>.CreateChannel. Use the IClientChannel methods and properties to inspect and modify the outbound typed channel. The Service Metadata Utility Tool (Svcutil.exe) exports both a ClientBase<TChannel> class and a service contract interface by creating a contract interface that inherits from both the target service contract and IClientChannel, enabling you to use the extended contract as both the proxy to the service and to access the client channel.

For more information, see Client Architecture. For examples of its appearance in generated client code files, see Understanding Generated Client Code.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.

Community Additions

ADD
Show:
© 2014 Microsoft