Workspace 6.21.5
Public Types | Public Member Functions | Static Public Member Functions | List of all members
WorkspaceTcpMessageFactory Class Reference

The base class of all Scheduler-originated network messages.

#include <Workspace/DataExecution/Execution/workspacetcpmessagefactory.h>

Inheritance diagram for WorkspaceTcpMessageFactory:
[legend]

Public Types

typedef SchedulerTcpMessage *(* CreateFuncType) ()
 
using FactoryMap = QHash< MessageIds, QPair< CreateFuncType, QString > >
 
enum  MessageIds {
  ScheduleWorkspaceExecutionMsg = 0 , StartedWorkspaceExecutionMsg , FinishedWorkspaceExecutionMsg , StartedWorkspaceUpdateMsg ,
  FinishedWorkspaceUpdateMsg , AbortedWorkspaceUpdateMsg , StopWorkspaceExecutionMsg , FailedToScheduleWorkspaceMsg ,
  DelayScheduledWorkspaceMsg , GetListQueueWorkspaceMsg , ListQueueWorkspaceMsg , ChangePriorityInQueueWorkspaceMsg ,
  PauseQueueWorkspaceMsg , ResumeQueueWorkspaceMsg , GetListAllWorkspaceMsg , GetWorkspaceDetailMsg ,
  WorkspaceDetailMsg , CleanWorkspaceHistoryMsg , WorkspaceLogMsg , OperationUpdateEventListMsg ,
  HandshakeMsg = 1000 , HeartbeatMsg , ClientHeartbeatMsg , ServerLoadMsg
}
 

Public Member Functions

 WorkspaceTcpMessageFactory ()
 
 ~WorkspaceTcpMessageFactory () override
 
TcpMessagecreateFrom (const TcpMessage &) override
 Re-constructs an application-specific message from a TcpMessage.
 
- Public Member Functions inherited from TcpMessageFactory
 TcpMessageFactory ()
 
virtual ~TcpMessageFactory ()
 
virtual TcpMessagecreateFrom (const TcpMessage &)=0
 

Static Public Member Functions

static WorkspaceTcpMessageFactorygetInstance ()
 
static FactoryMapmessageCreateFunctions ()
 
template<typename MessageType >
static bool registerMessage (MessageIds msgId, MessageType *(*func)(), const char *name)
 

Member Typedef Documentation

◆ CreateFuncType

typedef SchedulerTcpMessage *(* CreateFuncType) ()

◆ FactoryMap

using FactoryMap = QHash<MessageIds, QPair<CreateFuncType, QString> >

Member Enumeration Documentation

◆ MessageIds

enum MessageIds
Enumerator
ScheduleWorkspaceExecutionMsg 
StartedWorkspaceExecutionMsg 
FinishedWorkspaceExecutionMsg 
StartedWorkspaceUpdateMsg 
FinishedWorkspaceUpdateMsg 
AbortedWorkspaceUpdateMsg 
StopWorkspaceExecutionMsg 
FailedToScheduleWorkspaceMsg 
DelayScheduledWorkspaceMsg 
GetListQueueWorkspaceMsg 
ListQueueWorkspaceMsg 
ChangePriorityInQueueWorkspaceMsg 
PauseQueueWorkspaceMsg 
ResumeQueueWorkspaceMsg 
GetListAllWorkspaceMsg 
GetWorkspaceDetailMsg 
WorkspaceDetailMsg 
CleanWorkspaceHistoryMsg 
WorkspaceLogMsg 
OperationUpdateEventListMsg 
HandshakeMsg 
HeartbeatMsg 
ClientHeartbeatMsg 
ServerLoadMsg 

Constructor & Destructor Documentation

◆ WorkspaceTcpMessageFactory()

◆ ~WorkspaceTcpMessageFactory()

~WorkspaceTcpMessageFactory ( )
overridedefault

Member Function Documentation

◆ createFrom()

TcpMessage * createFrom ( const TcpMessage message)
overridevirtual
Returns
The application-specific message.

Implements TcpMessageFactory.

◆ getInstance()

static WorkspaceTcpMessageFactory & getInstance ( )
inlinestatic

◆ messageCreateFunctions()

static FactoryMap & messageCreateFunctions ( )
inlinestatic

◆ registerMessage()

static bool registerMessage ( MessageIds  msgId,
MessageType *(*)()  func,
const char *  name 
)
inlinestatic