ClientChannel Class (.NET)

This is a Library topic for RemObjects SDK for .NET
This page is generated from external data, please do not update

Namespaces — Interfaces — Classes — Enums — Implements

Overview

The ClientChannel abstract component serves as a base class for implementing a custom RemObjects SDK Transport Channel component by providing a common base-implementation of the IClientChannel. Though a Transport Channel component will typically descend from ClientChannel, this is not required, but all Transport Channels must implement IClientChannel.

Location

• Assembly: RemObjects.SDK.dll
• Namespace: RemObjects.SDK
• Ancestry: System.ComponentModel.Component | Channel | ClientChannel | Descendants

Implemented interfaces

• IClientChannel

Constants

URL_SCHEMES_NOT_SUPPORTED   protected
Oxygene:   const URL_SCHEMES_NOT_SUPPORTED: String C#:   const String URL_SCHEMES_NOT_SUPPORTED VB:   Dim URL_SCHEMES_NOT_SUPPORTED As String

Properties

Busy
Busy is true if the transport channel is currently busy with an operation. Otherwise Busy is false. By default, if the transport channel is busy, it will not attempt to process another request and a ChannelBusyException exception is raised if you try to do so. Prism:   property Busy: Boolean read C#:   Boolean Busy { get; } VB:   Property ReadOnly Busy As Boolean
HasAfterReceiveStream   protected     (declared in Channel)
Prism:   property HasAfterReceiveStream: Boolean read C#:   Boolean HasAfterReceiveStream { get; } VB:   Property ReadOnly HasAfterReceiveStream As Boolean
HasBeforeSendStream   protected     (declared in Channel)
Prism:   property HasBeforeSendStream: Boolean read C#:   Boolean HasBeforeSendStream { get; } VB:   Property ReadOnly HasBeforeSendStream As Boolean
HasOnTransferProgress   protected
Prism:   property HasOnTransferProgress: Boolean read C#:   Boolean HasOnTransferProgress { get; } VB:   Property ReadOnly HasOnTransferProgress As Boolean
TargetUri
Prism:   property TargetUri: Uri read write C#:   Uri TargetUri { get; set; } VB:   Property TargetUri As Uri
TargetUrl
Prism:   property TargetUrl: String read write C#:   String TargetUrl { get; set; } VB:   Property TargetUrl As String

Class Methods

BuildTargetUri   protected
Oxygene:   class method BuildTargetUri(protocol: String; host: String; port: Int32; message: String): Uri C#:   static Uri BuildTargetUri(String protocol, String host, Int32 port, String message) VB:   Shared Function BuildTargetUri(protocol As String, host As String, port As Int32, message As String) As Uri Parameters: protocol: host: port: message:
ChannelMatchingTargetUri (String): IClientChannel
Oxygene:   class method ChannelMatchingTargetUri(url: String): IClientChannel C#:   static IClientChannel ChannelMatchingTargetUri(String url) VB:   Shared Function ChannelMatchingTargetUri(url As String) As IClientChannel Parameters: url:
ChannelMatchingTargetUri (Uri): IClientChannel
Oxygene:   class method ChannelMatchingTargetUri(uri: Uri): IClientChannel C#:   static IClientChannel ChannelMatchingTargetUri(Uri uri) VB:   Shared Function ChannelMatchingTargetUri(uri As Uri) As IClientChannel Parameters: uri:

Instance Methods

constructor   protected
Creates a new instance of the ClientChannel class. Oxygene:   constructor C#:   constructor() VB:   Sub New
AsyncDispatch
Oxygene:   method AsyncDispatch(message: IMessage; callback: AsyncCallback; userData: Object): IClientAsyncResult C#:   IClientAsyncResult AsyncDispatch(IMessage message, AsyncCallback callback, Object userData) VB:   Function AsyncDispatch(message As IMessage, callback As AsyncCallback, userData As Object) As IClientAsyncResult Parameters: message: callback: userData:
BeforeDispatch   protected
Oxygene:   method BeforeDispatch(message: IMessage) C#:   void BeforeDispatch(IMessage message) VB:   Sub BeforeDispatch(message As IMessage) Parameters: message:
BeginDispatch (IMessage, AsyncCallback, Boolean, Object): IClientAsyncResult   protected
Oxygene:   method BeginDispatch(message: IMessage; callback: AsyncCallback; disposeChannel: Boolean; userData: Object): IClientAsyncResult C#:   IClientAsyncResult BeginDispatch(IMessage message, AsyncCallback callback, Boolean disposeChannel, Object userData) VB:   Function BeginDispatch(message As IMessage, callback As AsyncCallback, disposeChannel As Boolean, userData As Object) As IClientAsyncResult Parameters: message: callback: disposeChannel: userData:
BeginDispatch (IMessage, AsyncCallback, Object): IClientAsyncResult
Oxygene:   method BeginDispatch(message: IMessage; callback: AsyncCallback; userData: Object): IClientAsyncResult C#:   IClientAsyncResult BeginDispatch(IMessage message, AsyncCallback callback, Object userData) VB:   Function BeginDispatch(message As IMessage, callback As AsyncCallback, userData As Object) As IClientAsyncResult Parameters: message: callback: userData:
CheckChannelBusy   protected
Oxygene:   method CheckChannelBusy C#:   void CheckChannelBusy() VB:   Sub CheckChannelBusy
Clone
Oxygene:   method Clone: Object C#:   Object Clone() VB:   Function Clone As Object
CopyProperties (Channel)   protected     (declared in Channel)
Oxygene:   method CopyProperties(source: Channel) C#:   void CopyProperties(Channel source) VB:   Sub CopyProperties(source As Channel) Parameters: source:
CopyProperties (ClientChannel)   protected
Oxygene:   method CopyProperties(source: ClientChannel) C#:   void CopyProperties(ClientChannel source) VB:   Sub CopyProperties(source As ClientChannel) Parameters: source:
Dispatch
The implementation of IClientChannel.Dispatch. This method ensures the transport is not busy before calling IntDispatch and passing the given IMessage. If the transport is busy, a ChannelBusyException is thrown. Oxygene:   method Dispatch(message: IMessage) C#:   void Dispatch(IMessage message) VB:   Sub Dispatch(message As IMessage) Parameters: message:
EndDispatch
Oxygene:   method EndDispatch(ar: IAsyncResult): IMessage C#:   IMessage EndDispatch(IAsyncResult ar) VB:   Function EndDispatch(ar As IAsyncResult) As IMessage Parameters: ar:
IntDispatch   protected
Oxygene:   method IntDispatch(request: Stream; response: IMessage) C#:   void IntDispatch(Stream request, IMessage response) VB:   Sub IntDispatch(request As Stream, response As IMessage) Parameters: request: response:
TriggerAfterReceiveStream   protected     (declared in Channel)
Oxygene:   method TriggerAfterReceiveStream(var stream: Stream) C#:   void TriggerAfterReceiveStream(ref Stream stream) VB:   Sub TriggerAfterReceiveStream(ByRef stream As Stream) Parameters: stream:
TriggerBeforeSendStream   protected     (declared in Channel)
Oxygene:   method TriggerBeforeSendStream(var stream: Stream) C#:   void TriggerBeforeSendStream(ref Stream stream) VB:   Sub TriggerBeforeSendStream(ByRef stream As Stream) Parameters: stream:
TriggerOnException   protected
Oxygene:   method TriggerOnException(exception: Exception; out handled: Boolean) C#:   void TriggerOnException(Exception exception, out Boolean handled) VB:   Sub TriggerOnException(exception As Exception, <OutAttribute> ByRef handled As Boolean) Parameters: exception: handled:
TriggerOnLoginNeeded   protected
Oxygene:   method TriggerOnLoginNeeded(exception: Exception; out loginSuccessful: Boolean) C#:   void TriggerOnLoginNeeded(Exception exception, out Boolean loginSuccessful) VB:   Sub TriggerOnLoginNeeded(exception As Exception, <OutAttribute> ByRef loginSuccessful As Boolean) Parameters: exception: loginSuccessful:
TriggerOnTransferEnd   protected
Oxygene:   method TriggerOnTransferEnd(direction: TransferDirection) C#:   void TriggerOnTransferEnd(TransferDirection direction) VB:   Sub TriggerOnTransferEnd(direction As TransferDirection) Parameters: direction:
TriggerOnTransferProgress   protected
Oxygene:   method TriggerOnTransferProgress(direction: TransferDirection; current: Int64) C#:   void TriggerOnTransferProgress(TransferDirection direction, Int64 current) VB:   Sub TriggerOnTransferProgress(direction As TransferDirection, current As Int64) Parameters: direction: current:
TriggerOnTransferStart   protected
Oxygene:   method TriggerOnTransferStart(direction: TransferDirection; total: Int64) C#:   void TriggerOnTransferStart(TransferDirection direction, Int64 total) VB:   Sub TriggerOnTransferStart(direction As TransferDirection, total As Int64) Parameters: direction: total:

Events

