A class to represent the various execution events that are relevant to the execution of a workflow. More...
#include <WorkflowExecutionEvent.h>
Public Member Functions | |
virtual std::string | toString () |
Get a textual description of the event. More... | |
Static Public Member Functions | |
static std::shared_ptr< WorkflowExecutionEvent > | waitForNextExecutionEvent (std::string) |
Block the calling process until a WorkflowExecutionEvent is generated based on messages received on a mailbox. More... | |
static std::shared_ptr< WorkflowExecutionEvent > | waitForNextExecutionEvent (std::string, double timeout) |
Block the calling process until a WorkflowExecutionEvent is generated based on messages received on a mailbox, or until a timeout ooccurs. More... | |
Detailed Description
A class to represent the various execution events that are relevant to the execution of a workflow.
Member Function Documentation
◆ toString()
|
inlinevirtual |
Get a textual description of the event.
- Returns
- a text string
Reimplemented in wrench::TimerEvent, wrench::FileCopyFailedEvent, wrench::FileCopyCompletedEvent, wrench::PilotJobExpiredEvent, wrench::PilotJobStartedEvent, wrench::StandardJobFailedEvent, and wrench::StandardJobCompletedEvent.
◆ waitForNextExecutionEvent() [1/2]
|
static |
Block the calling process until a WorkflowExecutionEvent is generated based on messages received on a mailbox.
- Parameters
-
mailbox the name of the receiving mailbox
- Returns
- a workflow execution event
- Exceptions
-
WorkflowExecutionException std::runtime_error
◆ waitForNextExecutionEvent() [2/2]
|
static |
Block the calling process until a WorkflowExecutionEvent is generated based on messages received on a mailbox, or until a timeout ooccurs.
- Parameters
-
mailbox the name of the receiving mailbox timeout a timeout value in seconds (-1 means: no timeout)
- Returns
- a workflow execution event (or nullptr in case of a timeout)
- Exceptions
-
WorkflowExecutionException std::runtime_error
The documentation for this class was generated from the following files:
- /home/wrench/wrench/include/wrench/workflow/execution_events/WorkflowExecutionEvent.h
- /home/wrench/wrench/src/wrench/workflow/execution_events/WorkflowExecutionEvent.cpp