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

Main Page   Modules   Alphabetical List   Compound List   File List   Compound Members   File Members  

soam__SessionAttribute Struct Reference
[Soam Admin Structures]

The attributes of a session. More...

List of all members.


Public Attributes

soam__SessionID sessionId
 The Id of the session.

char * state
 The state this session.

int priority
 The priority of the session.

soam__TaskID pendTasks
 The number of pending tasks in the session.

soam__TaskID runTasks
 The number of running tasks in the session.

soam__TaskID doneTasks
 The number of finished tasks in the session.

soam__TaskID errTasks
 The number of failed tasks in the session.

soam__TaskID cancelTasks
 The number of canceled tasks in the session.

int createTime
 The time when the session was created.

int numInstances
 The number of service instances running for this session.

char * sessionName
 The name of the session given when was created.

char * appName
 The application to which the session belongs.

char * consumer
 Consumer id that owns the application.

char * fromHost
 This attribute is deprecated and it will always be null.

char * userName
 The name of the user who created this session.

char * service
 The name of the service invoked by this session.

int endTime
 The time this session was ended.

char * comment
 Short description of the reason the session has changed its state.

int retryLimit
 The number of time the tasks in this session will re-run in case of failure.

xsd__boolean failIfTaskFail
 This flag indicates whether this session will end if one task will fail.

xsd__boolean recoverable
 This flag indicates whether this session can be recovered in case of SSM failover.

char * persistSessionHistory
 Describes what sessions will be persisted on the history files.

char * persistTaskHistory
 Describes what tasks will be persisted on the history files.

char * sessionType
 The type of the session as specified on creation of the session.

int lastTaskErrorTime
 The time of the last task failed.

char * sessionTag
 A short description of the session used to identify a group of sessions with the same characteristics The tag is provided at creation of the session.

int sessionRetryLimit
 The number of times the onSessionEnter() is called in case of error.

long long totNumRerunTask
 The number of re-run tasks in this session.

long long totTaskRerunTime
 Total runtime of the unsuccessful tasks.

long long totRunTime
 Total runtime of the tasks.

long long totInputMsgSize
 Total size of all the input messages.

long long totOutputMsgSize
 Total size of all the output messages.

long long commonDataSize
 The size of the common data.

long long totTaskWaitTime
 Total time spent by tasks waiting in queue.

char * hostPidPairs
 Host name and process id for failed SIM.

char * ssmVersion
 Version of the SSM associated with the application.

int protocolVersion
 Internal protocol version for the application.

char * sessionUpdateFailures
 Host names and process IDs for the last five service instances that experienced service-side session update failures.

unsigned int numCduUpdates
 The total number of common data updates received for this session.

long long totalNetworkSizeCduUpdates
 The total size of all common data updates sent over the network for this session, in bytes.

xsd__boolean compressionEnabled
 A flag to indicate whether compression was enabled for this session.

xsd__boolean compressionAppliedCommonData
 A flag to indicate whether compression was applied to the common data for this session.

long long rawCommonDataSize
 The initial size of the common data when it was passed from the client to Symphony.

int compressionThreshold
 The compression threshold in bytes.

xsd__boolean directDataTransferEnabled
 A flag to indicate whether direct data transfer is enabled.

xsd__boolean abortSessionIfClientDisconnect
 A flag to indicate whether abort session if client disconnect.

xsd__boolean discardResultsOnDelivery
 A flag to indicate whether session will discard results on delivery.


Detailed Description

The attributes of a session.

This structure of session attributes is returned by the sdViewSession operation

See also:
SessionAttribute


Member Data Documentation

xsd__boolean soam__SessionAttribute::abortSessionIfClientDisconnect
 

A flag to indicate whether abort session if client disconnect.

char* soam__SessionAttribute::appName
 

The application to which the session belongs.

soam__TaskID soam__SessionAttribute::cancelTasks
 

The number of canceled tasks in the session.

char* soam__SessionAttribute::comment
 

Short description of the reason the session has changed its state.

long long soam__SessionAttribute::commonDataSize
 

The size of the common data.

xsd__boolean soam__SessionAttribute::compressionAppliedCommonData
 

A flag to indicate whether compression was applied to the common data for this session.

xsd__boolean soam__SessionAttribute::compressionEnabled
 

A flag to indicate whether compression was enabled for this session.

int soam__SessionAttribute::compressionThreshold
 

The compression threshold in bytes.

Data that exceeds this threshold is compressed if compression is enabled.

char* soam__SessionAttribute::consumer
 

Consumer id that owns the application.

int soam__SessionAttribute::createTime
 

The time when the session was created.

xsd__boolean soam__SessionAttribute::directDataTransferEnabled
 

A flag to indicate whether direct data transfer is enabled.

xsd__boolean soam__SessionAttribute::discardResultsOnDelivery
 

A flag to indicate whether session will discard results on delivery.

soam__TaskID soam__SessionAttribute::doneTasks
 

The number of finished tasks in the session.

int soam__SessionAttribute::endTime
 

The time this session was ended.

soam__TaskID soam__SessionAttribute::errTasks
 

The number of failed tasks in the session.

xsd__boolean soam__SessionAttribute::failIfTaskFail
 

This flag indicates whether this session will end if one task will fail.

char* soam__SessionAttribute::fromHost
 

This attribute is deprecated and it will always be null.

char* soam__SessionAttribute::hostPidPairs
 

Host name and process id for failed SIM.

int soam__SessionAttribute::lastTaskErrorTime
 

The time of the last task failed.

unsigned int soam__SessionAttribute::numCduUpdates
 

The total number of common data updates received for this session.

int soam__SessionAttribute::numInstances
 

The number of service instances running for this session.

soam__TaskID soam__SessionAttribute::pendTasks
 

The number of pending tasks in the session.

char* soam__SessionAttribute::persistSessionHistory
 

Describes what sessions will be persisted on the history files.

"all" indicates that all the sessions are persisted "error" indicates that only the failed sessions are persisted

char* soam__SessionAttribute::persistTaskHistory
 

Describes what tasks will be persisted on the history files.

"all" indicates that all the tasks are persisted "error" indicates that only the failed tasks are persisted

int soam__SessionAttribute::priority
 

The priority of the session.

int soam__SessionAttribute::protocolVersion
 

Internal protocol version for the application.

long long soam__SessionAttribute::rawCommonDataSize
 

The initial size of the common data when it was passed from the client to Symphony.

The data size may change depending on which feature set is being used by the application. For example, the data size may decrease if the application enables the data compression feature.

xsd__boolean soam__SessionAttribute::recoverable
 

This flag indicates whether this session can be recovered in case of SSM failover.

int soam__SessionAttribute::retryLimit
 

The number of time the tasks in this session will re-run in case of failure.

soam__TaskID soam__SessionAttribute::runTasks
 

The number of running tasks in the session.

char* soam__SessionAttribute::service
 

The name of the service invoked by this session.

soam__SessionID soam__SessionAttribute::sessionId
 

The Id of the session.

char* soam__SessionAttribute::sessionName
 

The name of the session given when was created.

int soam__SessionAttribute::sessionRetryLimit
 

The number of times the onSessionEnter() is called in case of error.

char* soam__SessionAttribute::sessionTag
 

A short description of the session used to identify a group of sessions with the same characteristics The tag is provided at creation of the session.

char* soam__SessionAttribute::sessionType
 

The type of the session as specified on creation of the session.

char* soam__SessionAttribute::sessionUpdateFailures
 

Host names and process IDs for the last five service instances that experienced service-side session update failures.

char* soam__SessionAttribute::ssmVersion
 

Version of the SSM associated with the application.

char* soam__SessionAttribute::state
 

The state this session.

A session can be: open, closed, suspended, aborted

long long soam__SessionAttribute::totalNetworkSizeCduUpdates
 

The total size of all common data updates sent over the network for this session, in bytes.

long long soam__SessionAttribute::totInputMsgSize
 

Total size of all the input messages.

long long soam__SessionAttribute::totNumRerunTask
 

The number of re-run tasks in this session.

long long soam__SessionAttribute::totOutputMsgSize
 

Total size of all the output messages.

long long soam__SessionAttribute::totRunTime
 

Total runtime of the tasks.

long long soam__SessionAttribute::totTaskRerunTime
 

Total runtime of the unsuccessful tasks.

long long soam__SessionAttribute::totTaskWaitTime
 

Total time spent by tasks waiting in queue.

char* soam__SessionAttribute::userName
 

The name of the user who created this session.

This user is the owner of the session



     
Date Modified: 3 Nov 2008
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

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