AfterReceiveStream     (declared in Channel)
This event is triggered by client and server channels directly after a request or response stream has been received and before the stream gets parsed into a message. User code can assign handlers to this event to process, inspect or modify incoming messages, before they get handled by the RemObjects SDK framework. The passed Stream is a MemoryStream and may be modified. If no handlers are assigned to the AfterReceiveStream event, the message will load the data directly from the incoming medium (usually the network stream); assigning event handlers to AfterReceiveStream will induce a slight overhead as the data will first be copied into a local memory buffer for the event handler. This should not have any noticeably effect except for very large messages or on resource-limited systems such as Compact Framework Clients, but if utmost performance is important, take this note into consideration. Oxygene:   event AfterReceiveStream: StreamEventHandler delegate: method Invoke(sender: Object; e: StreamEventArgs) C#:   event StreamEventHandler AfterReceiveStream delegate: void Invoke(Object sender, StreamEventArgs e) VB:   Event AfterReceiveStream As StreamEventHandler delegate: Sub Invoke(sender As Object, e As StreamEventArgs)
BeforeSendStream     (declared in Channel)
This event is triggered by client and server channels directly before a request or response stream will be sent over the network. User code can assign handlers to this event to process, inspect or modify incoming messages before they get sent out to the remote system. The passed Stream is a MemoryStream and may be modified. Oxygene:   event BeforeSendStream: StreamEventHandler delegate: method Invoke(sender: Object; e: StreamEventArgs) C#:   event StreamEventHandler BeforeSendStream delegate: void Invoke(Object sender, StreamEventArgs e) VB:   Event BeforeSendStream As StreamEventHandler delegate: Sub Invoke(sender As Object, e As StreamEventArgs)
OnException
This event is raised if an exception occurs during the execution of a remote request through the channel. The event will be raised both for exceptions originating from the server and for exceptions during communication (such as unavailability of the server). Attach a handler to this event to do custom handling of events without having to reply on explicit try/catch blocks in the calling code. This event will not be raised for SessionNotFoundExceptions. These will be handled separately by the OnLoginNeeded event. Oxygene:   event OnException: RequestExceptionEventHandler delegate: method Invoke(sender: Object; e: RequestExceptionEventArgs) C#:   event RequestExceptionEventHandler OnException delegate: void Invoke(Object sender, RequestExceptionEventArgs e) VB:   Event OnException As RequestExceptionEventHandler delegate: Sub Invoke(sender As Object, e As RequestExceptionEventArgs)
OnLoginNeeded
This event is raised if an SessionNotFoundException occurs during the execution of a remote request through the channel. The event gives you the opportunity to perform a login on the server (for example by calling a custom Login method, and then retry the call by setting the EventArgs' LoginSuccessful property to true. This way, your client can recover from a timed-out session to automatically logging in again, without the calling code having to consider the handling of SessionNotFoundExceptions manually. Oxygene:   event OnLoginNeeded: LoginNeededEventHandler delegate: method Invoke(sender: Object; e: LoginNeededEventArgs) C#:   event LoginNeededEventHandler OnLoginNeeded delegate: void Invoke(Object sender, LoginNeededEventArgs e) VB:   Event OnLoginNeeded As LoginNeededEventHandler delegate: Sub Invoke(sender As Object, e As LoginNeededEventArgs)
OnTransferEnd
This event is triggered by the client channel after a transfer is completed (either the sending of a request or the receiving of a response). Oxygene:   event OnTransferEnd: TransferEndEventHandler delegate: method Invoke(sender: Object; e: TransferEndEventArgs) C#:   event TransferEndEventHandler OnTransferEnd delegate: void Invoke(Object sender, TransferEndEventArgs e) VB:   Event OnTransferEnd As TransferEndEventHandler delegate: Sub Invoke(sender As Object, e As TransferEndEventArgs)
OnTransferProgress
This event is triggered by the client channel during a transfer (either the sending of a request or the receiving of a response) whenever a new block of data has been sent or received. Oxygene:   event OnTransferProgress: TransferProgressEventHandler delegate: method Invoke(sender: Object; e: TransferProgressEventArgs) C#:   event TransferProgressEventHandler OnTransferProgress delegate: void Invoke(Object sender, TransferProgressEventArgs e) VB:   Event OnTransferProgress As TransferProgressEventHandler delegate: Sub Invoke(sender As Object, e As TransferProgressEventArgs)
OnTransferStart
This event is triggered by the client channel when a transfer (either the sending of a request or the receiving of a response) is about to be started. Oxygene:   event OnTransferStart: TransferStartEventHandler delegate: method Invoke(sender: Object; e: TransferStartEventArgs) C#:   event TransferStartEventHandler OnTransferStart delegate: void Invoke(Object sender, TransferStartEventArgs e) VB:   Event OnTransferStart As TransferStartEventHandler delegate: Sub Invoke(sender As Object, e As TransferStartEventArgs)

Descendants

• IpClientChannel
  • IpHttpClientChannel
  • IpTcpClientChannel
• LocalClientChannel
• NamedPipeClientChannel
• SuperHttpClientChannel
  • IpSuperHttpClientChannel
  • WinInetSuperHttpClientChannel
• SuperTcpClientChannel
  • IpSuperTcpClientChannel
• WinInetHttpClientChannel

See Also

• ClientChannel Class
  • .NET
  • Java
• Lists
  • RemObjects SDK for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
  • RemObjects SDK shared:   Data Types – File Types
  • other editions
    • RemObjects SDK for Xcode:   Protocols — Classes — Enums — Aliases — Implements
    • RemObjects SDK for Delphi:   Interfaces — Classes — Aliases — Implements
    • RemObjects SDK for Java:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects SDK for JavaScript:   Objects

Product: RemObjects SDK
Available Editions: RemObjects SDK for .NET, Xcode, Delphi, Java and JavaScript

Glossary — Articles — Library — Samples