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
Public propertySupported by Silverlight for Windows Phone 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.
Public propertySupported by Silverlight for Windows Phone 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.)
Public propertySupported by Silverlight for Windows Phone DidInteractiveInitialization Gets a value that indicates whether a call was done to a user interface to obtain credential information.
Public propertySupported by Silverlight for Windows Phone Extensions Gets a collection of extension objects for this extensible object. (Inherited from IExtensibleObject<T>.)
Public propertySupported by Silverlight for Windows Phone InputSession Gets the input session for the channel. (Inherited from IContextChannel.)
Public propertySupported by Silverlight for Windows Phone LocalAddress Gets the local endpoint for the channel. (Inherited from IContextChannel.)
Public propertySupported by Silverlight for Windows Phone OperationTimeout Gets or sets the time period within which an operation must complete or an exception is thrown. (Inherited from IContextChannel.)
Public propertySupported by Silverlight for Windows Phone OutputSession Gets the output session associated with the channel, if any. (Inherited from IContextChannel.)
Public propertySupported by Silverlight for Windows Phone RemoteAddress Gets the remote address associated with the channel. (Inherited from IContextChannel.)
Public propertySupported by Silverlight for Windows Phone SessionId Returns an identifier for the current session, if any. (Inherited from IContextChannel.)
Public propertySupported by Silverlight for Windows Phone State Gets the current state of the communication-oriented object. (Inherited from ICommunicationObject.)
Public propertySupported by Silverlight for Windows Phone Via Gets the URI that contains the transport address to which messages are sent on the client channel.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone Abort Causes a communication object to transition immediately from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object with a specified time-out. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone BeginDisplayInitializationUI An asynchronous call to begin using a user interface to obtain credential information.
Public methodSupported by Silverlight for Windows Phone BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone Close() Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone Close(TimeSpan) Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone DisplayInitializationUI A call to a user interface to obtain credential information.
Public methodSupported by Silverlight for Windows Phone Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodSupported by Silverlight for Windows Phone EndClose Completes an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone EndDisplayInitializationUI Called when the call to BeginDisplayInitializationUI has finished.
Public methodSupported by Silverlight for Windows Phone EndOpen Completes an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone GetProperty<T> Returns a typed object requested, if present, from the appropriate layer in the channel stack. (Inherited from IChannel.)
Public methodSupported by Silverlight for Windows Phone Open() Causes a communication object to transition from the created state into the opened state. (Inherited from ICommunicationObject.)
Public methodSupported by Silverlight for Windows Phone 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
Public eventSupported by Silverlight for Windows Phone Closed Occurs when the communication object completes its transition from the closing state into the closed state. (Inherited from ICommunicationObject.)
Public eventSupported by Silverlight for Windows Phone Closing Occurs when the communication object first enters the closing state. (Inherited from ICommunicationObject.)
Public eventSupported by Silverlight for Windows Phone Faulted Occurs when the communication object first enters the faulted state. (Inherited from ICommunicationObject.)
Public eventSupported by Silverlight for Windows Phone Opened Occurs when the communication object completes its transition from the opening state into the opened state. (Inherited from ICommunicationObject.)
Public eventSupported by Silverlight for Windows Phone Opening Occurs when the communication object first enters the opening state. (Inherited from ICommunicationObject.)
Public eventSupported by Silverlight for Windows Phone 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.

See Also

Reference