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 LibrarySupported in .NET for Windows Store appsAllowInitializationUIGets 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 LibrarySupported in .NET for Windows Store appsAllowOutputBatchingGets or sets a value that instructs Windows Communication Foundation (WCF) to store a set of messages before giving the messages to the transport. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsDidInteractiveInitializationGets a value indicating whether a call was done to a user interface to obtain credential information.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsExtensionsGets a collection of extension objects for this extensible object. (Inherited from IExtensibleObject<T>.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsInputSessionGets the input session for the channel. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsLocalAddressGets the local endpoint for the channel. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsOperationTimeoutGets or sets the time period within which an operation must complete or an exception is thrown. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsOutputSessionGets the output session associated with the channel, if any. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsRemoteAddressGets the remote address associated with the channel. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsSessionIdReturns an identifier for the current session, if any. (Inherited from IContextChannel.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsStateGets the current state of the communication-oriented object. (Inherited from ICommunicationObject.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsViaGets the URI that contains the transport address to which messages are sent on the client channel.
Top

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsAbortCauses a communication object to transition immediately from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginDisplayInitializationUIAn asynchronous call to begin using a user interface to obtain credential information.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginOpen(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 LibrarySupported in .NET for Windows Store appsClose()Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsClose(TimeSpan)Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsDisplayInitializationUIA call to a user interface to obtain credential information.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndDisplayInitializationUICalled when the call to BeginDisplayInitializationUI has finished.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndOpenCompletes an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetProperty<T>Returns a typed object requested, if present, from the appropriate layer in the channel stack. (Inherited from IChannel.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpen()Causes a communication object to transition from the created state into the opened state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpen(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 LibrarySupported in .NET for Windows Store appsClosedOccurs when the communication object completes its transition from the closing state into the closed state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsClosingOccurs when the communication object first enters the closing state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsFaultedOccurs when the communication object first enters the faulted state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpenedOccurs when the communication object completes its transition from the opening state into the opened state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpeningOccurs when the communication object first enters the opening state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsUnknownMessageReceivedThis 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 ServiceModel 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.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft