WRENCH  1.10
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Member Functions | Static Public Member Functions | List of all members
wrench::WorkflowExecutionEvent Class Reference

A class to represent the various execution events that are relevant to the execution of a workflow. More...

#include <WorkflowExecutionEvent.h>

Inheritance diagram for wrench::WorkflowExecutionEvent:
wrench::FileCopyCompletedEvent wrench::FileCopyFailedEvent wrench::PilotJobExpiredEvent wrench::PilotJobStartedEvent wrench::StandardJobCompletedEvent wrench::StandardJobFailedEvent wrench::TimerEvent

Public Member Functions

virtual std::string toString ()
 Get a textual description of the event. More...
 

Static Public Member Functions

static std::shared_ptr< WorkflowExecutionEventwaitForNextExecutionEvent (std::string)
 Block the calling process until a WorkflowExecutionEvent is generated based on messages received on a mailbox. More...
 
static std::shared_ptr< WorkflowExecutionEventwaitForNextExecutionEvent (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()

virtual std::string wrench::WorkflowExecutionEvent::toString ( )
inlinevirtual

◆ waitForNextExecutionEvent() [1/2]

std::shared_ptr< WorkflowExecutionEvent > wrench::WorkflowExecutionEvent::waitForNextExecutionEvent ( std::string  mailbox)
static

Block the calling process until a WorkflowExecutionEvent is generated based on messages received on a mailbox.

Parameters
mailboxthe name of the receiving mailbox
Returns
a workflow execution event
Exceptions
WorkflowExecutionException
std::runtime_error

◆ waitForNextExecutionEvent() [2/2]

std::shared_ptr< WorkflowExecutionEvent > wrench::WorkflowExecutionEvent::waitForNextExecutionEvent ( std::string  mailbox,
double  timeout 
)
static

Block the calling process until a WorkflowExecutionEvent is generated based on messages received on a mailbox, or until a timeout ooccurs.

Parameters
mailboxthe name of the receiving mailbox
timeouta 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: