WRENCH  1.11
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Types | Public Member Functions | List of all members
wrench::PilotJob Class Reference

A pilot (i.e., non-standard) workflow job that can be submitted to a ComputeService by a WMS (via a JobManager) More...

#include <PilotJob.h>

Inheritance diagram for wrench::PilotJob:
wrench::Job

Public Types

enum  State {
  NOT_SUBMITTED, PENDING, RUNNING, EXPIRED,
  FAILED, TERMINATED
}
 Pilot job states. More...
 

Public Member Functions

std::shared_ptr< BareMetalComputeServicegetComputeService ()
 Get the compute service provided by the (running) pilot job. More...
 
PilotJob::State getState ()
 Get the state of the pilot job. More...
 
void setComputeService (std::shared_ptr< BareMetalComputeService > cs)
 Set the compute service that runs on the pilot job. More...
 
- Public Member Functions inherited from wrench::Job
virtual ~Job ()
 Destructor.
 
simgrid::s4u::Mailbox * getCallbackMailbox ()
 Get the job's "next" callback mailbox, without popping it. More...
 
double getEndDate ()
 Get the date at which the job ended (<0 means "never submitted") More...
 
std::string getName ()
 Get the job's name. More...
 
simgrid::s4u::Mailbox * getOriginCallbackMailbox ()
 Get the "origin" callback mailbox. More...
 
std::shared_ptr< ComputeServicegetParentComputeService ()
 Get the compute service that is running /ran the job. More...
 
double getPriority () const
 Get the job's priority (the higher the priority value, the higher the priority) More...
 
std::map< std::string, std::string > & getServiceSpecificArguments ()
 Return the service-specific arguments that are used during job submission. More...
 
double getSubmitDate ()
 Get the date at which the job was last submitted (<0 means "never submitted") More...
 
simgrid::s4u::Mailbox * popCallbackMailbox ()
 Get the "next" callback mailbox (returns the workflow mailbox if the mailbox stack is empty), and pops it. More...
 
void printCallbackMailboxStack ()
 Method to print the call back stack.
 
void pushCallbackMailbox (simgrid::s4u::Mailbox *mailbox)
 Pushes a callback mailbox. More...
 
void setParentComputeService (std::shared_ptr< ComputeService > compute_service)
 Set the parent compute service of the job. More...
 
virtual void setPriority (double priority)
 Set the job's priority (the higher the priority value, the higher the priority) More...
 

Additional Inherited Members

- Protected Member Functions inherited from wrench::Job
 Job (std::string name, std::shared_ptr< JobManager > job_manager)
 Constructor. More...
 
unsigned long getNewUniqueNumber ()
 Generate a unique number (for each newly generated job) More...
 
void setServiceSpecificArguments (std::map< std::string, std::string > args)
 Sets the service-specific arguments that are used during job submission. More...
 
- Protected Attributes inherited from wrench::Job
bool already_submitted_to_job_manager = false
 Whether the job has already been submitted to the job manager.
 
std::stack< simgrid::s4u::Mailbox * > callback_mailbox_stack
 Stack of callback mailboxes (to pop notifications)
 
double end_date
 The date at which the job ended (with success or failure)
 
std::shared_ptr< JobManagerjob_manager
 The Job Manager in charge of this job.
 
std::string name
 The job's name.
 
simgrid::s4u::Mailbox * originator_mailbox
 The originator's mailbox.
 
std::shared_ptr< ComputeServiceparent_compute_service
 The compute service to which the job was submitted.
 
double priority = 0.0
 The job's priority (the higher the number, the higher the priority)
 
std::map< std::string, std::string > service_specific_args
 Service-specific arguments used during job submission.
 
double submit_date
 The date at which the job was last submitted.
 

Detailed Description

A pilot (i.e., non-standard) workflow job that can be submitted to a ComputeService by a WMS (via a JobManager)

Member Enumeration Documentation

◆ State

Pilot job states.

Enumerator
NOT_SUBMITTED 

Not submitted yet.

PENDING 

Submitted but not running.

RUNNING 

Running.

EXPIRED 

Expired due to a time-to-live limit.

FAILED 

Failed.

TERMINATED 

Terminated by submitter.

Member Function Documentation

◆ getComputeService()

std::shared_ptr< BareMetalComputeService > wrench::PilotJob::getComputeService ( )

Get the compute service provided by the (running) pilot job.

Returns
a compute service

◆ getState()

PilotJob::State wrench::PilotJob::getState ( )

Get the state of the pilot job.

Returns
the state

◆ setComputeService()

void wrench::PilotJob::setComputeService ( std::shared_ptr< BareMetalComputeService cs)

Set the compute service that runs on the pilot job.

Parameters
csa compute service

The documentation for this class was generated from the following files: