CSIRO::Application::Web Namespace Reference

Classes
class	AssignGlobalNameMsg
	Message for assigning a globalName value. More...
class	AssignInputMsg
	Message for assigning an input value. More...
class	AssignMsg
	Base class for all assignment messages. More...
class	BaseUpdater
class	ClientTcpMessageHandler
class	ExecuteMsg
	Message to commence execution of a workspace. More...
class	GlobalNameUpdater
class	InputUpdater
class	IOBaseLister
class	IOBaseResultsListBuilder
class	IOBaseWatcher
class	ListMsg
	Message for a list request (asking for a list of inputs / outputs / globalNames) More...
class	ListResponseMsg
	When a list request has been completed, a list response is returned to the server containing the details of the requested items. More...
class	ServerEventLoop
	Manages the event loop of the server application, if one is required. More...
class	ServerTcpMessageHandler
class	StopExecutionMsg
	Message for stopping execution of a running workspace. More...
class	TcpMessageServer
	Serves TCP messages which are listened to for by the WorkspaceWeb object. More...
class	TerminateMsg
	Message for terminating a workspace process. More...
class	WatchCancelMsg
	Message for when a watch is cancelled. More...
class	WatchMsg
	Message for creating a new watch. More...
class	WatchUpdatedMsg
	Base class for all assignment messages. More...
class	WebTcpMessage
class	WebTcpMessageFactory
class	WebTcpMessageHandler
class	WorkspaceErrorMsg
	Message for when an error occurs in a workspace. More...
class	WorkspaceFailedMsg
	Message for when a workspace fails to execute. More...
class	WorkspaceSuccessMsg
	Message for when a workspace successfully completes execution. More...
class	WorkspaceWeb

Enumerations
enum	MessageTypeIds {   ExecuteMsgId = 0 , StopExecutionMsgId , TerminateMsgId , AssignInputMsgId ,   AssignGlobalNameMsgId , WatchMsgId , WatchCancelMsgId , ListMsgId ,   WorkspaceSuccessMsgId , WorkspaceErrorMsgId , WorkspaceFailedMsgId , WatchUpdatedMsgId ,   ListResponseMsgId }

Functions
uint	qHash (const QPair< int, QUuid > &key, uint seed=0)
void	registerLogMessageCategories ()

Variables
const QString	LogCritical = "WebCritical"
const QString	LogDebug = "WebDebug"
const QString	LogInfo = "WebInfo"
const QString	LogWarning = "WebWarning"
const QString	RESULTS_LBL_GLOBAL_NAMES = "globalNames"
const QString	RESULTS_LBL_ID = "id"
const QString	RESULTS_LBL_INPUTS = "inputs"
const QString	RESULTS_LBL_NAME = "name"
const QString	RESULTS_LBL_OUTPUTS = "outputs"
const QString	RESULTS_LBL_TYPE = "type"
const QString	RESULTS_LBL_VALUE = "value"

Enumeration Type Documentation

MessageTypeIds

enum MessageTypeIds

Each class has a specific message type id. We use an enum to ensure this.

Enumerator
ExecuteMsgId
StopExecutionMsgId
TerminateMsgId
AssignInputMsgId
AssignGlobalNameMsgId
WatchMsgId
WatchCancelMsgId
ListMsgId
WorkspaceSuccessMsgId
WorkspaceErrorMsgId
WorkspaceFailedMsgId
WatchUpdatedMsgId
ListResponseMsgId

Function Documentation

qHash()

uint qHash ( const QPair< int, QUuid > &  key, uint  seed = 0  )

inline

Hash function for WorkspaceId / Uuid combos (watches / lists)

registerLogMessageCategories()

CSIRO_IMPORTSPEC void registerLogMessageCategories

(

)

Registers all of our category messages for the application.

Variable Documentation

LogCritical

const QString LogCritical = "WebCritical"

LogDebug

const QString LogDebug = "WebDebug"

LogInfo

const QString LogInfo = "WebInfo"

LogWarning

const QString LogWarning = "WebWarning"

RESULTS_LBL_GLOBAL_NAMES

const QString RESULTS_LBL_GLOBAL_NAMES = "globalNames"

RESULTS_LBL_ID

const QString RESULTS_LBL_ID = "id"

Labels used for parsing watch lists and various things.

RESULTS_LBL_INPUTS

const QString RESULTS_LBL_INPUTS = "inputs"

RESULTS_LBL_NAME

const QString RESULTS_LBL_NAME = "name"

RESULTS_LBL_OUTPUTS

const QString RESULTS_LBL_OUTPUTS = "outputs"

RESULTS_LBL_TYPE

const QString RESULTS_LBL_TYPE = "type"

RESULTS_LBL_VALUE

const QString RESULTS_LBL_VALUE = "value"