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 class IClientChannel : IContextChannel, IChannel, 
	ICommunicationObject, IExtensibleObject<IContextChannel^>, IDisposable

NameDescription
System_CAPS_pubpropertyAllowInitializationUI

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.

System_CAPS_pubpropertyAllowOutputBatching

Gets 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.)

System_CAPS_pubpropertyDidInteractiveInitialization

Gets a value indicating whether a call was done to a user interface to obtain credential information.

System_CAPS_pubpropertyExtensions

Gets a collection of extension objects for this extensible object.(Inherited from IExtensibleObject<T>.)

System_CAPS_pubpropertyInputSession

Gets the input session for the channel.(Inherited from IContextChannel.)

System_CAPS_pubpropertyLocalAddress

Gets the local endpoint for the channel.(Inherited from IContextChannel.)

System_CAPS_pubpropertyOperationTimeout

Gets or sets the time period within which an operation must complete or an exception is thrown.(Inherited from IContextChannel.)

System_CAPS_pubpropertyOutputSession

Gets the output session associated with the channel, if any.(Inherited from IContextChannel.)

System_CAPS_pubpropertyRemoteAddress

Gets the remote address associated with the channel.(Inherited from IContextChannel.)

System_CAPS_pubpropertySessionId

Returns an identifier for the current session, if any.(Inherited from IContextChannel.)

System_CAPS_pubpropertyState

Gets the current state of the communication-oriented object.(Inherited from ICommunicationObject.)

System_CAPS_pubpropertyVia

Gets the URI that contains the transport address to which messages are sent on the client channel.

NameDescription
System_CAPS_pubmethodAbort()

Causes a communication object to transition immediately from its current state into the closed state. (Inherited from ICommunicationObject.)

System_CAPS_pubmethodBeginClose(AsyncCallback^, Object^)

Begins an asynchronous operation to close a communication object.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodBeginClose(TimeSpan, AsyncCallback^, Object^)

Begins an asynchronous operation to close a communication object with a specified timeout.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodBeginDisplayInitializationUI(AsyncCallback^, Object^)

An asynchronous call to begin using a user interface to obtain credential information.

System_CAPS_pubmethodBeginOpen(AsyncCallback^, Object^)

Begins an asynchronous operation to open a communication object.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodBeginOpen(TimeSpan, AsyncCallback^, Object^)

Begins an asynchronous operation to open a communication object within a specified interval of time.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodClose()

Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)

System_CAPS_pubmethodClose(TimeSpan)

Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)

System_CAPS_pubmethodDisplayInitializationUI()

A call to a user interface to obtain credential information.

System_CAPS_pubmethodDispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from IDisposable.)

System_CAPS_pubmethodEndClose(IAsyncResult^)

Completes an asynchronous operation to close a communication object.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodEndDisplayInitializationUI(IAsyncResult^)

Called when the call to BeginDisplayInitializationUI has finished.

System_CAPS_pubmethodEndOpen(IAsyncResult^)

Completes an asynchronous operation to open a communication object.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodGetProperty<T>()

Returns a typed object requested, if present, from the appropriate layer in the channel stack.(Inherited from IChannel.)

System_CAPS_pubmethodOpen()

Causes a communication object to transition from the created state into the opened state. (Inherited from ICommunicationObject.)

System_CAPS_pubmethodOpen(TimeSpan)

Causes a communication object to transition from the created state into the opened state within a specified interval of time.(Inherited from ICommunicationObject.)

NameDescription
System_CAPS_pubeventClosed

Occurs when the communication object completes its transition from the closing state into the closed state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventClosing

Occurs when the communication object first enters the closing state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventFaulted

Occurs when the communication object first enters the faulted state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventOpened

Occurs when the communication object completes its transition from the opening state into the opened state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventOpening

Occurs when the communication object first enters the opening state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventUnknownMessageReceived

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 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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: