Visit Platform at http://www.platform.com

Main Page   Class Hierarchy   Compound List   Compound Members  

SessionCallback Class Reference

Invoked when a task request is responsed. More...

List of all members.


Public Methods

virtual void onResponse (TaskOutputHandlePtr &task)=0 throw ()
 This method is invoked when a task response is available.

virtual void onException (SoamException &exception)=0 throw ()
 This method is invoked when an exception occurs within.


Detailed Description

Invoked when a task request is responsed.

Will be implemented by the SOAM developer and called upon by the API at various times. This interface is optional and provides a mechanism to make more efficient usage of SOAM for the developer who wishes to do so. The callback should be implemented and supplied as an argument to the Connection::createSession() method.

NOTE: If any of the methods of this class are called after the main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).

See also:
Connection::createSession().


Member Function Documentation

virtual void onResponse TaskOutputHandlePtr   task throw () [pure virtual]
 

This method is invoked when a task response is available.

It must be implemented by the application developer. A task response can be an output result (in the event of success of a task) or an exception (in the event of a task failure).

NOTE: Although the Symphony API currently invokes this method with a single callback thread, the number of threads used by the API to invoke this method may increase in future revisions of the API. Therefore, the developer should never assume that the invocation of this method will be done serially and should always implement this method in a thread-safe manner.

Parameters:
task  [IN] - a response to be handled.
See also:
TaskOutputHandle

virtual void onException SoamException   exception throw () [pure virtual]
 

This method is invoked when an exception occurs within.

the scope of the given Session. It must be implemented by the application developer.

NOTE: Although the Symphony API currently invokes this method with a single callback thread, the number of threads used by the API to invoke this method may increase in future revisions of the API. Therefore, the developer should never assume that the invocation of this method will be done serially and should always implement this method in a thread-safe manner.

Parameters:
exception  [IN] - an exception occurs within the scope of the session.
See also:
SoamException


     
Date Modified: 28 Apr 2011
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.