Article
11/18/2011

IClientChannel Interface

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
Public Interface IClientChannel _
    Inherits IContextChannel, IChannel, ICommunicationObject, IExtensibleObject(Of IContextChannel),  _
    IDisposable

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

The IClientChannel type exposes the following members.

Properties

	Name	Description
	AllowInitializationUI	Gets or sets a value that indicates whether DisplayInitializationUI attempts to call the System.ServiceModel.Dispatcher.IInteractiveChannelInitializer objects in the ClientRuntime.InteractiveChannelInitializers property or throws and exception if that collection is not empty.
	AllowOutputBatching	Gets or sets a value that instructs Silverlight 5 to store a set of messages before giving the messages to the transport. (Inherited from IContextChannel.)
	DidInteractiveInitialization	Gets a value that indicates 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.

Top

Methods

	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 time-out. (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.)

Top

Events

	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.

Top

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.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Share via