Search Toolkit Book for CGridClient
Grid Client (the submitter). More...
#include <connect/services/grid_client.hpp>
Collaboration diagram for CGridClient:
Public Types | |
| enum | ECleanUp { eAutomaticCleanup = 0 , eManualCleanup } |
| enum | EProgressMsg { eProgressMsgOn = 0 , eProgressMsgOff } |
Public Member Functions | |
| CGridClient (CNetScheduleSubmitter::TInstance ns_submitter, IBlobStorage &storage, ECleanUp cleanup, EProgressMsg progress_msg) | |
| Constructor. More... | |
| CGridClient (CNetScheduleSubmitter::TInstance ns_submitter, CNetCacheAPI::TInstance nc_client, ECleanUp cleanup, EProgressMsg progress_msg) | |
| Constructor. More... | |
| const string & | GetJobOutput () |
| Get a job's output string. More... | |
| const string & | GetJobInput () |
| Get a job's input sting. More... | |
| int | GetReturnCode () |
| Get a job's return code. More... | |
| const string & | GetErrorMessage () |
| If something bad has happened this method will return an explanation. More... | |
| CNetScheduleAPI::EJobStatus | GetStatus () |
| Get a job status. More... | |
| CNcbiIstream & | GetIStream () |
| Get a stream with a job's result. More... | |
| size_t | GetBlobSize () const |
| Get the size of an input stream. More... | |
| string | GetProgressMessage () |
| Get a job interim message. More... | |
| void | SetJobInput (const string &input) |
| Set a job's input This string will be sent to then the job is submitted. More... | |
| CNcbiOstream & | GetOStream () |
| Get a stream where a client can write an input data for the remote job. More... | |
| void | CloseStream () |
| void | SetJobMask (CNetScheduleAPI::TJobMask mask) |
| void | SetJobGroup (const string &group) |
| void | SetJobAffinity (const string &affinity) |
| string | Submit (const string &affinity=kEmptyStr) |
| Submit a job to the queue. More... | |
| CNetScheduleAPI::EJobStatus | SubmitAndWait (unsigned wait_time) |
| Submit a job to the queue. More... | |
| CNetScheduleAPI::EJobStatus | WaitForJob (const string &job_key, unsigned wait_time) |
| Wait for job to finish its execution (done/failed/canceled). More... | |
| CNetScheduleJob & | GetJob () |
| CGridJobBatchSubmitter & | GetJobBatchSubmitter () |
| Get a job submitter. More... | |
| void | SetJobKey (const string &job_key) |
| void | CancelJob (const string &job_key) |
| Cancel Job. More... | |
| CNetScheduleSubmitter | GetNetScheduleSubmitter () |
| CNetCacheAPI & | GetNetCacheAPI () |
| size_t | GetMaxServerInputSize () |
Private Member Functions | |
| void | RemoveDataBlob (const string &) |
| void | x_ProlongBlobLifetime (const string &blob_key, unsigned ttl) |
| bool | x_ProlongJobFieldLifetime (const string &job_field, unsigned ttl) |
| void | x_RenewAllJobBlobs (unsigned ttl) |
| CNetScheduleAPI::EJobStatus | x_CheckAllJobBlobs (CNetScheduleAPI::EJobStatus status, time_t job_exptime) |
| void | x_GetJobDetails () |
| CGridClient (const CGridClient &) | |
| The copy constructor and the assignment operator are prohibited. More... | |
| CGridClient & | operator= (const CGridClient &) |
Detailed Description
Grid Client (the submitter).
Definition at line 117 of file grid_client.hpp.
The documentation for this class was generated from the following files:
- include/connect/services/grid_client.hpp
- src/connect/services/grid_client.cpp
