NCBI C++ ToolKit: Client API to NCBI NetSchedule

class TWorkerNodeJob##Factory : public CSimpleJobFactory<TWorkerNodeJob> \
{                                                                        \
public:                                                                  \
    virtual string GetJobVersion() const                                 \
    {                                                                    \
        return #TWorkerNodeJob " version " #Version;                     \
    }                                                                    \
}

class TWorkerNodeJob##FactoryEx                                          \
    : public CSimpleJobFactoryEx<TWorkerNodeJob, TWorkerNodeIdleTask>    \
{                                                                        \
public:                                                                  \
    virtual string GetJobVersion() const                                 \
    {                                                                    \
        return #TWorkerNodeJob " version " #Version;                     \
    }                                                                    \
}

NCBI_DECLARE_WORKERNODE_FACTORY(TWorkerNodeJob, Version);               \
    int main(int argc, const char* argv[])                                  \
    {                                                                       \
        GetDiagContext().SetOldPostFormat(false);                           \
        BlobStorage_RegisterDriver_NetCache();                              \
        CGridWorkerApp app(new TWorkerNodeJob##Factory,                     \
            CVersionInfo(#Version));                                        \
        return app.AppMain(argc, argv, NULL, eDS_ToStdlog);                 \
    }

NCBI_DECLARE_WORKERNODE_FACTORY_EX(TWorkerNodeJob,                      \
            TWorkerNodeIdleTask, Version);                                  \
    int main(int argc, const char* argv[])                                  \
    {                                                                       \
        GetDiagContext().SetOldPostFormat(false);                           \
        BlobStorage_RegisterDriver_NetCache();                              \
        CGridWorkerApp app(new TWorkerNodeJob##FactoryEx,                   \
            CVersionInfo(#Version));                                        \
        return app.AppMain(argc, argv, NULL, eDS_ToStdlog);                 \
    }

NCBI_DECLARE_WORKERNODE_FACTORY_EX(TWorkerNodeJob,                      \
            TWorkerNodeIdleTask, Version);                                  \
    int main(int argc, const char* argv[])                                  \
    {                                                                       \
        GetDiagContext().SetOldPostFormat(false);                           \
        BlobStorage_RegisterDriver_NetCache();                              \
        CGridWorkerApp app(new TWorkerNodeJob##FactoryEx,                   \
            CVersionInfo(#Version));                                        \
        app.SetMergeLogLines();                                             \
        return app.AppMain(argc, argv, NULL, eDS_ToStdlog);                 \
    }

Client API to NCBI NetSchedule
[General Purpose Network Infrastructure Services]

Classes

Defines

Typedefs

Enumerations

Functions

Variables

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation


Classes
class	CGridJobSubmitter
	Grid Job Submitter. More...
class	CGridJobBatchSubmitter
	Grid Job Batch Submitter. More...
class	CGridJobStatus
	Grid Job Status checker. More...
class	CGridClient
	Grid Client. More...
class	CGridClientException
	Grid Client exception. More...
class	CGridClientApp
	Grid Client Application. More...
class	IWorkerNodeCleanupEventListener
class	IWorkerNodeCleanupEventSource
	Clean-up event source for the worker node. More...
class	IWorkerNodeInitContext
	Worker Node initialize context. More...
class	IWorkerNodeJob
	Worker Node Job interface. More...
class	CWorkerNodeJobContext
	Worker Node job context. More...
class	CWorkerNodeIdleTaskContext
	Worker Node Idle Task Context. More...
class	IWorkerNodeIdleTask
	Worker Node Idle Task Interface. More...
class	IWorkerNodeJobFactory
	Worker Node Job Factory interface. More...
class	CSimpleJobFactory< TWorkerNodeJob >
class	CSimpleJobFactoryEx< TWorkerNodeJob, TWorkerNodeIdleTask >
class	IWorkerNodeJobWatcher
	Jobs watcher interface. More...
class	CGridWorkerNode
	Grid Worker Node. More...
class	CGridWorkerAppException
class	CGridWorkerNodeException
class	CDefaultWorkerNodeInitContext
	Default implementation of a worker node initialization interface. More...
class	IGridWorkerNodeApp_Listener
	Listener of events generated by CGridWorkerNodeApp. More...
class	CGridWorkerNodeApp_Listener
	An adapter class for IGridWorkerNodeApp_Listener. More...
class	CGridWorkerApp
	Main Worker Node application. More...
class	CNetScheduleAPI
	Client API for NCBI NetSchedule server. More...
struct	CNetScheduleJob
	Job description. More...
class	CNetScheduleSubmitter
	Smart pointer to the job submission part of the NetSchedule API. More...
class	CNetScheduleExecuter
	Smart pointer to a part of the NetSchedule API that does job retrieval and processing on the worker node side. More...
class	CNetScheduleAdmin
class	CNetScheduleExceptionMap
	Map from exception names to codes. More...
class	CNetScheduleException
	NetSchedule internal exception. More...
struct	CNetScheduleKey
	Meaningful information encoded in the NetSchedule key. More...
class	CNetScheduleKeys
class	CGridCgiContext
	Grid Cgi Context Context in which a request is processed. More...
class	CGridCgiApplication
	Grid Cgi Application. More...
class	CRemoteCgiApp
Defines
#define	NCBI_DECLARE_WORKERNODE_FACTORY(TWorkerNodeJob, Version)
#define	NCBI_DECLARE_WORKERNODE_FACTORY_EX(TWorkerNodeJob, TWorkerNodeIdleTask, Version)
#define	NCBI_WORKERNODE_MAIN(TWorkerNodeJob, Version)
#define	NCBI_WORKERNODE_MAIN_EX(TWorkerNodeJob,TWorkerNodeIdleTask, Version)
#define	NCBI_WORKERNODE_MAIN_MERGE_LOG_LINES(TWorkerNodeJob,TWorkerNodeIdleTask, Version)
Typedefs
typedef map< string, string >	CGridCgiContext::TPersistedEntries
Enumerations
enum	CGridClient::EProgressMsg { CGridClient::eProgressMsgOn = 0, CGridClient::eProgressMsgOff }
Functions
void	CGridJobSubmitter::SetJobInput (const string &input)
	Set a job's input This string will be sent to then the job is submitted.
CNcbiOstream &	CGridJobSubmitter::GetOStream ()
	Get a stream where a client can write an input data for the remote job.
void	CGridJobSubmitter::SetJobMask (CNetScheduleAPI::TJobMask mask)
	Set a job mask.
void	CGridJobSubmitter::SetJobTags (const CNetScheduleAPI::TJobTags &tags)
	Set job tags.
void	CGridJobSubmitter::SetJobAffinity (const string &affinity)
	Set a job affinity.
string	CGridJobSubmitter::Submit (const string &affinity="")
	Submit a job to the queue.
	CGridJobSubmitter::CGridJobSubmitter (CGridClient &, bool use_progress)
	CGridJobSubmitter::CGridJobSubmitter (const CGridJobSubmitter &)
	The copy constructor and the assignment operator are prohibited.
CGridJobSubmitter &	CGridJobSubmitter::operator= (CGridJobSubmitter &)
void	CGridJobBatchSubmitter::SetJobInput (const string &input)
	Set a job's input This string will be sent to then the job is submitted.
CNcbiOstream &	CGridJobBatchSubmitter::GetOStream ()
	Get a stream where a client can write an input data for the remote job.
void	CGridJobBatchSubmitter::SetJobMask (CNetScheduleAPI::TJobMask mask)
	Set a job mask.
void	CGridJobBatchSubmitter::SetJobTags (const CNetScheduleAPI::TJobTags &tags)
	Set job tags.
void	CGridJobBatchSubmitter::SetJobAffinity (const string &affinity)
	Set a job affinity.
void	CGridJobBatchSubmitter::PrepareNextJob ()
void	CGridJobBatchSubmitter::Submit ()
	Submit a batch to the queue.
void	CGridJobBatchSubmitter::Reset ()
const vector< CNetScheduleJob > &	CGridJobBatchSubmitter::GetBatch () const
	CGridJobBatchSubmitter::CGridJobBatchSubmitter (CGridClient &)
	CGridJobBatchSubmitter::CGridJobBatchSubmitter (const CGridJobBatchSubmitter &)
	The copy constructor and the assignment operator are prohibited.
CGridJobBatchSubmitter &	CGridJobBatchSubmitter::operator= (CGridJobBatchSubmitter &)
const string &	CGridJobStatus::GetJobOutput ()
	Get a job's output string.
const string &	CGridJobStatus::GetJobInput ()
	Get a job's input sting.
int	CGridJobStatus::GetReturnCode ()
	Get a job's return code.
const string &	CGridJobStatus::GetErrorMessage ()
	If something bad has happened this method will return an explanation.
CNetScheduleAPI::EJobStatus	CGridJobStatus::GetStatus ()
	Get a job status.
CNcbiIstream &	CGridJobStatus::GetIStream (IBlobStorage::ELockMode=IBlobStorage::eLockWait)
	Get a stream with a job's result.
size_t	CGridJobStatus::GetBlobSize () const
	Get the size of an input stream.
string	CGridJobStatus::GetProgressMessage ()
	Get a job interim message.
	CGridJobStatus::CGridJobStatus (CGridClient &, bool auto_cleanup, bool use_progress)
void	CGridJobStatus::x_SetJobKey (const string &job_key)
void	CGridJobStatus::x_GetJobDetails ()
	CGridJobStatus::CGridJobStatus (const CGridJobStatus &)
	The copy constructor and the assignment operator are prohibited.
CGridJobStatus &	CGridJobStatus::operator= (const CGridJobStatus &)
	CGridClient::CGridClient (CNetScheduleSubmitter::TInstance ns_client, IBlobStorage &storage, ECleanUp cleanup, EProgressMsg progress_msg, bool use_embedded_storage=false)
	Constructor.
CGridJobSubmitter &	CGridClient::GetJobSubmitter ()
	Get a job submitter.
CGridJobBatchSubmitter &	CGridClient::GetJobBatchSubmitter ()
	Get a job submitter.
CGridJobStatus &	CGridClient::GetJobStatus (const string &job_key)
	Get a job status checker.
void	CGridClient::CancelJob (const string &job_key)
	Cancel Job.
void	CGridClient::RemoveDataBlob (const string &data_key)
	Remove a data blob from the storage.
CNetScheduleSubmitter &	CGridClient::GetNSClient ()
IBlobStorage &	CGridClient::GetStorage ()
size_t	CGridClient::GetMaxServerInputSize ()
	CGridClient::CGridClient (const CGridClient &)
	The copy constructor and the assignment operator are prohibited.
CGridClient &	CGridClient::operator= (const CGridClient &)
virtual const char *	CGridClientException::GetErrCodeString (void) const
	Get error code interpreted as text.
	CGridClientException::NCBI_EXCEPTION_DEFAULT (CGridClientException, CException)
CGridClient &	CGridClientApp::GetGridClient ()
	Get a grid client.
virtual string	CGridClientApp::GetProgramVersion (void) const =0
	Get program version (like: MyProgram v.
virtual bool	CGridClientApp::UseProgressMessage () const
virtual bool	CGridClientApp::UseAutomaticCleanup () const
	NCBI_DECLARE_INTERFACE_VERSION (SNetScheduleAPIImpl,"xnetschedule_api", 1, 0, 0)
void	NCBI_EntryPoint_xnetscheduleapi (CPluginManager< SNetScheduleAPIImpl >::TDriverInfoList &info_list, CPluginManager< SNetScheduleAPIImpl >::EEntryPointRequest method)
	CGridCgiContext::~CGridCgiContext ()
CHTMLPage &	CGridCgiContext::GetHTMLPage (void)
	Get an HTML page.
string	CGridCgiContext::GetSelfURL (void) const
	Get Sefl URL.
const string &	CGridCgiContext::GetJobKey (void) const
	Get Current job key.
const string &	CGridCgiContext::GetJobProgressMessage (void) const
	Get current job progress message.
const string &	CGridCgiContext::GetEntryValue (const string &entry_name) const
	Get a value from a cgi request.
void	CGridCgiContext::PersistEntry (const string &entry_name)
	Save this entry as a cookie add it to serf url.
void	CGridCgiContext::PersistEntry (const string &entry_name, const string &value)
CCgiContext &	CGridCgiContext::GetCGIContext ()
	Get CGI Context.
void	CGridCgiContext::SetCompleteResponse (CNcbiIstream &is)
bool	CGridCgiContext::NeedRenderPage () const
string	CGridCgiContext::GetHiddenFields () const
const string &	CGridCgiContext::GetJobInput () const
const string &	CGridCgiContext::GetJobOutput () const
void	CGridCgiContext::Clear ()
	Remove all persisted entries from cookie and self url.
void	CGridCgiContext::SetJobKey (const string &job_key)
void	CGridCgiContext::SetJobProgressMessage (const string &msg)
void	CGridCgiContext::SetJobInput (const string &input)
void	CGridCgiContext::SetJobOutput (const string &output)
	CGridCgiContext::CGridCgiContext (const CGridCgiContext &)
	A copy constructor and an assignemt operator are prohibited.
CGridCgiContext &	CGridCgiContext::operator= (const CGridCgiContext &)
virtual int	CGridCgiApplication::ProcessRequest (CCgiContext &ctx)
	Do not override this method yourself! -- it includes all the GRIDCGI specific machinery.
virtual string	CGridCgiApplication::GetProgramVersion (void) const =0
	Get program version (like: MyProgram v.
virtual void	CGridCgiApplication::ShowParamsPage (CGridCgiContext &ctx) const =0
	Show a page with input data.
virtual bool	CGridCgiApplication::CollectParams (CGridCgiContext &ctx)=0
	Collect parameters from HTML form If this method returns false that means that input parameters were not specified (or were incorrect).
virtual void	CGridCgiApplication::PrepareJobData (CGridJobSubmitter &submitter)=0
	This method is called when a job is ready to be send to a the queue.
virtual void	CGridCgiApplication::OnJobSubmitted (CGridCgiContext &ctx)
	This method is called just after a job has been submitted.
virtual void	CGridCgiApplication::OnJobDone (CGridJobStatus &status, CGridCgiContext &ctx)=0
	This method is call when a worker node finishes its job and result is ready to be retrieved.
virtual void	CGridCgiApplication::OnJobFailed (const string &msg, CGridCgiContext &ctx)
	This method is called when worker node repored a failure.
virtual void	CGridCgiApplication::OnJobCanceled (CGridCgiContext &ctx)
	This method is called if job was canceled during its execution.
virtual void	CGridCgiApplication::OnJobRunning (CGridCgiContext &ctx)
	This method is call when a job is taken by a worker node to be processed.
virtual void	CGridCgiApplication::OnJobPending (CGridCgiContext &ctx)
	This method is call when a job is in NetSchedule queue and is waiting for a worker node.
virtual void	CGridCgiApplication::OnEndProcessRequest (CGridCgiContext &)
	This method is call at the very end of the request processing.
virtual void	CGridCgiApplication::OnBeginProcessRequest (CGridCgiContext &)
	This method is call at the very beginnig of the request processing.
virtual void	CGridCgiApplication::OnQueueIsBusy (CGridCgiContext &)
	This method is call when a job couldn't be submittd because of NetSchedule queue is full.
virtual string	CGridCgiApplication::GetPageTitle (void) const =0
	Return page name.
virtual string	CGridCgiApplication::GetPageTemplate (void) const =0
	Return a name of a file this HTML page template.
virtual bool	CGridCgiApplication::JobStopRequested (void) const
	When job is still runnig this method is called to check if cancel has been requested via the user interface(HTML).
CGridClient &	CGridCgiApplication::GetGridClient (void)
	Get a Grid Client.
void	CGridCgiApplication::InitGridClient ()
	Initialize grid client.
void	CGridCgiApplication::RenderRefresh (CHTMLPage &page, const string &url, int delay)
bool	CGridCgiApplication::x_JobStopRequested (const CGridCgiContext &) const
bool	CGridCgiApplication::x_CheckJobStatus (CGridCgiContext &grid_ctx)
virtual bool	CGridCgiApplication::IsCachingNeeded (const CCgiRequest &request) const
const string &	CGridWorkerNode::GetQueueName () const
	Get a name of a queue where this node is connected to.
const string &	CGridWorkerNode::GetClientName () const
	Get a node name.
const string &	CGridWorkerNode::GetServiceName () const
	Get a Connection Info.
CNetScheduleAPI	CGridWorkerNode::GetNSClient () const
CNetScheduleExecuter	CGridWorkerNode::GetNSExecuter () const
bool	CGridWorkerNode::IsExclusiveMode ()
void	CGridWorkerApp::SetListener (IGridWorkerNodeApp_Listener *listener)
	Register a listener of events of this class.
void	CGridWorkerApp::SetMergeLogLines (bool merge_log_lines=true)
	Sets the default logging format for this application.
Variables
CGridClient &	CGridJobSubmitter::m_GridClient
CNetScheduleJob	CGridJobSubmitter::m_Job
bool	CGridJobSubmitter::m_UseProgress
auto_ptr< CNcbiOstream >	CGridJobSubmitter::m_WStream
CGridClient &	CGridJobBatchSubmitter::m_GridClient
vector< CNetScheduleJob >	CGridJobBatchSubmitter::m_Jobs
size_t	CGridJobBatchSubmitter::m_JobIndex
bool	CGridJobBatchSubmitter::m_HasBeenSubmitted
auto_ptr< CNcbiOstream >	CGridJobBatchSubmitter::m_WStream
CGridClient &	CGridJobStatus::m_GridClient
CNetScheduleJob	CGridJobStatus::m_Job
size_t	CGridJobStatus::m_BlobSize
bool	CGridJobStatus::m_AutoCleanUp
bool	CGridJobStatus::m_UseProgress
auto_ptr< CNcbiIstream >	CGridJobStatus::m_RStream
bool	CGridJobStatus::m_JobDetailsRead
CNetScheduleSubmitter	CGridClient::m_NSClient
IBlobStorage &	CGridClient::m_NSStorage
auto_ptr< CGridJobSubmitter >	CGridClient::m_JobSubmitter
auto_ptr< CGridJobBatchSubmitter >	CGridClient::m_JobBatchSubmitter
auto_ptr< CGridJobStatus >	CGridClient::m_JobStatus
bool	CGridClient::m_UseEmbeddedStorage
auto_ptr< IBlobStorage >	CGridClientApp::m_NSStorage
auto_ptr< CGridClient >	CGridClientApp::m_GridClient
const char *	kNetScheduleAPIDriverName
CHTMLPage &	CGridCgiContext::m_Page
CCgiContext &	CGridCgiContext::m_CgiContext
TCgiEntries	CGridCgiContext::m_ParsedQueryString
TPersistedEntries	CGridCgiContext::m_PersistedEntries
string	CGridCgiContext::m_ProgressMsg
string	CGridCgiContext::m_JobInput
string	CGridCgiContext::m_JobOutput
bool	CGridCgiContext::m_NeedRenderPage
int	CGridCgiApplication::m_RefreshDelay
int	CGridCgiApplication::m_FirstDelay
CNetScheduleAPI	CGridCgiApplication::m_NSClient
auto_ptr< IBlobStorage >	CGridCgiApplication::m_NSStorage
auto_ptr< CGridClient >	CGridCgiApplication::m_GridClient
CCgiResponse *	CGridCgiApplication::m_Response

Client API to NCBI NetSchedule [General Purpose Network Infrastructure Services]

Classes

Defines

Typedefs

Enumerations

Functions

Variables

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation

Client API to NCBI NetSchedule
[General Purpose Network Infrastructure Services]