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

Main Page   Class Hierarchy   Compound List   Compound Members  

TaskContext Class Reference

Provides functionality that a service invocation will require. The TaskContext is only valid for the duration of the ServiceContainer::onInvoke() method call. More...

List of all members.


Public Methods

const char * getSessionId (void) const throw (SoamException)
 Gets the ID of a Session returned by SOAM.

const char * getTaskId (void) const throw (SoamException)
 Gets the ID of a Task returned by SOAM.

void getInputMessage (Message &inMsg) const throw (SoamException)
 Gets an input message of a Task.

void populateTaskInput (Message &inputMessage) const throw (SoamException)
 Populates a message objecte with the input of a Task.

void setOutputMessage (Message &outMsg) throw (SoamException)
 Sets an output message of a Task.

void setTaskOutput (Message &outputMessage) throw (SoamException)
 Sets an output message of a Task.

void discardInputMessage (void) throw (SoamException)
 Frees the middleware's local copy of the input message.


Friends

class ServiceContainer

Detailed Description

Provides functionality that a service invocation will require. The TaskContext is only valid for the duration of the ServiceContainer::onInvoke() method call.

NOTE: It is always best to access a pointer to this type of object through the appropriate smart pointer type instead of using a raw pointer.

See also:
TaskContextPtr


Member Function Documentation

const char* getSessionId void    const throw (SoamException)
 

Gets the ID of a Session returned by SOAM.

Returns:
a Session ID.
Exceptions:
SoamException 

const char* getTaskId void    const throw (SoamException)
 

Gets the ID of a Task returned by SOAM.

Returns:
a Task ID.
Exceptions:
SoamException 

void getInputMessage Message   inMsg const throw (SoamException)
 

Gets an input message of a Task.

Deprecated:
This method was deprecated in Symphony 3.1, use
void TaskContext::populateTaskInput (Message& inputMessage) instead.
Parameters:
inMsg  [OUT] - The input message sent by the client.
Exceptions:
SoamException 
See also:
Session::sendTaskInput , Message

void populateTaskInput Message   inputMessage const throw (SoamException)
 

Populates a message objecte with the input of a Task.

Parameters:
inputMessage  [OUT] - The message object to be populated with input data sent by the client.
Exceptions:
SoamException 
See also:
Session::sendTaskInput , Message

void setOutputMessage Message   outMsg throw (SoamException)
 

Sets an output message of a Task.

Deprecated:
This method was deprecated in Symphony 3.1, use
void TaskContext::setTaskOutput (Message& outputMessage) instead.
In the client side, you could use Session::fetchTaskOutput for synchronous session or SessionCallback for asynchronous session to receive this response.
Parameters:
outMsg  [IN] - The output message will be returned to the client.
Exceptions:
SoamException 
See also:
Session::fetchTaskOutput , SessionCallback::onResponse , Message

void setTaskOutput Message   outputMessage throw (SoamException)
 

Sets an output message of a Task.

In the client side, you could use Session::fetchTaskOutput for synchronous session or SessionCallback for asynchronous session to receive this response.

Parameters:
outputMessage  [IN] - The output message which will be returned to the client.
Exceptions:
SoamException 
See also:
Session::fetchTaskOutput , SessionCallback::onResponse , Message

void discardInputMessage void    throw (SoamException)
 

Frees the middleware's local copy of the input message.

If the developer has sucessfully extracted the input message from the middleware and is concerned about the memory being consumed by the copy held in the middleware locally, this method can be used to free it.

Note : once the data is freed any subsequent requests to attempt to retrieve it will result in an exception.

Exceptions:
SoamException 


     
Date Modified: 11 Nov 2009
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.