IClientChannel Interface
.NET Framework 4
Defines the behavior of outbound request and request/reply channels used by client applications.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
The IClientChannel type exposes the following members.
| Name | Description | |
|---|---|---|
|
AllowInitializationUI | Gets 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. |
|
|
AllowOutputBatching | Gets or sets a value that instructs to store a set of messages before giving the messages to the transport. (Inherited from IContextChannel.) |
|
|
DidInteractiveInitialization | Gets a value indicating whether a call was done to a user interface to obtain credential information. |
|
|
Extensions | Gets a collection of extension objects for this extensible object. (Inherited from IExtensibleObject<T>.) |
|
|
InputSession | Gets the input session for the channel. (Inherited from IContextChannel.) |
|
|
LocalAddress | Gets the local endpoint for the channel. (Inherited from IContextChannel.) |
|
|
OperationTimeout | Gets or sets the time period within which an operation must complete or an exception is thrown. (Inherited from IContextChannel.) |
|
|
OutputSession | Gets the output session associated with the channel, if any. (Inherited from IContextChannel.) |
|
|
RemoteAddress | Gets the remote address associated with the channel. (Inherited from IContextChannel.) |
|
|
SessionId | Returns an identifier for the current session, if any. (Inherited from IContextChannel.) |
|
|
State | Gets the current state of the communication-oriented object. (Inherited from ICommunicationObject.) |
|
|
Via | Gets the URI that contains the transport address to which messages are sent on the client channel. |
| Name | Description | |
|---|---|---|
|
Abort | Causes a communication object to transition immediately from its current state into the closed state. (Inherited from ICommunicationObject.) |
|
|
BeginClose(AsyncCallback, Object) | Begins an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.) |
|
|
BeginClose(TimeSpan, AsyncCallback, Object) | Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from ICommunicationObject.) |
|
|
BeginDisplayInitializationUI | An asynchronous call to begin using a user interface to obtain credential information. |
|
|
BeginOpen(AsyncCallback, Object) | Begins an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.) |
|
|
BeginOpen(TimeSpan, AsyncCallback, Object) | Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from ICommunicationObject.) |
|
|
Close() | Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.) |
|
|
Close(TimeSpan) | Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.) |
|
|
DisplayInitializationUI | A call to a user interface to obtain credential information. |
|
|
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
|
|
EndClose | Completes an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.) |
|
|
EndDisplayInitializationUI | Called when the call to BeginDisplayInitializationUI has finished. |
|
|
EndOpen | Completes an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.) |
|
|
GetProperty<T> | Returns a typed object requested, if present, from the appropriate layer in the channel stack. (Inherited from IChannel.) |
|
|
Open() | Causes a communication object to transition from the created state into the opened state. (Inherited from ICommunicationObject.) |
|
|
Open(TimeSpan) | Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from ICommunicationObject.) |
| Name | Description | |
|---|---|---|
|
Closed | Occurs when the communication object completes its transition from the closing state into the closed state. (Inherited from ICommunicationObject.) |
|
|
Closing | Occurs when the communication object first enters the closing state. (Inherited from ICommunicationObject.) |
|
|
Faulted | Occurs when the communication object first enters the faulted state. (Inherited from ICommunicationObject.) |
|
|
Opened | Occurs when the communication object completes its transition from the opening state into the opened state. (Inherited from ICommunicationObject.) |
|
|
Opening | Occurs when the communication object first enters the opening state. (Inherited from ICommunicationObject.) |
|
|
UnknownMessageReceived | This is a reserved event. |
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.
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.
