Diffusion .NET API  5.9.24
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
Public Member Functions | List of all members
PushTechnology.ClientInterface.Client.Callbacks.IContextCallback< in TContext > Interface Template Reference

Callback interface that provides responses from the server, together with an application supplied context object. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Callbacks.IContextCallback< in TContext >:
PushTechnology.ClientInterface.Client.Callbacks.DefaultContextCallback< TContext > PushTechnology.ClientInterface.Client.Callbacks.IContextStream< in TContext > PushTechnology.ClientInterface.Client.Features.Control.Clients.IConfigurationContextCallback< in TC > PushTechnology.ClientInterface.Client.Features.Control.Clients.ISessionPropertiesContextCallback< TC > PushTechnology.ClientInterface.Client.Features.Control.Clients.IUpdateStoreContextCallback< in TC > PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl.IConfigurationContextCallback< in TC > PushTechnology.ClientInterface.Client.Features.Control.Clients.SecurityControl.IUpdateStoreContextCallback< in TC > PushTechnology.ClientInterface.Client.Features.Control.Topics.ISendToFilterContextCallback< in TC > PushTechnology.ClientInterface.Client.Features.Control.Topics.ISubscriptionByFilterContextCallback< in TC > PushTechnology.ClientInterface.Client.Features.Control.Topics.ITopicControlRemovalContextCallback< in TContext > PushTechnology.ClientInterface.Client.Features.Control.Topics.ITopicUpdaterUpdateContextCallback< in TContext >

Public Member Functions

void OnError (TContext context, ErrorReason errorReason)
 Notification of a contextual error related to this callback. This is analogous to an unchecked exception being raised. Situations in which More...
 

Detailed Description

Callback interface that provides responses from the server, together with an application supplied context object.

This interface and its extensions are alternatives to the ICallback interface hierarchy that allow the application to associate an arbitrary context object with each call. Any suitable application object can be provided as the context. It will be passed on to the corresponding callback methods, allowing requests and responses to be correlated. The context object is optional (it may be null).

In all other respects ICallback and IContextCallback{T} behave identically.

Template Parameters
TContextcontext object type

Member Function Documentation

void PushTechnology.ClientInterface.Client.Callbacks.IContextCallback< in TContext >.OnError ( TContext  context,
ErrorReason  errorReason 
)

Notification of a contextual error related to this callback. This is analogous to an unchecked exception being raised. Situations in which

OnError is called include the session being closed, a communication timeout, or a problem with the provided parameters. No further calls will be made to this callback.

Parameters
contextthe context object supplied when making the call. May be null.
errorReasonerrorReason a value representing the error; this can be one of constants defined in ErrorReason, or a feature-specific reason.

Implemented in PushTechnology.ClientInterface.Client.Callbacks.DefaultContextCallback< TContext >.

The documentation for this interface was generated from the following file: