Main Page Class Hierarchy Compound List Compound Members TaskSubmissionAttributes Class Reference
Container for all attributes that may be required upon task submission. More...
Public Methods
TaskSubmissionAttributes () Default constructor. virtual ~TaskSubmissionAttributes () Destructor. void setTaskInput (Message *taskInput) throw (SoamException) Sets the input message for the task. void setPriorityTask (bool isPriorityTask) throw (SoamException) Sets the priority flag of the task. void setTaskTag (const char *tag) throw (SoamException) Sets the task tag. void setTaskTag (const std::string &tag) throw (SoamException) Sets the task tag. void setResourcePreference (const ResourcePreference &preference) throw (SoamException) Sets the resource preference object for the task. Friends
class Session Detailed Description
Container for all attributes that may be required upon task submission.
- See also:
- TaskInputHandle* Session::sendTaskInput(const TaskSubmissionAttributes& attributes)
Constructor & Destructor Documentation
TaskSubmissionAttributes ( )
Default constructor.
Constructs a TaskSubmissionAttributes object with default settings.
virtual ~TaskSubmissionAttributes ( ) [virtual]
Destructor.
Member Function Documentation
void setTaskInput ( Message * taskInput ) throw (SoamException)
Sets the input message for the task.
The input for the task.
- Parameters:
taskInput [IN] - The input for the task.
- Exceptions:
SoamException
void setPriorityTask ( bool isPriorityTask ) throw (SoamException)
Sets the priority flag of the task.
This is a parameter which indicates to the middleware that the message being submitted should take priority in the current session. This means that the created task will be placed at the front of the dispatch queue. The default value for this parameter is false if not specified, in which case the newly created task will be placed at the rear of the dispatch queue.
- Parameters:
isPriorityTask [IN] - Flag indicating whether the task should have priority or not.
- Exceptions:
SoamException
void setTaskTag ( const char * tag ) throw (SoamException)
Sets the task tag.
The task tag is just a string that will be associated with the created task. Maximum length 128 characters. Default value is "", which means that no task tag is associated with the task.
- Parameters:
tag [IN] - The task tag.
- Exceptions:
SoamException
void setTaskTag ( const std::string & tag ) throw (SoamException)
Sets the task tag.
The task tag is just a string that will be associated with the created task. Maximum length 128 characters. Default value is "", which means that no task tag is associated with the task.
- Parameters:
tag [IN] - The task tag.
- Exceptions:
SoamException
void setResourcePreference ( const ResourcePreference & preference ) throw (SoamException)
Sets the resource preference object for the task.
- Parameters:
preference [IN] - The resource preference of the task.
- See also:
- ResourcePreference
- 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.