NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Attributes | List of all members

Search Toolkit Book for CNetScheduleSubmitter

Smart pointer to the job submission part of the NetSchedule API. More...

#include <connect/services/netschedule_api.hpp>

+ Collaboration diagram for CNetScheduleSubmitter:

Public Types

typedef SNetScheduleSubmitterImplTInstance
 

Public Member Functions

 CNetScheduleSubmitter (EVoid)
 
 CNetScheduleSubmitter (SNetScheduleSubmitterImpl *impl)
 
CNetScheduleSubmitteroperator= (SNetScheduleSubmitterImpl *impl)
 
 operator SNetScheduleSubmitterImpl * ()
 
 operator const SNetScheduleSubmitterImpl * () const
 
SNetScheduleSubmitterImploperator-- (int)
 
const SNetScheduleSubmitterImploperator-- (int) const
 
SNetScheduleSubmitterImploperator-> ()
 
const SNetScheduleSubmitterImploperator-> () const
 
 CNetScheduleSubmitter ()
 
string SubmitJob (CNetScheduleNewJob &job)
 Submit job. More...
 
void SubmitJobBatch (vector< CNetScheduleJob > &jobs, const string &job_group=kEmptyStr)
 Submit job batch. More...
 
bool Read (string *job_id, string *auth_token, CNetScheduleAPI::EJobStatus *job_status, unsigned timeout=0, const string &job_group=kEmptyStr)
 Incremental retrieval of jobs that are done or failed. More...
 
void ReadConfirm (const string &job_id, const string &auth_token)
 Mark the specified job as successfully retrieved. More...
 
void ReadRollback (const string &job_id, const string &auth_token)
 Refuse from processing the results of the specified job. More...
 
void ReadFail (const string &job_id, const string &auth_token, const string &error_message=kEmptyStr)
 Refuse from processing the results of the specified job and increase its counter of failed job result retrievals. More...
 
CNetScheduleAPI::EJobStatus SubmitJobAndWait (CNetScheduleJob &job, unsigned wait_time)
 Submit job to server and wait for the result. More...
 
CNetScheduleAPI::EJobStatus WaitForJob (const string &job_id, unsigned wait_time)
 Wait for job to finish its execution (done/failed/canceled). More...
 
void CancelJob (const string &job_key)
 Cancel job. More...
 
void CancelJobGroup (const string &job_group, const string &job_statuses=kEmptyStr)
 Cancel job group. More...
 
void GetProgressMsg (CNetScheduleJob &job)
 Get progress message. More...
 
CNetScheduleAPI::EJobStatus GetJobStatus (const string &job_key, time_t *job_exptime=NULL, ENetScheduleQueuePauseMode *pause_mode=NULL)
 Get the current status of the specified job. More...
 
CNetScheduleAPI::EJobStatus GetJobDetails (CNetScheduleJob &job, time_t *job_exptime=NULL, ENetScheduleQueuePauseMode *pause_mode=NULL)
 Get full information about the specified job. More...
 

Protected Attributes

CNetRef< SNetScheduleSubmitterImplm_Impl
 

Detailed Description

Smart pointer to the job submission part of the NetSchedule API.

Objects of this class are returned by CNetScheduleAPI::GetSubmitter(). It is possible to have several submitters per one CNetScheduleAPI object.

See also
CNetScheduleAPI, CNetScheduleExecutor

Definition at line 391 of file netschedule_api.hpp.


The documentation for this class was generated from the following files:
Modified on Fri Mar 01 10:07:59 2024 by modify_doxy.py rev. 669887