IClientChannel IClientChannel IClientChannel IClientChannel Interface

Definition

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

public interface class IClientChannel : IDisposable, System::ServiceModel::IContextChannel, System::ServiceModel::IExtensibleObject<System::ServiceModel::IContextChannel ^>
public interface IClientChannel : IDisposable, System.ServiceModel.IContextChannel, System.ServiceModel.IExtensibleObject<System.ServiceModel.IContextChannel>
type IClientChannel = interface
    interface IContextChannel
    interface ICommunicationObject
    interface IDisposable
    interface IChannel
    interface IExtensibleObject<IContextChannel>
Public Interface IClientChannel
Implements IContextChannel, IDisposable, IExtensibleObject(Of IContextChannel)
Derived
Implements

Remarks

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 WCF Client Architecture. For examples of its appearance in generated client code files, see Understanding Generated Client Code.

Properties

AllowInitializationUI AllowInitializationUI AllowInitializationUI AllowInitializationUI

Gets or sets a value indicating whether DisplayInitializationUI() attempts to call the IInteractiveChannelInitializer objects in the InteractiveChannelInitializers property or throws if that collection is not empty.

AllowOutputBatching AllowOutputBatching AllowOutputBatching AllowOutputBatching

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)
DidInteractiveInitialization DidInteractiveInitialization DidInteractiveInitialization DidInteractiveInitialization

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

Extensions Extensions Extensions Extensions

Gets a collection of extension objects for this extensible object.

(Inherited from IExtensibleObject<T>)
InputSession InputSession InputSession InputSession

Gets the input session for the channel.

(Inherited from IContextChannel)
LocalAddress LocalAddress LocalAddress LocalAddress

Gets the local endpoint for the channel.

(Inherited from IContextChannel)
OperationTimeout OperationTimeout OperationTimeout OperationTimeout

Gets or sets the time period within which an operation must complete or an exception is thrown.

(Inherited from IContextChannel)
OutputSession OutputSession OutputSession OutputSession

Gets the output session associated with the channel, if any.

(Inherited from IContextChannel)
RemoteAddress RemoteAddress RemoteAddress RemoteAddress

Gets the remote address associated with the channel.

(Inherited from IContextChannel)
SessionId SessionId SessionId SessionId

Returns an identifier for the current session, if any.

(Inherited from IContextChannel)
State State State State

Gets the current state of the communication-oriented object.

(Inherited from ICommunicationObject)
Via Via Via Via

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

Methods

Abort() Abort() Abort() Abort()

Causes a communication object to transition immediately from its current state into the closed state.

(Inherited from ICommunicationObject)
BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object) BeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.

(Inherited from ICommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object) BeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.

(Inherited from ICommunicationObject)
BeginDisplayInitializationUI(AsyncCallback, Object) BeginDisplayInitializationUI(AsyncCallback, Object) BeginDisplayInitializationUI(AsyncCallback, Object) BeginDisplayInitializationUI(AsyncCallback, Object)

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

BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object) BeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.

(Inherited from ICommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object) BeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.

(Inherited from ICommunicationObject)
Close() Close() Close() Close()

Causes a communication object to transition from its current state into the closed state.

(Inherited from ICommunicationObject)
Close(TimeSpan) Close(TimeSpan) Close(TimeSpan) Close(TimeSpan)

Causes a communication object to transition from its current state into the closed state.

(Inherited from ICommunicationObject)
DisplayInitializationUI() DisplayInitializationUI() DisplayInitializationUI() DisplayInitializationUI()

A call to a user interface to obtain credential information.

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from IDisposable)
EndClose(IAsyncResult) EndClose(IAsyncResult) EndClose(IAsyncResult) EndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.

(Inherited from ICommunicationObject)
EndDisplayInitializationUI(IAsyncResult) EndDisplayInitializationUI(IAsyncResult) EndDisplayInitializationUI(IAsyncResult) EndDisplayInitializationUI(IAsyncResult)

Called when the call to BeginDisplayInitializationUI(AsyncCallback, Object) has finished.

EndOpen(IAsyncResult) EndOpen(IAsyncResult) EndOpen(IAsyncResult) EndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.

(Inherited from ICommunicationObject)
GetProperty<T>() GetProperty<T>() GetProperty<T>() GetProperty<T>()

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

(Inherited from IChannel)
Open() Open() Open() Open()

Causes a communication object to transition from the created state into the opened state.

(Inherited from ICommunicationObject)
Open(TimeSpan) Open(TimeSpan) Open(TimeSpan) 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)

Events

Closed Closed Closed Closed

Occurs when the communication object completes its transition from the closing state into the closed state.

(Inherited from ICommunicationObject)
Closing Closing Closing Closing

Occurs when the communication object first enters the closing state.

(Inherited from ICommunicationObject)
Faulted Faulted Faulted Faulted

Occurs when the communication object first enters the faulted state.

(Inherited from ICommunicationObject)
Opened Opened Opened Opened

Occurs when the communication object completes its transition from the opening state into the opened state.

(Inherited from ICommunicationObject)
Opening Opening Opening Opening

Occurs when the communication object first enters the opening state.

(Inherited from ICommunicationObject)
UnknownMessageReceived UnknownMessageReceived UnknownMessageReceived UnknownMessageReceived

This is a reserved event.

Applies to