A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/group__NetScheduleClient.html below:

Client API to NCBI NetSchedule

enum   CGridClient::ECleanUp { CGridClient::eAutomaticCleanup = 0 , CGridClient::eManualCleanup }   enum   CGridClient::EProgressMsg { CGridClient::eProgressMsgOn = 0 , CGridClient::eProgressMsgOff }   enum   CGridClientException::EErrCode { CGridClientException::eBatchAlreadySubmitted }   enum   IWorkerNodeCleanupEventListener::EWorkerNodeCleanupEvent { IWorkerNodeCleanupEventListener::eRegularCleanup , IWorkerNodeCleanupEventListener::eOnHardExit }   Event notifying of a safe clean-up point. More...
  enum   CWorkerNodeJobContext::ECommitStatus {
  CWorkerNodeJobContext::eCS_Done , CWorkerNodeJobContext::eCS_Failure , CWorkerNodeJobContext::eCS_Return , CWorkerNodeJobContext::eCS_Reschedule ,
  CWorkerNodeJobContext::eCS_NotCommitted , CWorkerNodeJobContext::eCS_JobIsLost
}   enum   IWorkerNodeJobWatcher::EEvent {
  IWorkerNodeJobWatcher::eJobStarted , IWorkerNodeJobWatcher::eJobStopped , IWorkerNodeJobWatcher::eJobFailed , IWorkerNodeJobWatcher::eJobSucceeded ,
  IWorkerNodeJobWatcher::eJobReturned , IWorkerNodeJobWatcher::eJobRescheduled , IWorkerNodeJobWatcher::eJobCanceled , IWorkerNodeJobWatcher::eJobLost
}   enum   CGridWorkerNode::EDisabledRequestEvents { CGridWorkerNode::eEnableStartStop , CGridWorkerNode::eDisableStartStop , CGridWorkerNode::eDisableStartOnly }   Disable the automatic logging of request-start and request-stop events by the framework itself. More...
  enum   CGridWorkerNodeException::EErrCode { CGridWorkerNodeException::ePortBusy , CGridWorkerNodeException::eJobIsLost , CGridWorkerNodeException::eJobFactoryIsNotSet , CGridWorkerNodeException::eExclusiveModeIsAlreadySet }   enum   CNetScheduleAPI::EAppRegistry { CNetScheduleAPI::eAppRegistry }   Defines how this object must be initialized. More...
  enum   CNetScheduleAPI::EJobStatus {
  CNetScheduleAPI::eJobNotFound = -1 , CNetScheduleAPI::ePending = 0 , CNetScheduleAPI::eRunning = 1 , CNetScheduleAPI::eCanceled = 3 ,
  CNetScheduleAPI::eFailed = 4 , CNetScheduleAPI::eDone = 5 , CNetScheduleAPI::eReading = 6 , CNetScheduleAPI::eConfirmed = 7 ,
  CNetScheduleAPI::eReadFailed = 8 , CNetScheduleAPI::eDeleted = 9 , CNetScheduleAPI::eLastStatus
}   Job status codes. More...
  enum   CNetScheduleAPI::EJobMask {
  CNetScheduleAPI::eEmptyMask = 0 , CNetScheduleAPI::eExclusiveJob = (1 << 0) , CNetScheduleAPI::eOutOfOrder = (1 << 1) , CNetScheduleAPI::eForEachNode = (1 << 2) ,
  CNetScheduleAPI::eSystemJob = (1 << 3) , CNetScheduleAPI::eUserMask = (1 << 16)
}   Job masks. More...
  enum   CNetScheduleAPI::EClientType {
  CNetScheduleAPI::eCT_Auto , CNetScheduleAPI::eCT_Admin , CNetScheduleAPI::eCT_Submitter , CNetScheduleAPI::eCT_WorkerNode ,
  CNetScheduleAPI::eCT_Reader
}   enum   CNetScheduleAPI::ENetScheduleWarningType {
  CNetScheduleAPI::eWarnUnknown , CNetScheduleAPI::eWarnAffinityNotFound , CNetScheduleAPI::eWarnAffinityNotPreferred , CNetScheduleAPI::eWarnAffinityAlreadyPreferred ,
  CNetScheduleAPI::eWarnGroupNotFound , CNetScheduleAPI::eWarnJobNotFound , CNetScheduleAPI::eWarnJobAlreadyCanceled , CNetScheduleAPI::eWarnJobAlreadyDone ,
  CNetScheduleAPI::eWarnJobAlreadyFailed , CNetScheduleAPI::eWarnJobPassportOnlyMatch , CNetScheduleAPI::eWarnNoParametersChanged , CNetScheduleAPI::eWarnConfigFileNotChanged ,
  CNetScheduleAPI::eWarnAlertNotFound , CNetScheduleAPI::eWarnAlertAlreadyAcknowledged , CNetScheduleAPI::eWarnSubmitsDisabledForServer , CNetScheduleAPI::eWarnQueueAlreadyPaused ,
  CNetScheduleAPI::eWarnQueueNotPaused , CNetScheduleAPI::eWarnCommandObsolete , CNetScheduleAPI::eWarnJobNotRead
}   enum   CNetScheduleExecutor::EJobAffinityPreference {
  CNetScheduleExecutor::ePreferredAffsOrAnyJob , CNetScheduleExecutor::ePreferredAffinities , CNetScheduleExecutor::eClaimNewPreferredAffs , CNetScheduleExecutor::eAnyJob ,
  CNetScheduleExecutor::eExplicitAffinitiesOnly
}   Affinity matching modes. More...
  enum   CNetScheduleJobReader::EReadNextJobResult {
  CNetScheduleJobReader::eRNJ_JobReady , CNetScheduleJobReader::eRNJ_NotReady , CNetScheduleJobReader::eRNJ_Timeout = eRNJ_NotReady , CNetScheduleJobReader::eRNJ_NoMoreJobs ,
  CNetScheduleJobReader::eRNJ_Interrupt
}   Possible outcomes of ReadNextJob() calls. More...
  enum   CNetScheduleException::EErrCode {
  CNetScheduleException::eInternalError , CNetScheduleException::eProtocolSyntaxError , CNetScheduleException::eAuthenticationError , CNetScheduleException::eKeyFormatError ,
  CNetScheduleException::eJobNotFound , CNetScheduleException::eGroupNotFound , CNetScheduleException::eAffinityNotFound , CNetScheduleException::eInvalidJobStatus ,
  CNetScheduleException::eUnknownQueue , CNetScheduleException::eUnknownQueueClass , CNetScheduleException::eUnknownService , CNetScheduleException::eTooManyPendingJobs ,
  CNetScheduleException::eDataTooLong , CNetScheduleException::eInvalidClient , CNetScheduleException::eClientDataVersionMismatch , CNetScheduleException::eAccessDenied ,
  CNetScheduleException::eSubmitsDisabled , CNetScheduleException::eShuttingDown , CNetScheduleException::eDuplicateName , CNetScheduleException::eObsoleteCommand ,
  CNetScheduleException::eInvalidParameter , CNetScheduleException::eInvalidAuthToken , CNetScheduleException::eTooManyPreferredAffinities , CNetScheduleException::ePrefAffExpired ,
  CNetScheduleException::eTryAgain
}   void  CGridJobBatchSubmitter::SetJobInput (const string &input)   Set a job's input This string will be sent to then the job is submitted. More...
  CNcbiOstreamCGridJobBatchSubmitter::GetOStream ()   Get a stream where a client can write an input data for the remote job. More...
  void  CGridJobBatchSubmitter::SetJobMask (CNetScheduleAPI::TJobMask mask)   Set a job mask. More...
  void  CGridJobBatchSubmitter::SetJobAffinity (const string &affinity)   Set a job affinity. More...
  void  CGridJobBatchSubmitter::PrepareNextJob ()   void  CGridJobBatchSubmitter::Submit (const string &job_group=kEmptyStr)   Submit a batch to the queue. More...
  void  CGridJobBatchSubmitter::Reset ()   const vector< CNetScheduleJob > &  CGridJobBatchSubmitter::GetBatch () const   void  CGridJobBatchSubmitter::CheckIfBatchAlreadySubmitted ()   void  CGridJobBatchSubmitter::CheckIfBatchSubmittedAndPrepareNextJob ()     CGridJobBatchSubmitter::CGridJobBatchSubmitter (CGridClient &)     CGridJobBatchSubmitter::CGridJobBatchSubmitter (const CGridJobBatchSubmitter &)   The copy constructor and the assignment operator are prohibited. More...
  CGridJobBatchSubmitterCGridJobBatchSubmitter::operator= (CGridJobBatchSubmitter &)     CGridClient::CGridClient (CNetScheduleSubmitter::TInstance ns_submitter, IBlobStorage &storage, ECleanUp cleanup, EProgressMsg progress_msg)   Constructor. More...
    CGridClient::CGridClient (CNetScheduleSubmitter::TInstance ns_submitter, CNetCacheAPI::TInstance nc_client, ECleanUp cleanup, EProgressMsg progress_msg)   Constructor. More...
  const stringCGridClient::GetJobOutput ()   Get a job's output string. More...
  const stringCGridClient::GetJobInput ()   Get a job's input sting. More...
  int  CGridClient::GetReturnCode ()   Get a job's return code. More...
  const stringCGridClient::GetErrorMessage ()   If something bad has happened this method will return an explanation. More...
  CNetScheduleAPI::EJobStatus  CGridClient::GetStatus ()   Get a job status. More...
  CNcbiIstreamCGridClient::GetIStream ()   Get a stream with a job's result. More...
  size_t  CGridClient::GetBlobSize () const   Get the size of an input stream. More...
  string  CGridClient::GetProgressMessage ()   Get a job interim message. More...
  void  CGridClient::SetJobInput (const string &input)   Set a job's input This string will be sent to then the job is submitted. More...
  CNcbiOstreamCGridClient::GetOStream ()   Get a stream where a client can write an input data for the remote job. More...
  void  CGridClient::CloseStream ()   void  CGridClient::SetJobMask (CNetScheduleAPI::TJobMask mask)   void  CGridClient::SetJobGroup (const string &group)   void  CGridClient::SetJobAffinity (const string &affinity)   string  CGridClient::Submit (const string &affinity=kEmptyStr)   Submit a job to the queue. More...
  CNetScheduleAPI::EJobStatus  CGridClient::SubmitAndWait (unsigned wait_time)   Submit a job to the queue. More...
  CNetScheduleAPI::EJobStatus  CGridClient::WaitForJob (const string &job_key, unsigned wait_time)   Wait for job to finish its execution (done/failed/canceled). More...
  CNetScheduleJobCGridClient::GetJob ()   CGridJobBatchSubmitterCGridClient::GetJobBatchSubmitter ()   Get a job submitter. More...
  void  CGridClient::SetJobKey (const string &job_key)   void  CGridClient::CancelJob (const string &job_key)   Cancel Job. More...
  CNetScheduleSubmitter  CGridClient::GetNetScheduleSubmitter ()   CNetCacheAPICGridClient::GetNetCacheAPI ()   size_t  CGridClient::GetMaxServerInputSize ()   void  CGridClient::RemoveDataBlob (const string &)   void  CGridClient::x_ProlongBlobLifetime (const string &blob_key, unsigned ttl)   bool  CGridClient::x_ProlongJobFieldLifetime (const string &job_field, unsigned ttl)   void  CGridClient::x_RenewAllJobBlobs (unsigned ttl)   CNetScheduleAPI::EJobStatus  CGridClient::x_CheckAllJobBlobs (CNetScheduleAPI::EJobStatus status, time_t job_exptime)   void  CGridClient::x_GetJobDetails ()     CGridClient::CGridClient (const CGridClient &)   The copy constructor and the assignment operator are prohibited. More...
  CGridClientCGridClient::operator= (const CGridClient &)   virtual const char *  CGridClientException::GetErrCodeString (void) const override   Get error code interpreted as text. More...
    CGridClientException::NCBI_EXCEPTION_DEFAULT (CGridClientException, CException)   virtual void  CGridClientApp::Init (void)   If you override this method, do call CGridClientApp::Init() from inside your overriding method. More...
  CGridClientCGridClientApp::GetGridClient ()   Get a grid client. More...
  virtual string  CGridClientApp::GetProgramVersion (void) const =0   Get program version (like: MyProgram v. More...
  virtual bool  CGridClientApp::UseProgressMessage () const   virtual bool  CGridClientApp::UseAutomaticCleanup () const   virtual void  IWorkerNodeCleanupEventListener::HandleEvent (EWorkerNodeCleanupEvent cleanup_event)=0   virtual  IWorkerNodeCleanupEventListener::~IWorkerNodeCleanupEventListener ()   virtual void  IWorkerNodeCleanupEventSource::AddListener (IWorkerNodeCleanupEventListener *listener)=0   virtual void  IWorkerNodeCleanupEventSource::RemoveListener (IWorkerNodeCleanupEventListener *listener)=0   virtual void  IWorkerNodeCleanupEventSource::CallEventHandlers ()=0   virtual  IWorkerNodeInitBaseContext::~IWorkerNodeInitBaseContext ()   virtual const IRegistryIWorkerNodeInitBaseContext::GetConfig () const =0   Get a config file registry. More...
  virtual const CArgsIWorkerNodeInitBaseContext::GetArgs () const =0   Get command line arguments. More...
  virtual const CNcbiEnvironmentIWorkerNodeInitBaseContext::GetEnvironment () const =0   Get environment variables. More...
  virtual IWorkerNodeCleanupEventSourceIWorkerNodeInitContext::GetCleanupEventSource () const =0   Get interface for registering clean-up event listeners. More...
  virtual CNetScheduleAPI  IWorkerNodeInitContext::GetNetScheduleAPI () const =0   Get the shared NetScheduleAPI object used by the worker node framework. More...
  virtual CNetCacheAPI  IWorkerNodeInitContext::GetNetCacheAPI () const =0   Get the shared NetCacheAPI object used by the worker node framework. More...
  virtual  IWorkerNodeJob::~IWorkerNodeJob ()   virtual int  IWorkerNodeJob::Do (CWorkerNodeJobContext &context)=0   Execute the job. More...
    CWorkerNodeJobContext::CWorkerNodeJobContext (EVoid)     CWorkerNodeJobContext::CWorkerNodeJobContext (SWorkerNodeJobContextImpl *impl)   CWorkerNodeJobContextCWorkerNodeJobContext::operator= (SWorkerNodeJobContextImpl *impl)     CWorkerNodeJobContext::operator SWorkerNodeJobContextImpl * ()     CWorkerNodeJobContext::operator const SWorkerNodeJobContextImpl * () const   SWorkerNodeJobContextImplCWorkerNodeJobContext::operator-- (int)   const SWorkerNodeJobContextImplCWorkerNodeJobContext::operator-- (int) const   SWorkerNodeJobContextImplCWorkerNodeJobContext::operator-> ()   const SWorkerNodeJobContextImplCWorkerNodeJobContext::operator-> () const     CWorkerNodeJobContext::CWorkerNodeJobContext ()   const CNetScheduleJobCWorkerNodeJobContext::GetJob () const   Get the associated job structure to access all of its fields. More...
  CNetScheduleJobCWorkerNodeJobContext::GetJob ()   const stringCWorkerNodeJobContext::GetJobKey () const   Get a job key. More...
  const stringCWorkerNodeJobContext::GetJobInput () const   Get a job input string. More...
  void  CWorkerNodeJobContext::SetJobOutput (const string &output)   Set a job's output. More...
  void  CWorkerNodeJobContext::SetJobRetCode (int ret_code)   Set the return code of the job. More...
  CNcbiIstreamCWorkerNodeJobContext::GetIStream ()   Get a stream with input data for a job. More...
  size_t  CWorkerNodeJobContext::GetInputBlobSize () const   Get the size of an input stream. More...
  void  CWorkerNodeJobContext::PutProgressMessage (const string &msg, bool send_immediately=false, bool overwrite=true)   Put progress message. More...
  CNcbiOstreamCWorkerNodeJobContext::GetOStream ()   Get a stream where a job can write its result. More...
  void  CWorkerNodeJobContext::CloseStreams ()   void  CWorkerNodeJobContext::CommitJob ()   Confirm that a job is done and result is ready to be sent back to the client. More...
  void  CWorkerNodeJobContext::CommitJobWithFailure (const string &err_msg, bool no_retries=false)   Confirm that a job is finished, but an error has happened during its execution. More...
  void  CWorkerNodeJobContext::ReturnJob ()   Schedule the job for return. More...
  void  CWorkerNodeJobContext::RescheduleJob (const string &affinity, const string &group=kEmptyStr)   Put the job back in the queue with the specified affinity and group. More...
  CNetScheduleAdmin::EShutdownLevel  CWorkerNodeJobContext::GetShutdownLevel ()   Check if job processing must be aborted. More...
  const stringCWorkerNodeJobContext::GetQueueName () const   Get a name of a queue where this node is connected to. More...
  const stringCWorkerNodeJobContext::GetClientName () const   Get a node name. More...
  void  CWorkerNodeJobContext::JobDelayExpiration (unsigned runtime_inc)   Increment job execution timeout. More...
  bool  CWorkerNodeJobContext::IsLogRequested () const   Check if logging was requested in config file. More...
  void  CWorkerNodeJobContext::RequestExclusiveMode ()   Instruct the system that this job requires all system's resources If this method is call, the node will not accept any other jobs until this one is done. More...
  const stringCWorkerNodeJobContext::GetJobOutput () const   CNetScheduleAPI::TJobMask  CWorkerNodeJobContext::GetJobMask () const   unsigned int  CWorkerNodeJobContext::GetJobNumber () const   bool  CWorkerNodeJobContext::IsJobCommitted () const   ECommitStatus  CWorkerNodeJobContext::GetCommitStatus () const   static const char *  CWorkerNodeJobContext::GetCommitStatusDescription (ECommitStatus commit_status)   bool  CWorkerNodeJobContext::IsJobLost () const   IWorkerNodeCleanupEventSourceCWorkerNodeJobContext::GetCleanupEventSource ()   CGridWorkerNode  CWorkerNodeJobContext::GetWorkerNode () const   void  CWorkerNodeIdleTaskContext::RequestShutdown ()   bool  CWorkerNodeIdleTaskContext::IsShutdownRequested () const   void  CWorkerNodeIdleTaskContext::SetRunAgain ()   bool  CWorkerNodeIdleTaskContext::NeedRunAgain () const   void  CWorkerNodeIdleTaskContext::Reset ()     CWorkerNodeIdleTaskContext::CWorkerNodeIdleTaskContext (CWorkerNodeIdleThread &thread)     CWorkerNodeIdleTaskContext::CWorkerNodeIdleTaskContext (const CWorkerNodeIdleTaskContext &)   CWorkerNodeIdleTaskContextCWorkerNodeIdleTaskContext::operator= (const CWorkerNodeIdleTaskContext &)   virtual  IWorkerNodeIdleTask::~IWorkerNodeIdleTask ()   virtual void  IWorkerNodeIdleTask::Run (CWorkerNodeIdleTaskContext &)=0   Do the Idle task here. More...
  virtual  IWorkerNodeJobFactory::~IWorkerNodeJobFactory ()   virtual IWorkerNodeJobIWorkerNodeJobFactory::CreateInstance (void)=0   Create a job. More...
  virtual void  IWorkerNodeJobFactory::Init (const IWorkerNodeInitContext &)   Initialize a worker node factory. More...
  virtual string  IWorkerNodeJobFactory::GetJobVersion () const =0   Get the job version. More...
  virtual string  IWorkerNodeJobFactory::GetAppName () const   virtual string  IWorkerNodeJobFactory::GetAppVersion () const   virtual IWorkerNodeIdleTaskIWorkerNodeJobFactory::GetIdleTask ()   Get the Idle task. More...
  virtual void  CSimpleJobFactory< TWorkerNodeJob >::Init (const IWorkerNodeInitContext &context)   Initialize a worker node factory. More...
  virtual IWorkerNodeJobCSimpleJobFactory< TWorkerNodeJob >::CreateInstance (void)   Create a job. More...
  virtual string  CSimpleJobFactory< TWorkerNodeJob >::GetJobVersion () const   Get the job version. More...
  virtual string  CSimpleJobFactory< TWorkerNodeJob >::GetAppName () const   virtual void  CSimpleJobFactoryEx< TWorkerNodeJob, TWorkerNodeIdleTask >::Init (const IWorkerNodeInitContext &context)   Initialize a worker node factory. More...
  virtual IWorkerNodeIdleTaskCSimpleJobFactoryEx< TWorkerNodeJob, TWorkerNodeIdleTask >::GetIdleTask ()   Get the Idle task. More...
  virtual  IWorkerNodeJobWatcher::~IWorkerNodeJobWatcher ()   virtual void  IWorkerNodeJobWatcher::Notify (const CWorkerNodeJobContext &job, EEvent event)=0     CGridWorkerNode::CGridWorkerNode (EVoid)     CGridWorkerNode::CGridWorkerNode (SGridWorkerNodeImpl *impl)   CGridWorkerNodeCGridWorkerNode::operator= (SGridWorkerNodeImpl *impl)     CGridWorkerNode::operator SGridWorkerNodeImpl * ()     CGridWorkerNode::operator const SGridWorkerNodeImpl * () const   SGridWorkerNodeImplCGridWorkerNode::operator-- (int)   const SGridWorkerNodeImplCGridWorkerNode::operator-- (int) const   SGridWorkerNodeImplCGridWorkerNode::operator-> ()   const SGridWorkerNodeImplCGridWorkerNode::operator-> () const     CGridWorkerNode::CGridWorkerNode ()     CGridWorkerNode::CGridWorkerNode (CNcbiApplicationAPI &app, IWorkerNodeJobFactory *job_factory)   Construct a worker node using class factories. More...
  void  CGridWorkerNode::Init ()   int  CGridWorkerNode::Run (ESwitch daemonize=eDefault, string procinfo_file_name=string())   Start job execution loop. More...
  void  CGridWorkerNode::RequestShutdown ()   void  CGridWorkerNode::ForceSingleThread ()   void  CGridWorkerNode::SetListener (IGridWorkerNodeApp_Listener *listener)   IWorkerNodeJobFactoryCGridWorkerNode::GetJobFactory ()   unsigned int  CGridWorkerNode::GetMaxThreads () const   Get the maximum threads running simultaneously. More...
  Uint8  CGridWorkerNode::GetTotalMemoryLimit () const   Get total memory limit (automatic restart if node grows more than that) More...
  unsigned  CGridWorkerNode::GetTotalTimeLimit () const   Get total time limit (automatic restart after that) More...
  time_t  CGridWorkerNode::GetStartupTime () const   unsigned  CGridWorkerNode::GetQueueTimeout () const   bool  CGridWorkerNode::IsHostInAdminHostsList (const string &host) const   unsigned  CGridWorkerNode::GetCommitJobInterval () const   unsigned  CGridWorkerNode::GetCheckStatusPeriod () const   size_t  CGridWorkerNode::GetServerOutputSize ()   const stringCGridWorkerNode::GetQueueName () const   const stringCGridWorkerNode::GetClientName () const   string  CGridWorkerNode::GetAppName () const   TVersion  CGridWorkerNode::GetAppVersion () const   const stringCGridWorkerNode::GetServiceName () const   CNetCacheAPI  CGridWorkerNode::GetNetCacheAPI () const   CNetScheduleAPI  CGridWorkerNode::GetNetScheduleAPI () const   CNetScheduleExecutor  CGridWorkerNode::GetNSExecutor () const   static void  CGridWorkerNode::DisableDefaultRequestEventLogging (EDisabledRequestEvents disabled_events=eDisableStartStop)   IWorkerNodeCleanupEventSourceCGridWorkerNode::GetCleanupEventSource ()   void  CGridWorkerNode::Suspend (bool pullback, unsigned timeout)   void  CGridWorkerNode::Resume ()   bool  CGridWorkerNode::IsSuspended () const   virtual const char *  CGridWorkerNodeException::GetErrCodeString (void) const override   Get error code interpreted as text. More...
    CGridWorkerNodeException::NCBI_EXCEPTION_DEFAULT (CGridWorkerNodeException, CException)     CNetScheduleAPI::CNetScheduleAPI (EVoid)     CNetScheduleAPI::CNetScheduleAPI (SNetScheduleAPIImpl *impl)   CNetScheduleAPICNetScheduleAPI::operator= (SNetScheduleAPIImpl *impl)     CNetScheduleAPI::operator SNetScheduleAPIImpl * ()     CNetScheduleAPI::operator const SNetScheduleAPIImpl * () const   SNetScheduleAPIImplCNetScheduleAPI::operator-- (int)   const SNetScheduleAPIImplCNetScheduleAPI::operator-- (int) const   SNetScheduleAPIImplCNetScheduleAPI::operator-> ()   const SNetScheduleAPIImplCNetScheduleAPI::operator-> () const     CNetScheduleAPI::CNetScheduleAPI ()     CNetScheduleAPI::CNetScheduleAPI (EAppRegistry use_app_reg, const string &conf_section=kEmptyStr)   Creates an instance of CNetScheduleAPI and initializes it with parameters read from the application registry. More...
    CNetScheduleAPI::CNetScheduleAPI (const IRegistry &reg, const string &conf_section=kEmptyStr)   Constructs a CNetScheduleAPI object and initializes it with parameters read from the specified registry object. More...
    CNetScheduleAPI::CNetScheduleAPI (CConfig *conf, const string &conf_section=kEmptyStr)   Constructs a CNetScheduleAPI object and initializes it with parameters read from the specified configuration object. More...
    CNetScheduleAPI::CNetScheduleAPI (const string &service_name, const string &client_name, const string &queue_name)   Construct the client without linking it to any particular server. More...
  void  CNetScheduleAPI::SetProgramVersion (const string &pv)   Set program version (like: MyProgram v. More...
  const stringCNetScheduleAPI::GetProgramVersion () const   Get program version string. More...
  const stringCNetScheduleAPI::GetQueueName () const   Return Queue name. More...
  static string  CNetScheduleAPI::StatusToString (EJobStatus status)   Printable status type. More...
  static EJobStatus  CNetScheduleAPI::StringToStatus (const CTempString &status_str)   Parse status string into enumerator value. More...
  CNetScheduleSubmitter  CNetScheduleAPI::GetSubmitter ()   Create an instance of CNetScheduleSubmitter. More...
  CNetScheduleExecutor  CNetScheduleAPI::GetExecutor ()   Create an instance of CNetScheduleExecutor. More...
  CNetScheduleJobReader  CNetScheduleAPI::GetJobReader (const string &group=kEmptyStr, const string &affinity=kEmptyStr)   Create an instance of CNetScheduleJobReader. More...
  CNetScheduleAdmin  CNetScheduleAPI::GetAdmin ()   CNetService  CNetScheduleAPI::GetService ()   const SServerParamsCNetScheduleAPI::GetServerParams ()   void  CNetScheduleAPI::GetQueueParams (const string &queue_name, TQueueParams &queue_params)   void  CNetScheduleAPI::GetQueueParams (TQueueParams &queue_params)   EJobStatus  CNetScheduleAPI::GetJobDetails (CNetScheduleJob &job, time_t *job_exptime=NULL, ENetScheduleQueuePauseMode *pause_mode=NULL)   Get job details. More...
  void  CNetScheduleAPI::GetProgressMsg (CNetScheduleJob &job)   Update the progress_message field of the job structure. More...
  void  CNetScheduleAPI::SetCommunicationTimeout (const STimeout &to)   void  CNetScheduleAPI::SetClientNode (const string &client_node)   void  CNetScheduleAPI::SetClientSession (const string &client_session)   void  CNetScheduleAPI::SetClientType (EClientType client_type)   static ENetScheduleWarningType  CNetScheduleAPI::ExtractWarningType (string &warn_msg)   static const char *  CNetScheduleAPI::WarningTypeToString (ENetScheduleWarningType warning_type)     CNetScheduleNewJob::CNetScheduleNewJob (const string &_input=kEmptyStr, const string &_affinity=kEmptyStr, CNetScheduleAPI::TJobMask _mask=CNetScheduleAPI::eEmptyMask)   void  CNetScheduleNewJob::Reset ()     CNetScheduleJob::CNetScheduleJob (const string &_input=kEmptyStr, const string &_affinity=kEmptyStr, CNetScheduleAPI::TJobMask _mask=CNetScheduleAPI::eEmptyMask)   void  CNetScheduleJob::Reset ()     CNetScheduleSubmitter::CNetScheduleSubmitter (EVoid)     CNetScheduleSubmitter::CNetScheduleSubmitter (SNetScheduleSubmitterImpl *impl)   CNetScheduleSubmitterCNetScheduleSubmitter::operator= (SNetScheduleSubmitterImpl *impl)     CNetScheduleSubmitter::operator SNetScheduleSubmitterImpl * ()     CNetScheduleSubmitter::operator const SNetScheduleSubmitterImpl * () const   SNetScheduleSubmitterImplCNetScheduleSubmitter::operator-- (int)   const SNetScheduleSubmitterImplCNetScheduleSubmitter::operator-- (int) const   SNetScheduleSubmitterImplCNetScheduleSubmitter::operator-> ()   const SNetScheduleSubmitterImplCNetScheduleSubmitter::operator-> () const     CNetScheduleSubmitter::CNetScheduleSubmitter ()   string  CNetScheduleSubmitter::SubmitJob (CNetScheduleNewJob &job)   Submit job. More...
  void  CNetScheduleSubmitter::SubmitJobBatch (vector< CNetScheduleJob > &jobs, const string &job_group=kEmptyStr)   Submit job batch. More...
  bool  CNetScheduleSubmitter::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  CNetScheduleSubmitter::ReadConfirm (const string &job_id, const string &auth_token)   Mark the specified job as successfully retrieved. More...
  void  CNetScheduleSubmitter::ReadRollback (const string &job_id, const string &auth_token)   Refuse from processing the results of the specified job. More...
  void  CNetScheduleSubmitter::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  CNetScheduleSubmitter::SubmitJobAndWait (CNetScheduleJob &job, unsigned wait_time)   Submit job to server and wait for the result. More...
  CNetScheduleAPI::EJobStatus  CNetScheduleSubmitter::WaitForJob (const string &job_id, unsigned wait_time)   Wait for job to finish its execution (done/failed/canceled). More...
  void  CNetScheduleSubmitter::CancelJob (const string &job_key)   Cancel job. More...
  void  CNetScheduleSubmitter::CancelJobGroup (const string &job_group, const string &job_statuses=kEmptyStr)   Cancel job group. More...
  void  CNetScheduleSubmitter::GetProgressMsg (CNetScheduleJob &job)   Get progress message. More...
  CNetScheduleAPI::EJobStatus  CNetScheduleSubmitter::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  CNetScheduleSubmitter::GetJobDetails (CNetScheduleJob &job, time_t *job_exptime=NULL, ENetScheduleQueuePauseMode *pause_mode=NULL)   Get full information about the specified job. More...
    CNetScheduleExecutor::CNetScheduleExecutor (EVoid)     CNetScheduleExecutor::CNetScheduleExecutor (SNetScheduleExecutorImpl *impl)   CNetScheduleExecutorCNetScheduleExecutor::operator= (SNetScheduleExecutorImpl *impl)     CNetScheduleExecutor::operator SNetScheduleExecutorImpl * ()     CNetScheduleExecutor::operator const SNetScheduleExecutorImpl * () const   SNetScheduleExecutorImplCNetScheduleExecutor::operator-- (int)   const SNetScheduleExecutorImplCNetScheduleExecutor::operator-- (int) const   SNetScheduleExecutorImplCNetScheduleExecutor::operator-> ()   const SNetScheduleExecutorImplCNetScheduleExecutor::operator-> () const     CNetScheduleExecutor::CNetScheduleExecutor ()   void  CNetScheduleExecutor::SetAffinityPreference (EJobAffinityPreference aff_pref)   Set preferred method of requesting jobs with affinities. More...
  void  CNetScheduleExecutor::SetJobGroup (const string &job_group)   Retrieve jobs from the specified group only. More...
  bool  CNetScheduleExecutor::GetJob (CNetScheduleJob &job, const string &affinity_list=kEmptyStr, CDeadline *dealine=NULL)   Get a pending job. More...
  bool  CNetScheduleExecutor::GetJob (CNetScheduleJob &job, unsigned wait_time, const string &affinity_list=kEmptyStr)   The same as GetJob(CNetScheduleJob&, EJobAffinityPreference, const string&, CDeadline*), except it accepts integer wait time in seconds instead of CDeadline. More...
  void  CNetScheduleExecutor::PutResult (const CNetScheduleJob &job)   Put job result (job should be received by GetJob() or WaitJob()) More...
  void  CNetScheduleExecutor::PutProgressMsg (const CNetScheduleJob &job)   Put job interim (progress) message. More...
  void  CNetScheduleExecutor::GetProgressMsg (CNetScheduleJob &job)   Get progress message. More...
  void  CNetScheduleExecutor::PutFailure (const CNetScheduleJob &job, bool no_retries=false)   Submit job failure diagnostics. More...
  void  CNetScheduleExecutor::Reschedule (const CNetScheduleJob &job)   Reschedule a job with new affinity and/or group information. More...
  CNetScheduleAPI::EJobStatus  CNetScheduleExecutor::GetJobStatus (const CNetScheduleJob &job, time_t *job_exptime=NULL, ENetScheduleQueuePauseMode *pause_mode=NULL)   Get the current status of the specified job. More...
  void  CNetScheduleExecutor::ReturnJob (const CNetScheduleJob &job)   Switch the job back to the "Pending" status so that it can be run again on a different worker node. More...
  void  CNetScheduleExecutor::JobDelayExpiration (const CNetScheduleJob &job, unsigned runtime_inc)   Increment job execution timeout. More...
  const CNetScheduleAPI::SServerParamsCNetScheduleExecutor::GetServerParams ()   Retrieve queue parameters from the server. More...
  void  CNetScheduleExecutor::ClearNode ()   Unregister client-listener. More...
  void  CNetScheduleExecutor::AddPreferredAffinities (const vector< string > &affs_to_add)   void  CNetScheduleExecutor::DeletePreferredAffinities (const vector< string > &affs_to_del)   void  CNetScheduleExecutor::ChangePreferredAffinities (const vector< string > *affs_to_add, const vector< string > *affs_to_delete)   const stringCNetScheduleExecutor::GetQueueName ()   Return Queue name. More...
  const stringCNetScheduleExecutor::GetClientName ()   const stringCNetScheduleExecutor::GetServiceName ()     CNetScheduleJobReader::CNetScheduleJobReader (EVoid)     CNetScheduleJobReader::CNetScheduleJobReader (SNetScheduleJobReaderImpl *impl)   CNetScheduleJobReaderCNetScheduleJobReader::operator= (SNetScheduleJobReaderImpl *impl)     CNetScheduleJobReader::operator SNetScheduleJobReaderImpl * ()     CNetScheduleJobReader::operator const SNetScheduleJobReaderImpl * () const   SNetScheduleJobReaderImplCNetScheduleJobReader::operator-- (int)   const SNetScheduleJobReaderImplCNetScheduleJobReader::operator-- (int) const   SNetScheduleJobReaderImplCNetScheduleJobReader::operator-> ()   const SNetScheduleJobReaderImplCNetScheduleJobReader::operator-> () const     CNetScheduleJobReader::CNetScheduleJobReader ()   EReadNextJobResult  CNetScheduleJobReader::ReadNextJob (CNetScheduleJob *job, CNetScheduleAPI::EJobStatus *job_status, const CTimeout *timeout=NULL)   Wait and return the next completed job. More...
  void  CNetScheduleJobReader::InterruptReading ()   Abort waiting for a completed job in the above method. More...
  static CException::TErrCode  CNetScheduleExceptionMap::GetCode (const string &name)   virtual const char *  CNetScheduleException::GetErrCodeString () const override   Get error code interpreted as text. More...
  static const char *  CNetScheduleException::GetErrCodeString (CException::TErrCode err_code)   unsigned  CNetScheduleException::ErrCodeToHTTPStatusCode () const   static const char *  CNetScheduleException::GetErrCodeDescription (CException::TErrCode err_code)     CNetScheduleException::NCBI_EXCEPTION_DEFAULT (CNetScheduleException, CNetServiceException)     CNetScheduleKey::CNetScheduleKey (const string &str_key, CCompoundIDPool::TInstance id_pool=NULL)   Parse NetSchedule key; throw an exception if the key cannot be recognized. More...
    CNetScheduleKey::CNetScheduleKey ()   Construct an empty object for use with ParseJobKey(). More...
  bool  CNetScheduleKey::ParseJobKey (const string &key_str, CCompoundIDPool::TInstance id_pool=NULL)     CNetScheduleKeyGenerator::CNetScheduleKeyGenerator (const string &host, unsigned port, const string &queue_name)   string  CNetScheduleKeyGenerator::Generate (unsigned id) const   void  CNetScheduleKeyGenerator::Generate (string *key, unsigned id) const   string  CNetScheduleKeyGenerator::GenerateCompoundID (unsigned id, CCompoundIDPool id_pool) const     CGridCgiContext::CGridCgiContext (CHTMLPage &page, CCgiContext &ctx)     CGridCgiContext::~CGridCgiContext ()   CHTMLPageCGridCgiContext::GetHTMLPage (void)   Get an HTML page. More...
  string  CGridCgiContext::GetSelfURL (void) const   Get Self URL. More...
  const stringCGridCgiContext::GetJobKey (void) const   Get Current job key. More...
  const stringCGridCgiContext::GetJobProgressMessage (void) const   Get current job progress message. More...
  const stringCGridCgiContext::GetEntryValue (const string &entry_name) const   Get a value from a CGI request. More...
  void  CGridCgiContext::PullUpPersistentEntry (const string &entry_name)   Save this entry as a cookie add it to serf url. More...
  void  CGridCgiContext::DefinePersistentEntry (const string &entry_name, const string &value)   CCgiContextCGridCgiContext::GetCGIContext ()   Get CGI Context. More...
  void  CGridCgiContext::SetCompleteResponse (CNcbiIstream &is)   bool  CGridCgiContext::NeedRenderPage () const   string  CGridCgiContext::GetHiddenFields () const   const stringCGridCgiContext::GetJobInput () const   const stringCGridCgiContext::GetJobOutput () const   void  CGridCgiContext::Clear ()   Remove all persisted entries from cookie and self url. More...
  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 assignment operator are prohibited. More...
  CGridCgiContextCGridCgiContext::operator= (const CGridCgiContext &)   virtual void  CGridCgiApplication::Init (void)   This method is called on the CGI application initialization – before starting to process a HTTP request or even receiving one. More...
  virtual int  CGridCgiApplication::ProcessRequest (CCgiContext &ctx)   Do not override this method yourself! – it includes all the GRIDCGI specific machinery. More...
  virtual string  CGridCgiApplication::GetProgramVersion (void) const =0   Get program version (like: MyProgram v. More...
  virtual void  CGridCgiApplication::ShowParamsPage (CGridCgiContext &ctx) const =0   Show a page with input data. More...
  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). More...
  virtual void  CGridCgiApplication::PrepareJobData (CGridClient &grid_client)=0   This method is called when a job is ready to be send to a the queue. More...
  virtual void  CGridCgiApplication::OnJobSubmitted (CGridCgiContext &)   This method is called just after a job has been submitted. More...
  virtual void  CGridCgiApplication::OnJobDone (CGridClient &grid_client, CGridCgiContext &ctx)=0   This method is call when a worker node finishes its job and result is ready to be retrieved. More...
  virtual void  CGridCgiApplication::OnJobFailed (const string &, CGridCgiContext &)   This method is called when worker node reported a failure. More...
  virtual void  CGridCgiApplication::OnJobCanceled (CGridCgiContext &)   This method is called if job was canceled during its execution. More...
  virtual void  CGridCgiApplication::OnJobRunning (CGridCgiContext &)   This method is call when a job is taken by a worker node to be processed. More...
  virtual void  CGridCgiApplication::OnJobPending (CGridCgiContext &)   This method is call when a job is in NetSchedule queue and is waiting for a worker node. More...
  virtual void  CGridCgiApplication::OnEndProcessRequest (CGridCgiContext &)   This method is call at the very end of the request processing. More...
  virtual void  CGridCgiApplication::OnBeginProcessRequest (CGridCgiContext &)   This method is call at the very beginning of the request processing. More...
  virtual void  CGridCgiApplication::OnQueueIsBusy (CGridCgiContext &)   This method is call when a job couldn't be submitted because of NetSchedule queue is full. More...
  virtual string  CGridCgiApplication::GetPageTitle (void) const =0   Return page name. More...
  virtual string  CGridCgiApplication::GetPageTemplate (void) const =0   Return a name of a file this HTML page template. More...
  virtual bool  CGridCgiApplication::JobStopRequested (void) const   When job is still running this method is called to check if cancel has been requested via the user interface(HTML). More...
  CGridClientCGridCgiApplication::GetGridClient (void)   Get a Grid Client. More...
  void  CGridCgiApplication::InitGridClient ()   Initialize grid client. More...
  void  CGridCgiApplication::RenderRefresh (CHTMLPage &page, const string &url, int delay)   virtual bool  CGridCgiApplication::IsCachingNeeded (const CCgiRequest &request) const   bool  CGridCgiApplication::x_JobStopRequested (const CGridCgiContext &) const   bool  CGridCgiApplication::x_CheckJobStatus (CGridCgiContext &grid_ctx)     CRemoteCgiApp::CRemoteCgiApp ()   virtual void  CRemoteCgiApp::Init (void)   This method is called on the CGI application initialization – before starting to process a HTTP request or even receiving one. More...
  virtual int  CRemoteCgiApp::Run (void)   Do not override this method yourself! – it includes all the CGI specific machinery. More...
  void  CRemoteCgiApp::RequestShutdown (void)   virtual string  CRemoteCgiApp::GetJobVersion () const   virtual void  CRemoteCgiApp::SetupArgDescriptions (CArgDescriptions *arg_desc)   Setup the command line argument descriptions. More...
  void  CRemoteCgiApp::PutProgressMessage (const string &msg, bool send_immediately=false)   int  CRemoteCgiApp::RunJob (CNcbiIstream &is, CNcbiOstream &os, CWorkerNodeJobContext &)     SInputValidator::SInputValidator ()   void  SInputValidator::CheckEntry (const string &name, const string &value, bool is_requested=true)   void  SInputValidator::AddAffinityEntry (string name)   static vector< stringSInputValidator::GetListenJobs (const string &value)   static CDeadline  SInputValidator::GetDeadline (const string &value)   static void  SInputValidator::CheckJobKey (const string &value)   static void  SInputValidator::CheckCancel (const string &value)   static void  SInputValidator::CheckCtgTime (const string &value)   static void  SInputValidator::CheckGetResults (const string &value)   static void  SInputValidator::CheckAffinity (const string &value)   template<class TF >   SInputValidator::SEntry::SEntry (string n, TF f)   bool  SInputValidator::SEntry::Check (const string &value)     SExceptionMessage::SExceptionMessage (CNcbiRegistry *registry=nullptr)   string  SExceptionMessage::operator() (const string &what)     CGridCgiContext::CGridCgiContext (SInputValidator &input_validator, CHTMLPage &page, CHTMLPage &custom_http_header, CCgiContext &ctx)   string  CGridCgiContext::GetSelfURL (bool include_entries=true) const   const stringCGridCgiContext::GetPersistentEntryValue (const string &entry_name) const   void  CGridCgiContext::GetQueryStringEntryValue (const string &entry_name, string &value) const   void  CGridCgiContext::GetRequestEntryValue (const string &entry_name, string &value) const   void  CGridCgiContext::PullUpPersistentEntry (const string &entry_name, string &value, int pulling=eDefaultPulling)   const TPersistentEntriesCGridCgiContext::GetPersistentEntries () const   bool  CGridCgiContext::HasCtgTime () const   void  CGridCgiContext::LoadQueryStringTags (CHTMLPlainText::EEncodeMode encode_mode)   void  CGridCgiContext::SelectView (const string &view_name)   void  CGridCgiContext::NeedRenderPage (bool value)   bool  CGridCgiContext::NeedMetaRefresh () const   stringCGridCgiContext::GetJobKey ()   stringCGridCgiContext::GetJqueryCallback ()   void  CGridCgiContext::AddTagMap (const string &n, const string &v, CHTMLPlainText::EEncodeMode m=CHTMLPlainText::eHTMLEncode)   virtual void  CCgi2RCgiApp::Init ()   This method is called on the CGI application initialization – before starting to process a HTTP request or even receiving one. More...
  virtual CCgiContextCCgi2RCgiApp::CreateContextWithFlags (CNcbiArguments *args, CNcbiEnvironment *env, CNcbiIstream *inp, CNcbiOstream *out, int ifd, int ofd, int flags)   The same as CreateContext(), but allows for a custom set of flags to be specified in the CCgiRequest constructor. More...
  virtual int  CCgi2RCgiApp::ProcessRequest (CCgiContext &ctx)   This is the method you should override. More...
  void  CCgi2RCgiApp::DefineRefreshTags (CGridCgiContext &grid_ctx, const string &url, int delay)   void  CCgi2RCgiApp::ListenJobs (const string &job_ids_value, const string &timeout_value)   void  CCgi2RCgiApp::CheckJob (CGridCgiContext &grid_ctx)   void  CCgi2RCgiApp::SubmitJob (CCgiRequest &request, CGridCgiContext &grid_ctx)   void  CCgi2RCgiApp::PopulatePage (CGridCgiContext &grid_ctx)   int  CCgi2RCgiApp::RenderPage ()   CNetScheduleAPI::EJobStatus  CCgi2RCgiApp::GetStatus (CGridCgiContext &)   CNetScheduleAPI::EJobStatus  CCgi2RCgiApp::GetStatusAndCtgTime (CGridCgiContext &grid_ctx)   bool  CCgi2RCgiApp::CheckIfJobDone (CGridCgiContext &, CNetScheduleAPI::EJobStatus)   void  CCgi2RCgiApp::ReadJob (istream &, CGridCgiContext &)   void  CCgi2RCgiApp::OnJobDone (CGridCgiContext &)   void  CCgi2RCgiApp::OnJobFailed (const string &msg, CGridCgiContext &ctx)     CRegexpTemplateFilter::CRegexpTemplateFilter (CHTMLPage *page)   virtual bool  CRegexpTemplateFilter::TestAttribute (const string &attr_name, const string &test_pattern)   static void  s_RemoveCallbackParameter (string *query_string)   bool  s_IsPendingOrRunning (CNetScheduleAPI::EJobStatus job_status)     SJob::SJob (const string &id)   CNcbiOstreamoperator<< (CNcbiOstream &out, SJobs jobs)   void  s_GetCtgTime (CGridCgiContext &grid_ctx, string event)   int  main (int argc, const char *argv[])   ◆ CALLBACK_PARAM #define CALLBACK_PARAM   "callback="

Definition at line 786 of file cgi2rcgi.cpp.

◆ NCBI_DECLARE_WORKERNODE_FACTORY #define NCBI_DECLARE_WORKERNODE_FACTORY (   TWorkerNodeJob,   Version  ) Value:

NCBI_DECLARE_WORKERNODE_FACTORY_IMPL(TWorkerNodeJob, Version)

static struct tagNamedScoreFactory Factory[]

Definition at line 496 of file grid_worker.hpp.

◆ NCBI_DECLARE_WORKERNODE_FACTORY_EX #define NCBI_DECLARE_WORKERNODE_FACTORY_EX (   TWorkerNodeJob,   TWorkerNodeIdleTask,   Version  ) Value:

TWorkerNodeJob##FactoryEx; \

NCBI_DECLARE_WORKERNODE_FACTORY_IMPL(TWorkerNodeJob, Version)

Definition at line 500 of file grid_worker.hpp.

◆ NCBI_DECLARE_WORKERNODE_FACTORY_IMPL #define NCBI_DECLARE_WORKERNODE_FACTORY_IMPL (   TWorkerNodeJob,   Version  ) Value:

BEGIN_NCBI_SCOPE \

template <> \

#TWorkerNodeJob " version " NCBI_AS_STRING(Version); \

template <> \

const char* const CSimpleJobFactory<TWorkerNodeJob>::m_AppName = \

#TWorkerNodeJob; \

END_NCBI_SCOPE

Definition at line 486 of file grid_worker.hpp.

◆ CNetScheduleExecuter ◆ TInstance [1/6] ◆ TInstance [2/6] ◆ TInstance [3/6] ◆ TInstance [4/6] ◆ TInstance [5/6] ◆ TInstance [6/6] ◆ TJobMask ◆ TPersistedEntries ◆ TPersistentEntries ◆ TQueueParams ◆ TVersion ◆ EAppRegistry ◆ ECleanUp Enumerator eAutomaticCleanup  eManualCleanup 

Definition at line 120 of file grid_client.hpp.

◆ EClientType Enumerator eCT_Auto  eCT_Admin  eCT_Submitter  eCT_WorkerNode  eCT_Reader 

Definition at line 263 of file netschedule_api.hpp.

◆ ECommitStatus Enumerator eCS_Done  eCS_Failure  eCS_Return  eCS_Reschedule  eCS_NotCommitted  eCS_JobIsLost 

Definition at line 350 of file grid_worker.hpp.

◆ EDisabledRequestEvents

Disable the automatic logging of request-start and request-stop events by the framework itself.

Enumerator eEnableStartStop  eDisableStartStop  eDisableStartOnly 

Definition at line 601 of file grid_worker.hpp.

◆ EErrCode [1/3] ◆ EErrCode [2/3] Enumerator ePortBusy  eJobIsLost  eJobFactoryIsNotSet  eExclusiveModeIsAlreadySet 

Definition at line 619 of file grid_worker.hpp.

◆ EErrCode [3/3] Enumerator eInternalError  eProtocolSyntaxError  eAuthenticationError  eKeyFormatError  eJobNotFound  eGroupNotFound  eAffinityNotFound  eInvalidJobStatus  eUnknownQueue  eUnknownQueueClass  eUnknownService  eTooManyPendingJobs  eDataTooLong  eInvalidClient  eClientDataVersionMismatch  eAccessDenied  eSubmitsDisabled  eShuttingDown  eDuplicateName  eObsoleteCommand  eInvalidParameter  eInvalidAuthToken  eTooManyPreferredAffinities  ePrefAffExpired  eTryAgain 

Definition at line 66 of file netschedule_api_expt.hpp.

◆ EEvent Enumerator eJobStarted  eJobStopped  eJobFailed  eJobSucceeded  eJobReturned  eJobRescheduled  eJobCanceled  eJobLost 

Definition at line 510 of file grid_worker.hpp.

◆ EJobAffinityPreference

Affinity matching modes.

Note
Explicitly specified affinities are always searched first.
Enumerator ePreferredAffsOrAnyJob  ePreferredAffinities  eClaimNewPreferredAffs  eAnyJob  eExplicitAffinitiesOnly 

Definition at line 593 of file netschedule_api.hpp.

◆ EJobMask

Job masks.

Enumerator eEmptyMask  eExclusiveJob 

Exclusive job - the node executes only this job, even if there are processor resources.

eOutOfOrder 

This jobs comes to the node before every regular jobs.

eForEachNode 

This job will be scheduled to every active node.

eSystemJob 

This job should be interpreted by client library, not client itself Can contain control information, e.g.

instruction for node to die

eUserMask 

User's masks start from here.

Definition at line 196 of file netschedule_api.hpp.

◆ EJobStatus

Job status codes.

Enumerator eJobNotFound 

No such job.

ePending 

Waiting for execution.

eRunning 

Running on a worker node.

eCanceled 

Explicitly canceled.

eFailed 

Failed to run (execution timeout)

eDone 

Job is ready (computed successfully)

eReading 

Job has its output been reading.

eConfirmed 

Final state - read confirmed.

eReadFailed 

Final state - read failed.

eDeleted 

The job has been wiped out of the database.

eLastStatus 

Fake status (do not use)

Definition at line 160 of file netschedule_api.hpp.

◆ ENetScheduleWarningType Enumerator eWarnUnknown  eWarnAffinityNotFound  eWarnAffinityNotPreferred  eWarnAffinityAlreadyPreferred  eWarnGroupNotFound  eWarnJobNotFound  eWarnJobAlreadyCanceled  eWarnJobAlreadyDone  eWarnJobAlreadyFailed  eWarnJobPassportOnlyMatch  eWarnNoParametersChanged  eWarnConfigFileNotChanged  eWarnAlertNotFound  eWarnAlertAlreadyAcknowledged  eWarnSubmitsDisabledForServer  eWarnQueueAlreadyPaused  eWarnQueueNotPaused  eWarnCommandObsolete  eWarnJobNotRead 

Definition at line 273 of file netschedule_api.hpp.

◆ EProgressMsg ◆ EReadNextJobResult

Possible outcomes of ReadNextJob() calls.

Enumerator eRNJ_JobReady 

A job is returned.

eRNJ_NotReady 

No matching jobs are ready for reading.

eRNJ_Timeout  eRNJ_NoMoreJobs 

No matching jobs.

eRNJ_Interrupt 

ReadNextJob() has been interrupted.

Definition at line 781 of file netschedule_api.hpp.

◆ EWorkerNodeCleanupEvent

Event notifying of a safe clean-up point.

It is generated for a job after the job is finished (or the worker node is shutting down). It is also generated for the whole worker node – when it is shutting down.

Enumerator eRegularCleanup 

For jobs – run from the same thread after Do() is done; for the whole WN – run from a separate (clean-up) thread after all jobs are done and cleaned up, and the whole worker node is shutting down.

eOnHardExit 

Called on emergency shutdown, always from a different (clean-up) thread, even for the jobs.

Definition at line 77 of file grid_worker.hpp.

◆ AddAffinityEntry() void SInputValidator::AddAffinityEntry ( string  name ) ◆ AddListener() ◆ AddPreferredAffinities() void CNetScheduleExecutor::AddPreferredAffinities ( const vector< string > &  affs_to_add ) inline ◆ AddTagMap() ◆ CallEventHandlers() ◆ CancelJob() [1/2] ◆ CancelJob() [2/2] void CNetScheduleSubmitter::CancelJob ( const stringjob_key ) ◆ CancelJobGroup() ◆ CGridCgiContext() [1/3] ◆ CGridCgiContext() [2/3]

A copy constructor and an assignment operator are prohibited.

◆ CGridCgiContext() [3/3] ◆ CGridClient() [1/3]

Constructor.

Parameters
ns_client NetSchedule client - an instance of CNetScheduleSubmitter. nc_client NetCache client - an instance of CNetCacheAPI. cleanup if true the grid client will automatically remove a job's input data from a storage when the job is done or canceled

Definition at line 52 of file grid_client.cpp.

◆ CGridClient() [2/3]

Constructor.

Parameters
ns_client NetSchedule client - an instance of CNetScheduleSubmitter. storage NetSchedule storage cleanup if true the grid client will automatically remove a job's input data from a storage when the job is done or canceled

Definition at line 44 of file grid_client.cpp.

◆ CGridClient() [3/3]

The copy constructor and the assignment operator are prohibited.

◆ CGridJobBatchSubmitter() [1/2] ◆ CGridJobBatchSubmitter() [2/2]

The copy constructor and the assignment operator are prohibited.

◆ CGridWorkerNode() [1/4] CGridWorkerNode::CGridWorkerNode ( ) inline

Definition at line 540 of file grid_worker.hpp.

◆ CGridWorkerNode() [2/4]

Construct a worker node using class factories.

Definition at line 363 of file grid_worker.cpp.

◆ CGridWorkerNode() [3/4] ◆ CGridWorkerNode() [4/4] ◆ ChangePreferredAffinities() void CNetScheduleExecutor::ChangePreferredAffinities ( const vector< string > *  affs_to_add, const vector< string > *  affs_to_delete  ) ◆ Check() ◆ CheckAffinity() void SInputValidator::CheckAffinity ( const stringvalue ) staticprivate ◆ CheckCancel() void SInputValidator::CheckCancel ( const stringvalue ) staticprivate ◆ CheckCtgTime() ◆ CheckEntry() ◆ CheckGetResults() ◆ CheckIfBatchAlreadySubmitted() void CGridJobBatchSubmitter::CheckIfBatchAlreadySubmitted ( ) private ◆ CheckIfBatchSubmittedAndPrepareNextJob() void CGridJobBatchSubmitter::CheckIfBatchSubmittedAndPrepareNextJob ( ) private ◆ CheckIfJobDone()

Definition at line 1420 of file cgi2rcgi.cpp.

References CHTMLPage::AddTagMap(), CGridCgiContext::DefinePersistentEntry(), CCgi2RCgiApp::DefineRefreshTags(), done, CNetScheduleAPI::eCanceled, CNetScheduleAPI::eDone, CNetScheduleAPI::eFailed, CNetScheduleAPI::eJobNotFound, CNetScheduleAPI::ePending, CNetScheduleAPI::eRunning, CGridCgiContext::GetHTMLPage(), CGridCgiContext::GetJobKey(), CGridCgiContext::GetSelfURL(), kEmptyStr, kSinceTime, LOG_POST, CCgi2RCgiApp::m_CancelGoBackDelay, CCgi2RCgiApp::m_FallBackUrl, CCgi2RCgiApp::m_GridClient, CCgi2RCgiApp::m_Response, Note, CCgi2RCgiApp::OnJobDone(), CCgi2RCgiApp::OnJobFailed(), CGridCgiContext::SelectView(), CCgiResponse::SetHeaderValue(), CCgiApplication::SetRequestId(), and CNetScheduleAPI::StatusToString().

Referenced by CCgi2RCgiApp::CheckJob(), and CCgi2RCgiApp::SubmitJob().

◆ CheckJob()

Definition at line 1054 of file cgi2rcgi.cpp.

References CCgi2RCgiApp::CheckIfJobDone(), CGridCgiContext::Clear(), CCgi2RCgiApp::DefineRefreshTags(), done, CNetScheduleAPI::eJobNotFound, CDiagContext::Extra(), CNetScheduleNotificationHandler::fJSM_Pending, CNetScheduleNotificationHandler::fJSM_Running, CCgiApplication::GetArgs(), GetDiagContext(), CGridCgiContext::GetJobKey(), CGridCgiContext::GetPersistentEntryValue(), CGridCgiContext::GetSelfURL(), CCgi2RCgiApp::GetStatus(), CCgi2RCgiApp::GetStatusAndCtgTime(), CGridCgiContext::HasCtgTime(), CCgi2RCgiApp::m_GridClient, CCgi2RCgiApp::m_NetScheduleAPI, CCgi2RCgiApp::m_RefreshDelay, CCgi2RCgiApp::m_RefreshWait, CDiagContext_Extra::Print(), and CNetScheduleNotificationHandler::WaitForJobEvent().

Referenced by CCgi2RCgiApp::ProcessRequest().

◆ CheckJobKey() void SInputValidator::CheckJobKey ( const stringvalue ) staticprivate ◆ Clear() void CGridCgiContext::Clear ( void  ) private ◆ ClearNode() void CNetScheduleExecutor::ClearNode ( ) ◆ CloseStream() void CGridClient::CloseStream ( ) ◆ CloseStreams() void CWorkerNodeJobContext::CloseStreams ( ) ◆ CNetScheduleAPI() [1/7] ◆ CNetScheduleAPI() [2/7]

Constructs a CNetScheduleAPI object and initializes it with parameters read from the specified configuration object.

Parameters
conf A CConfig object to get the configuration parameters from. conf_section Name of the configuration section where to look for the parameters. If empty string is passed, then the section name "netschedule_api" will be used.

Definition at line 753 of file netschedule_api.cpp.

◆ CNetScheduleAPI() [3/7]

Constructs a CNetScheduleAPI object and initializes it with parameters read from the specified registry object.

Parameters
reg Registry to get the configuration parameters from. conf_section Name of the registry section to look for the configuration parameters in. If empty string is passed, then the section name "netschedule_api" will be used.

Definition at line 747 of file netschedule_api.cpp.

◆ CNetScheduleAPI() [4/7]

Construct the client without linking it to any particular server.

Actual server (host and port) will be extracted from the job key

Parameters
service_name Name of the service to connect to (format: LB service name or host:port) client_name Name of the client program (project) queue_name Name of the job queue

Definition at line 758 of file netschedule_api.cpp.

◆ CNetScheduleAPI() [5/7]

Creates an instance of CNetScheduleAPI and initializes it with parameters read from the application registry.

Parameters
use_app_reg Selects this constructor. The parameter is not used otherwise. conf_section Name of the registry section to look for the configuration parameters in. If empty string is passed, then the section name "netschedule_api" will be used.

Definition at line 741 of file netschedule_api.cpp.

◆ CNetScheduleAPI() [6/7] ◆ CNetScheduleAPI() [7/7] ◆ CNetScheduleExecutor() [1/3] ◆ CNetScheduleExecutor() [2/3] ◆ CNetScheduleExecutor() [3/3] ◆ CNetScheduleJob() ◆ CNetScheduleJobReader() [1/3] ◆ CNetScheduleJobReader() [2/3] ◆ CNetScheduleJobReader() [3/3] ◆ CNetScheduleKey() [1/2] CNetScheduleKey::CNetScheduleKey ( ) inline ◆ CNetScheduleKey() [2/2] ◆ CNetScheduleKeyGenerator() CNetScheduleKeyGenerator::CNetScheduleKeyGenerator ( const stringhost, unsigned  port, const stringqueue_name  ) ◆ CNetScheduleNewJob() ◆ CNetScheduleSubmitter() [1/3] ◆ CNetScheduleSubmitter() [2/3] ◆ CNetScheduleSubmitter() [3/3] ◆ CollectParams() ◆ CommitJob() void CWorkerNodeJobContext::CommitJob ( ) ◆ CommitJobWithFailure() void CWorkerNodeJobContext::CommitJobWithFailure ( const stringerr_msg, bool  no_retries = false  ) ◆ CreateContextWithFlags()

The same as CreateContext(), but allows for a custom set of flags to be specified in the CCgiRequest constructor.

Reimplemented from CCgiApplication.

Definition at line 717 of file cgi2rcgi.cpp.

References CCgiApplication::CreateContextWithFlags(), eCgi_ContentLength, env, eUseRequestContent, CCgiRequest::fDoNotParseContent, flags, CCgiRequest::fSaveRequestContent, CCgiRequest::GetPropertyName(), CCgi2RCgiApp::m_AffinitySource, NULL, out(), CNcbiApplicationAPI::SetEnvironment(), and NStr::StringToUInt().

◆ CreateInstance() [1/2]

template<typename TWorkerNodeJob >

◆ CreateInstance() [2/2] virtual IWorkerNodeJob* IWorkerNodeJobFactory::CreateInstance ( void  ) pure virtual ◆ CRegexpTemplateFilter() ◆ CRemoteCgiApp() CRemoteCgiApp::CRemoteCgiApp ( ) ◆ CWorkerNodeIdleTaskContext() [1/2] ◆ CWorkerNodeIdleTaskContext() [2/2] ◆ CWorkerNodeJobContext() [1/3] CWorkerNodeJobContext::CWorkerNodeJobContext ( ) inline

Definition at line 197 of file grid_worker.hpp.

◆ CWorkerNodeJobContext() [2/3] ◆ CWorkerNodeJobContext() [3/3] ◆ DefinePersistentEntry() ◆ DefineRefreshTags()

Definition at line 1305 of file cgi2rcgi.cpp.

References CGridCgiContext::AddTagMap(), CHTMLPlainText::eNoEncode, NStr::IntToString(), CHttpRetryContext::kHeader_Delay, CHttpRetryContext::kHeader_Url, CCgi2RCgiApp::m_HTMLPassThrough, CCgi2RCgiApp::m_Page, CCgi2RCgiApp::m_Response, CGridCgiContext::NeedMetaRefresh(), and CCgiResponse::SetHeaderValue().

Referenced by CCgi2RCgiApp::CheckIfJobDone(), CCgi2RCgiApp::CheckJob(), CCgi2RCgiApp::OnJobDone(), CCgi2RCgiApp::OnJobFailed(), and CCgi2RCgiApp::SubmitJob().

◆ DeletePreferredAffinities() void CNetScheduleExecutor::DeletePreferredAffinities ( const vector< string > &  affs_to_del ) inline ◆ DisableDefaultRequestEventLogging() ◆ Do() ◆ ErrCodeToHTTPStatusCode() unsigned CNetScheduleException::ErrCodeToHTTPStatusCode ( ) const

Definition at line 120 of file netschedule_api_expt.cpp.

References CNetScheduleException::eAccessDenied, CNetScheduleException::eAffinityNotFound, CNetScheduleException::eAuthenticationError, CNetScheduleException::eClientDataVersionMismatch, CNetScheduleException::eDataTooLong, CNetScheduleException::eDuplicateName, CNetScheduleException::eGroupNotFound, CNetScheduleException::eInvalidAuthToken, CNetScheduleException::eInvalidClient, CNetScheduleException::eInvalidJobStatus, CNetScheduleException::eInvalidParameter, CNetScheduleException::eJobNotFound, CNetScheduleException::eKeyFormatError, CNetScheduleException::eObsoleteCommand, CNetScheduleException::ePrefAffExpired, CNetScheduleException::eProtocolSyntaxError, CNetScheduleException::eShuttingDown, CNetScheduleException::eSubmitsDisabled, CNetScheduleException::eTooManyPendingJobs, CNetScheduleException::eTooManyPreferredAffinities, CNetScheduleException::eTryAgain, CNetScheduleException::eUnknownQueue, CNetScheduleException::eUnknownQueueClass, CNetScheduleException::eUnknownService, and CException::GetErrCode().

Referenced by CNetScheduleHandler::OnMessage(), and CNetScheduleHandler::x_ProcessMsgQueue().

◆ ExtractWarningType() ◆ ForceSingleThread() void CGridWorkerNode::ForceSingleThread ( ) ◆ Generate() [1/2] void CNetScheduleKeyGenerator::Generate ( stringkey, unsigned  id  ) const ◆ Generate() [2/2] string CNetScheduleKeyGenerator::Generate ( unsigned  id ) const inline ◆ GenerateCompoundID() ◆ GetAdmin() ◆ GetAppName() [1/3] virtual string IWorkerNodeJobFactory::GetAppName ( void  ) const inlinevirtual ◆ GetAppName() [2/3]

template<typename TWorkerNodeJob >

◆ GetAppName() [3/3] string CGridWorkerNode::GetAppName ( void  ) const ◆ GetAppVersion() [1/2] virtual string IWorkerNodeJobFactory::GetAppVersion ( void  ) const inlinevirtual ◆ GetAppVersion() [2/2] ◆ GetArgs() virtual const CArgs& IWorkerNodeInitBaseContext::GetArgs ( ) const pure virtual ◆ GetBatch() ◆ GetBlobSize() size_t CGridClient::GetBlobSize ( ) const inline ◆ GetCGIContext() ◆ GetCheckStatusPeriod() unsigned CGridWorkerNode::GetCheckStatusPeriod ( ) const ◆ GetCleanupEventSource() [1/3] ◆ GetCleanupEventSource() [2/3] ◆ GetCleanupEventSource() [3/3] ◆ GetClientName() [1/3] ◆ GetClientName() [2/3] const string & CWorkerNodeJobContext::GetClientName ( ) const ◆ GetClientName() [3/3] const string & CGridWorkerNode::GetClientName ( ) const ◆ GetCode() ◆ GetCommitJobInterval() unsigned CGridWorkerNode::GetCommitJobInterval ( ) const ◆ GetCommitStatus() ◆ GetCommitStatusDescription() ◆ GetConfig() virtual const IRegistry& IWorkerNodeInitBaseContext::GetConfig ( ) const pure virtual ◆ GetDeadline() ◆ GetEntryValue() ◆ GetEnvironment() ◆ GetErrCodeDescription()

Definition at line 151 of file netschedule_api_expt.cpp.

References CNetScheduleException::eAccessDenied, CNetScheduleException::eAffinityNotFound, CNetScheduleException::eAuthenticationError, CNetScheduleException::eClientDataVersionMismatch, CNetScheduleException::eDataTooLong, CNetScheduleException::eDuplicateName, CNetScheduleException::eGroupNotFound, CNetScheduleException::eInternalError, CNetScheduleException::eInvalidAuthToken, CNetScheduleException::eInvalidClient, CNetScheduleException::eInvalidJobStatus, CNetScheduleException::eInvalidParameter, CNetScheduleException::eJobNotFound, CNetScheduleException::eObsoleteCommand, CNetScheduleException::ePrefAffExpired, CNetScheduleException::eProtocolSyntaxError, CNetScheduleException::eShuttingDown, CNetScheduleException::eSubmitsDisabled, CNetScheduleException::eTooManyPreferredAffinities, CNetScheduleException::eTryAgain, CNetScheduleException::eUnknownQueue, CNetScheduleException::eUnknownQueueClass, CNetScheduleException::eUnknownService, and CNetScheduleException::GetErrCodeString().

Referenced by CNetScheduleServerListener::OnErrorImpl().

◆ GetErrCodeString() [1/4] const char * CNetScheduleException::GetErrCodeString ( void  ) const overridevirtual ◆ GetErrCodeString() [2/4]

Definition at line 85 of file netschedule_api_expt.cpp.

References CNetScheduleException::eAccessDenied, CNetScheduleException::eAffinityNotFound, CNetScheduleException::eAuthenticationError, CNetScheduleException::eClientDataVersionMismatch, CNetScheduleException::eDataTooLong, CNetScheduleException::eDuplicateName, CNetScheduleException::eGroupNotFound, CNetScheduleException::eInternalError, CNetScheduleException::eInvalidAuthToken, CNetScheduleException::eInvalidClient, CNetScheduleException::eInvalidJobStatus, CNetScheduleException::eInvalidParameter, CNetScheduleException::eJobNotFound, CNetScheduleException::eKeyFormatError, CNetScheduleException::eObsoleteCommand, CNetScheduleException::ePrefAffExpired, CNetScheduleException::eProtocolSyntaxError, CNetScheduleException::eShuttingDown, CNetScheduleException::eSubmitsDisabled, CNetScheduleException::eTooManyPendingJobs, CNetScheduleException::eTooManyPreferredAffinities, CNetScheduleException::eTryAgain, CNetScheduleException::eUnknownQueue, CNetScheduleException::eUnknownQueueClass, and CNetScheduleException::eUnknownService.

◆ GetErrCodeString() [3/4] virtual const char* CGridClientException::GetErrCodeString ( void  ) const inlineoverridevirtual ◆ GetErrCodeString() [4/4] virtual const char* CGridWorkerNodeException::GetErrCodeString ( void  ) const inlineoverridevirtual ◆ GetErrorMessage() ◆ GetExecutor() ◆ GetGridClient() [1/2] ◆ GetGridClient() [2/2] CGridClient& CGridCgiApplication::GetGridClient ( void  ) inlineprotected ◆ GetHiddenFields() string CGridCgiContext::GetHiddenFields ( ) const ◆ GetHTMLPage() CHTMLPage& CGridCgiContext::GetHTMLPage ( void  ) inline ◆ GetIdleTask() [1/2] ◆ GetIdleTask() [2/2]

template<typename TWorkerNodeJob , typename TWorkerNodeIdleTask >

◆ GetInputBlobSize() size_t CWorkerNodeJobContext::GetInputBlobSize ( ) const ◆ GetIStream() [1/2] ◆ GetIStream() [2/2] ◆ GetJob() [1/5] ◆ GetJob() [2/5] ◆ GetJob() [3/5] ◆ GetJob() [4/5]

Get a pending job.

When function returns TRUE, job information is written to the 'job' structure, and job status is changed to eRunning. This client (the worker node) becomes responsible for execution or returning of the job. If there are no jobs in the queue, the function returns FALSE immediately and this call has to be repeated.

Parameters
job NetSchedule job description structure. affinity_list Comma-separated list of affinity tokens. deadline Deadline for waiting for a matching job to appear in the queue.
Returns
TRUE if job has been returned from the queue and its input fields are set. FALSE means queue is empty or for some other reason NetSchedule decided not to give a job to this node (e.g. no jobs with matching affinities).

Definition at line 282 of file netschedule_api_executor.cpp.

References CNetScheduleNewJob::affinity, cmd, CNetServer::ExecWithRetry(), g_AppendClientIPSessionIDHitID(), CNetScheduleNotificationHandler::MkBaseGETCmd(), NULL, CNetServer::SExecResult::response, s_ParseGetJobResponse(), and CNetScheduleJob::server.

Referenced by CGridCommandLineInterfaceApp::Cmd_RequestJob(), CGridCommandLineInterfaceApp::NetScheduleSanityCheck(), and CSampleNetScheduleNode::Run().

◆ GetJob() [5/5] ◆ GetJobBatchSubmitter() ◆ GetJobDetails() [1/2]

Get job details.

Definition at line 929 of file netschedule_api.cpp.

References CNetScheduleNewJob::affinity, cmd, CNetScheduleAPI::eCanceled, CNetScheduleAPI::eConfirmed, CNetScheduleAPI::eDone, CNetScheduleAPI::eEmptyMask, CNetScheduleAPI::eFailed, CNetScheduleAPI::ePending, CNetScheduleAPI::eReadFailed, CNetScheduleAPI::eReading, CNetScheduleJob::error_msg, CNetScheduleAPI::eRunning, NStr::fConvErr_NoThrow, g_AppendClientIPSessionIDHitID(), CNetScheduleNewJob::input, CNetScheduleNewJob::job_id, CNetScheduleAPI::m_Impl, CNetScheduleNewJob::mask, CNetScheduleJob::output, CNetScheduleJob::progress_msg, CNetScheduleJob::ret_code, s_SetJobExpTime(), s_SetPauseMode(), NStr::StringToInt(), and CNetScheduleAPI::StringToStatus().

Referenced by CGridRPCBaseClient< CAsnBinCompressed >::Ask(), CGridRPCBaseClient< CAsnBinCompressed >::AskStream(), CGridCommandLineInterfaceApp::Cmd_GetJobInput(), CGridCommandLineInterfaceApp::Cmd_GetJobOutput(), CGridCommandLineInterfaceApp::Cmd_Replay(), g_ProcessJobInfo(), CNetScheduleNotificationHandler::GetJobDetailsIfCompleted(), CCgi2RCgiApp::ListenJobs(), CNetScheduleNotificationHandler::WaitForJobCompletion(), and CGridRPCBaseClient< CAsnBinCompressed >::x_GetJobById().

◆ GetJobDetails() [2/2] ◆ GetJobFactory() ◆ GetJobInput() [1/3] ◆ GetJobInput() [2/3] const string & CWorkerNodeJobContext::GetJobInput ( ) const

Get a job input string.

This string can be used in two ways. 1. It can be an input data for a job (if that data is short) If it is so don't use GetIStream method. 2. It holds a key to a data stored in an external data storage. (NetCache) In this case use GetIStream method to get a stream with an input data for the job

Definition at line 63 of file wn_main_loop.cpp.

References CWorkerNodeJobContext::m_Impl.

◆ GetJobInput() [3/3] ◆ GetJobKey() [1/3] string& CGridCgiContext::GetJobKey ( void  ) inline ◆ GetJobKey() [2/3] const string & CWorkerNodeJobContext::GetJobKey ( void  ) const ◆ GetJobKey() [3/3] const string & CGridCgiContext::GetJobKey ( void  ) const ◆ GetJobMask() ◆ GetJobNumber() unsigned int CWorkerNodeJobContext::GetJobNumber ( ) const ◆ GetJobOutput() [1/3] ◆ GetJobOutput() [2/3] const string & CWorkerNodeJobContext::GetJobOutput ( ) const ◆ GetJobOutput() [3/3] ◆ GetJobProgressMessage() const string& CGridCgiContext::GetJobProgressMessage ( void  ) const inline ◆ GetJobReader() ◆ GetJobStatus() [1/2] ◆ GetJobStatus() [2/2] ◆ GetJobVersion() [1/3]

template<typename TWorkerNodeJob >

◆ GetJobVersion() [2/3] string CRemoteCgiApp::GetJobVersion ( ) const virtual ◆ GetJobVersion() [3/3] virtual string IWorkerNodeJobFactory::GetJobVersion ( ) const pure virtual ◆ GetJqueryCallback() string& CGridCgiContext::GetJqueryCallback ( ) inline ◆ GetListenJobs() ◆ GetMaxServerInputSize() size_t CGridClient::GetMaxServerInputSize ( ) ◆ GetMaxThreads() unsigned CGridWorkerNode::GetMaxThreads ( ) const ◆ GetNetCacheAPI() [1/3] ◆ GetNetCacheAPI() [2/3] ◆ GetNetCacheAPI() [3/3] virtual CNetCacheAPI IWorkerNodeInitContext::GetNetCacheAPI ( ) const pure virtual

Get the shared NetCacheAPI object used by the worker node framework.

Implemented in SGridWorkerNodeImpl.

◆ GetNetScheduleAPI() [1/2] ◆ GetNetScheduleAPI() [2/2] virtual CNetScheduleAPI IWorkerNodeInitContext::GetNetScheduleAPI ( ) const pure virtual ◆ GetNetScheduleSubmitter() ◆ GetNSExecutor() ◆ GetOStream() [1/3] ◆ GetOStream() [2/3] ◆ GetOStream() [3/3] ◆ GetPageTemplate() virtual string CGridCgiApplication::GetPageTemplate ( void  ) const protectedpure virtual ◆ GetPageTitle() virtual string CGridCgiApplication::GetPageTitle ( void  ) const protectedpure virtual ◆ GetPersistentEntries() ◆ GetPersistentEntryValue() ◆ GetProgramVersion() [1/3] const string & CNetScheduleAPI::GetProgramVersion ( void  ) const ◆ GetProgramVersion() [2/3] virtual string CGridClientApp::GetProgramVersion ( void  ) const pure virtual ◆ GetProgramVersion() [3/3] virtual string CGridCgiApplication::GetProgramVersion ( void  ) const pure virtual ◆ GetProgressMessage() string CGridClient::GetProgressMessage ( )

Get a job interim message.

Definition at line 259 of file grid_client.cpp.

References buffer, CNetCacheAPI::GetCompoundIDPool(), CGridClient::GetNetCacheAPI(), CGridClient::GetNetScheduleSubmitter(), CNetScheduleSubmitter::GetProgressMsg(), CNetCacheKey::IsValidKey(), CGridClient::m_Job, CGridClient::m_NetCacheAPI, CGridClient::m_UseProgress, CNetScheduleJob::progress_msg, CNetCacheAPI::ReadData(), and string.

Referenced by CGridCgiApplication::x_CheckJobStatus().

◆ GetProgressMsg() [1/3] ◆ GetProgressMsg() [2/3] ◆ GetProgressMsg() [3/3] ◆ GetQueryStringEntryValue() void CGridCgiContext::GetQueryStringEntryValue ( const stringentry_name, stringvalue  ) const ◆ GetQueueName() [1/4] ◆ GetQueueName() [2/4] const string & CWorkerNodeJobContext::GetQueueName ( ) const ◆ GetQueueName() [3/4] ◆ GetQueueName() [4/4] ◆ GetQueueParams() [1/2] ◆ GetQueueParams() [2/2] ◆ GetQueueTimeout() unsigned CGridWorkerNode::GetQueueTimeout ( ) const ◆ GetRequestEntryValue() void CGridCgiContext::GetRequestEntryValue ( const stringentry_name, stringvalue  ) const ◆ GetReturnCode() int CGridClient::GetReturnCode ( ) ◆ GetSelfURL() [1/2] string CGridCgiContext::GetSelfURL ( bool  include_entries = true ) const ◆ GetSelfURL() [2/2] string CGridCgiContext::GetSelfURL ( void  ) const

Get Self URL.

Definition at line 75 of file grid_cgiapp.cpp.

References map_checker< Container >::begin(), map_checker< Container >::end(), first(), CCgiContext::GetSelfURL(), CGridCgiContext::m_CgiContext, CGridCgiContext::m_PersistedEntries, NStr::URLEncode(), and rapidjson::value.

Referenced by CCgi2RCgiApp::CheckIfJobDone(), CCgi2RCgiApp::CheckJob(), CCgi2RCgiApp::PopulatePage(), CGridCgiApplication::ProcessRequest(), and CCgi2RCgiApp::SubmitJob().

◆ GetServerOutputSize() size_t CGridWorkerNode::GetServerOutputSize ( ) ◆ GetServerParams() [1/2] ◆ GetServerParams() [2/2] ◆ GetService()

Definition at line 908 of file netschedule_api.cpp.

References CNetScheduleAPI::m_Impl.

Referenced by SNetScheduleJobReaderImpl::CImpl::CheckEntry(), CGridCommandLineInterfaceApp::Cmd_Exec(), CGridCommandLineInterfaceApp::Cmd_QueueInfo(), CGridCommandLineInterfaceApp::Cmd_Resume(), CGridCommandLineInterfaceApp::Cmd_ServerInfo(), CGridCommandLineInterfaceApp::Cmd_Stats(), CGridCommandLineInterfaceApp::Cmd_Suspend(), NAutomation::SNetScheduleServer::Create(), NAutomation::SNetScheduleService::ExecGetServers(), g_GetWorkerNodeInfo(), g_QueueClassInfoToJson(), g_QueueInfoToJson(), g_ReconfAndReturnJson(), g_ResumeNetSchedule(), g_SuspendNetSchedule(), NAutomation::SNetScheduleService::GetService(), NAutomation::SWorkerNode::GetService(), CCgi2RCgiApp::GetStatus(), CGridCommandLineInterfaceApp::PrintNetScheduleStats(), CGridCommandLineInterfaceApp::PrintNetScheduleStats_Generic(), CGetStatisticsProcessor::Process(), CNetScheduleAPI::SetCommunicationTimeout(), and CGridCommandLineInterfaceApp::SetUp_NetScheduleCmd().

◆ GetServiceName() [1/2] ◆ GetServiceName() [2/2] const string & CGridWorkerNode::GetServiceName ( ) const ◆ GetShutdownLevel()

Check if job processing must be aborted.

This method must be called periodically from within the Do() method to check whether it needs to stop processing the current job. If GetShutdownLevel() returns eShutdownImmediate or eDie, the Do() method must immediately return its job to the server by calling context.ReturnJob() and return a non-zero integer to the caller.

If GetShutdownLevel() returns eNormalShutdown, the Do() method is free to decide whether the job processing must be aborted or completed.

Aside from the natural reason for GetShutdownLevel() to return eNormalShutdown, eShutdownImmediate, or eDie, (that is, when a worker node shutdown has been requested), this method can also return eShutdownImmediate when the NetSchedule server is not expecting the current job to complete. This can happen due to multiple reasons: 1. The job has been explicitly cancelled by the submitter or administrator. 2. The job was rescheduled to another worker node and has been successfully finished. 3. The job has expired.

Definition at line 282 of file wn_main_loop.cpp.

References CWorkerNodeJobContext::m_Impl.

Referenced by CJobContextProcessWatcher::OnStart(), CJobContextProcessWatcher::Watch(), and SWorkerNodeJobContextImpl::x_RunJob().

◆ GetStartupTime() time_t CGridWorkerNode::GetStartupTime ( ) const ◆ GetStatus() [1/2] ◆ GetStatus() [2/2]

Definition at line 1336 of file cgi2rcgi.cpp.

References CHTMLPage::AddTagMap(), CNetScheduleAPI::eJobNotFound, ERR_POST, CNetScheduleAPI::eRunning, CNetService::ExcludeServer(), CNetScheduleAPI::GetAdmin(), CNetScheduleAPIExt::GetCompoundIDPool(), GetFastLocalTime(), CGridCgiContext::GetHTMLPage(), CGridCgiContext::GetJobKey(), CException::GetMsg(), CGridCgiContext::GetPersistentEntryValue(), CNetScheduleAdmin::GetQueueInfo(), CNetServiceIterator::GetServer(), CNetService::GetServer(), CNetScheduleAPI::GetService(), ncbi::grid::netcache::search::fields::key, kSinceTime, CCgi2RCgiApp::m_GridClient, CCgi2RCgiApp::m_NetScheduleAPI, CCgi2RCgiApp::m_TargetEncodeMode, NStr::StringToUInt(), and NStr::StringToUInt8().

Referenced by CCgi2RCgiApp::CheckJob().

◆ GetStatusAndCtgTime() ◆ GetSubmitter()

Create an instance of CNetScheduleSubmitter.

Definition at line 886 of file netschedule_api.cpp.

References CNetScheduleAPI::m_Impl.

Referenced by CGridRPCBaseClient< CAsnBinCompressed >::Ask(), CGridRPCBaseClient< CAsnBinCompressed >::AskStream(), CGI2GRID_ComposeHtmlPage(), CGridCommandLineInterfaceApp::Cmd_CancelJob(), CGridCommandLineInterfaceApp::Cmd_JobInfo(), CCgi2RCgiApp::Init(), CGridClientApp::Init(), CGridCgiApplication::InitGridClient(), CSampleNetScheduleClient::Run(), CGridCommandLineInterfaceApp::SetUp_NetScheduleCmd(), and CGridRPCBaseClient< CAsnBinCompressed >::x_GetJobById().

◆ GetTotalMemoryLimit() Uint8 CGridWorkerNode::GetTotalMemoryLimit ( ) const ◆ GetTotalTimeLimit() unsigned CGridWorkerNode::GetTotalTimeLimit ( ) const ◆ GetWorkerNode() ◆ HandleEvent() ◆ HasCtgTime() bool CGridCgiContext::HasCtgTime ( ) const inline ◆ Init() [1/8] void CGridWorkerNode::Init ( void  ) ◆ Init() [2/8] void CCgi2RCgiApp::Init ( void  ) virtual

This method is called on the CGI application initialization – before starting to process a HTTP request or even receiving one.

No HTTP request (or context) is available at the time of call.

If you decide to override it, remember to call CCgiApplication::Init().

Reimplemented from CCgiApplicationCached.

Definition at line 549 of file cgi2rcgi.cpp.

References SInputValidator::AddAffinityEntry(), CGridClient::eAutomaticCleanup, CHTMLPlainText::eHTMLEncode, CHTMLPlainText::eJSONEncode, CGridClient::eManualCleanup, CHTMLPlainText::eNoEncode, CGridClient::eProgressMsgOff, CGridClient::eProgressMsgOn, IRegistry::eReturn, CArgDescriptions::eString, eUseQueryString, eUseRequestContent, CCgiRequest::fCaseInsensitiveArgs, CCgiRequest::fDoNotParseContent, flags, NStr::fSplit_MergeDelimiters, NStr::fSplit_Truncate, CNcbiApplicationAPI::GetArguments(), CNcbiApplicationAPI::GetRWConfig(), CNetScheduleAPI::GetSubmitter(), incs, CCgiApplicationCached::Init(), kEmptyStr, CCgi2RCgiApp::m_AddJobIdToHeader, CCgi2RCgiApp::m_AffinityName, CCgi2RCgiApp::m_AffinitySetLimit, CCgi2RCgiApp::m_AffinitySource, CCgi2RCgiApp::m_CancelGoBackDelay, CCgi2RCgiApp::m_ContentType, CCgi2RCgiApp::m_DateFormat, CCgi2RCgiApp::m_DisplayDonePage, CCgi2RCgiApp::m_ElapsedTimeFormat, CCgi2RCgiApp::m_ExceptionMessage, CCgi2RCgiApp::m_FallBackDelay, CCgi2RCgiApp::m_FallBackUrl, CCgi2RCgiApp::m_FirstDelay, CCgi2RCgiApp::m_GridClient, CCgi2RCgiApp::m_HtmlIncs, CCgi2RCgiApp::m_HTMLPassThrough, CCgi2RCgiApp::m_HtmlTemplate, CCgi2RCgiApp::m_InputValidator, CCgi2RCgiApp::m_InterceptJQueryCallback, CCgi2RCgiApp::m_NetCacheAPI, CCgi2RCgiApp::m_NetScheduleAPI, CCgi2RCgiApp::m_PortAdded, CCgi2RCgiApp::m_RefreshDelay, CCgi2RCgiApp::m_RefreshWait, CCgi2RCgiApp::m_TargetEncodeMode, CCgi2RCgiApp::m_Title, NCBI_THROW_FMT, CCgiApplication::RegisterDiagFactory(), CCgiApplication::SetRequestFlags(), CCgiApplication::SetupArgDescriptions(), and NStr::Split().

◆ Init() [3/8] ◆ Init() [4/8]

template<typename TWorkerNodeJob >

◆ Init() [5/8]

template<typename TWorkerNodeJob , typename TWorkerNodeIdleTask >

◆ Init() [6/8] void CGridClientApp::Init ( void  ) virtual

If you override this method, do call CGridClientApp::Init() from inside your overriding method.

Reimplemented from CNcbiApplicationAPI.

Reimplemented in CRemoteAppClientSampleApp, and CGridClientSampleApp.

Definition at line 42 of file grid_client_app.cpp.

References cleanup(), CGridClient::eAutomaticCleanup, CGridClient::eManualCleanup, CGridClient::eProgressMsgOff, CGridClient::eProgressMsgOn, CNcbiApplicationAPI::GetConfig(), CGridClientApp::GetProgramVersion(), CNetScheduleAPI::GetSubmitter(), CNcbiApplicationAPI::Init(), kEmptyStr, CGridClientApp::m_GridClient, CNetScheduleAPI::SetProgramVersion(), CGridClientApp::UseAutomaticCleanup(), and CGridClientApp::UseProgressMessage().

Referenced by CRemoteAppClientSampleApp::Init(), and CGridClientSampleApp::Run().

◆ Init() [7/8] void CGridCgiApplication::Init ( void  ) virtual ◆ Init() [8/8] void CRemoteCgiApp::Init ( void  ) virtual ◆ InitGridClient() void CGridCgiApplication::InitGridClient ( ) protected

Initialize grid client.

Definition at line 195 of file grid_cgiapp.cpp.

References CGridClient::eAutomaticCleanup, CGridClient::eManualCleanup, CGridClient::eProgressMsgOff, CGridClient::eProgressMsgOn, IRegistry::eReturn, IRegistry::GetBool(), CNcbiApplicationAPI::GetConfig(), IRegistry::GetInt(), CGridCgiApplication::GetProgramVersion(), CNetScheduleAPI::GetSubmitter(), kEmptyStr, CGridCgiApplication::m_FirstDelay, CGridCgiApplication::m_GridClient, CGridCgiApplication::m_NetCacheAPI, CGridCgiApplication::m_NSClient, CGridCgiApplication::m_RefreshDelay, and CNetScheduleAPI::SetProgramVersion().

Referenced by CGridCgiApplication::Init().

◆ InterruptReading() void CNetScheduleJobReader::InterruptReading ( ) ◆ IsCachingNeeded() ◆ IsHostInAdminHostsList() ◆ IsJobCommitted() bool CWorkerNodeJobContext::IsJobCommitted ( ) const ◆ IsJobLost() bool CWorkerNodeJobContext::IsJobLost ( ) const ◆ IsLogRequested() bool CWorkerNodeJobContext::IsLogRequested ( ) const ◆ IsShutdownRequested() bool CWorkerNodeIdleTaskContext::IsShutdownRequested ( ) const ◆ IsSuspended() bool CGridWorkerNode::IsSuspended ( ) const ◆ JobDelayExpiration() [1/2] ◆ JobDelayExpiration() [2/2] void CWorkerNodeJobContext::JobDelayExpiration ( unsigned  runtime_inc )

Increment job execution timeout.

When node picks up the job for execution it may periodically communicate to the server that job is still alive and prolong job execution timeout, so job server does not try to reschedule.

Parameters
runtime_inc Estimated time in seconds(from the current moment) to finish the job.

Definition at line 260 of file wn_main_loop.cpp.

References CWorkerNodeJobContext::m_Impl.

Referenced by CJobContextProcessWatcher::Watch().

◆ JobStopRequested() virtual bool CGridCgiApplication::JobStopRequested ( void  ) const inlineprotectedvirtual ◆ ListenJobs()

Definition at line 933 of file cgi2rcgi.cpp.

References CNetScheduleAPI::eJobNotFound, CNetScheduleException::eJobNotFound, ERR_POST, SInputValidator::GetDeadline(), CException::GetErrCode(), CNetScheduleAPI::GetJobDetails(), SInputValidator::GetListenJobs(), CCgi2RCgiApp::m_GridClient, CCgi2RCgiApp::m_NetScheduleAPI, CCgi2RCgiApp::m_Response, out(), CCgiResponse::out(), s_IsPendingOrRunning(), CNetScheduleAPI::StringToStatus(), and Warning().

Referenced by CCgi2RCgiApp::ProcessRequest().

◆ LoadQueryStringTags() ◆ main() ◆ NCBI_EXCEPTION_DEFAULT() [1/3] ◆ NCBI_EXCEPTION_DEFAULT() [2/3] ◆ NCBI_EXCEPTION_DEFAULT() [3/3] ◆ NeedMetaRefresh() bool CGridCgiContext::NeedMetaRefresh ( ) const inline ◆ NeedRenderPage() [1/2] bool CGridCgiContext::NeedRenderPage ( ) const inline ◆ NeedRenderPage() [2/2] void CGridCgiContext::NeedRenderPage ( bool  value ) inline ◆ NeedRunAgain() bool CWorkerNodeIdleTaskContext::NeedRunAgain ( ) const inline ◆ Notify() ◆ OnBeginProcessRequest() virtual void CGridCgiApplication::OnBeginProcessRequest ( CGridCgiContext &  ) inlineprotectedvirtual ◆ OnEndProcessRequest() virtual void CGridCgiApplication::OnEndProcessRequest ( CGridCgiContext &  ) inlineprotectedvirtual ◆ OnJobCanceled() ◆ OnJobDone() [1/2] ◆ OnJobDone() [2/2] ◆ OnJobFailed() [1/2] ◆ OnJobFailed() [2/2]

Definition at line 1583 of file cgi2rcgi.cpp.

References ctx, CCgi2RCgiApp::DefineRefreshTags(), kEmptyStr, kSinceTime, CCgi2RCgiApp::m_FallBackDelay, CCgi2RCgiApp::m_FallBackUrl, CCgi2RCgiApp::m_TargetEncodeMode, and msg().

Referenced by CCgi2RCgiApp::CheckIfJobDone(), CCgi2RCgiApp::ProcessRequest(), CCgi2RCgiApp::ReadJob(), and CCgi2RCgiApp::SubmitJob().

◆ OnJobPending() ◆ OnJobRunning() ◆ OnJobSubmitted() ◆ OnQueueIsBusy() ◆ operator const SGridWorkerNodeImpl *() ◆ operator const SNetScheduleAPIImpl *() ◆ operator const SNetScheduleExecutorImpl *() ◆ operator const SNetScheduleJobReaderImpl *() ◆ operator const SNetScheduleSubmitterImpl *() ◆ operator const SWorkerNodeJobContextImpl *() ◆ operator SGridWorkerNodeImpl *() ◆ operator SNetScheduleAPIImpl *() ◆ operator SNetScheduleExecutorImpl *() ◆ operator SNetScheduleJobReaderImpl *() ◆ operator SNetScheduleSubmitterImpl *() ◆ operator SWorkerNodeJobContextImpl *() ◆ operator()() ◆ operator--() [1/12] ◆ operator--() [2/12] ◆ operator--() [3/12] ◆ operator--() [4/12] ◆ operator--() [5/12] ◆ operator--() [6/12] ◆ operator--() [7/12] ◆ operator--() [8/12] ◆ operator--() [9/12] ◆ operator--() [10/12] ◆ operator--() [11/12] ◆ operator--() [12/12] ◆ operator->() [1/12] ◆ operator->() [2/12] ◆ operator->() [3/12] ◆ operator->() [4/12] ◆ operator->() [5/12] ◆ operator->() [6/12] ◆ operator->() [7/12] ◆ operator->() [8/12] ◆ operator->() [9/12] ◆ operator->() [10/12] ◆ operator->() [11/12] ◆ operator->() [12/12] ◆ operator<<() ◆ operator=() [1/10] ◆ operator=() [2/10] ◆ operator=() [3/10] ◆ operator=() [4/10] ◆ operator=() [5/10] ◆ operator=() [6/10] ◆ operator=() [7/10] ◆ operator=() [8/10] ◆ operator=() [9/10] ◆ operator=() [10/10] ◆ ParseJobKey()

Definition at line 62 of file netschedule_key.cpp.

References eCIT_DatabaseName, eCIT_Host, eCIT_ID, eCIT_IPv4SockAddr, eCIT_Port, CCompoundIDPool::FromString(), CCompoundIDField::GetDatabaseName(), CCompoundID::GetFirst(), CCompoundIDField::GetHost(), CCompoundIDField::GetID(), CCompoundIDField::GetIPv4Address(), CCompoundIDField::GetPort(), isdigit(), NS_KEY_V1_PREFIX, NS_KEY_V1_PREFIX_LEN, CSocketAPI::ntoa(), NULL, and dtl::version.

Referenced by CGridCommandLineInterfaceApp::Cmd_WhatIs(), and g_WhatIs().

◆ PopulatePage()

Definition at line 1175 of file cgi2rcgi.cpp.

References CGridCgiContext::AddTagMap(), CHTMLPage::AddTagMap(), CTimeSpan::AsString(), CTime::AsString(), map_checker< Container >::begin(), map_checker< Container >::end(), CHTMLPlainText::eNoEncode, ERR_POST, GetFastLocalTime(), CGridCgiContext::GetHTMLPage(), CGridCgiContext::GetJobKey(), CGridCgiContext::GetPersistentEntries(), CGridCgiContext::GetPersistentEntryValue(), CGridCgiContext::GetSelfURL(), NStr::HtmlEncode(), HTTP_NCBI_JSID, kSinceTime, CCgi2RCgiApp::m_AddJobIdToHeader, CCgi2RCgiApp::m_DateFormat, CCgi2RCgiApp::m_ElapsedTimeFormat, CCgi2RCgiApp::m_GridClient, CCgi2RCgiApp::m_HTMLPassThrough, CCgi2RCgiApp::m_Page, CCgi2RCgiApp::m_Response, CCgi2RCgiApp::m_TargetEncodeMode, CCgiResponse::SetHeaderValue(), CGridCgiContext::SetJobProgressMessage(), CTime::SetTimeT(), and NStr::StringToInt().

Referenced by CCgi2RCgiApp::ProcessRequest().

◆ PrepareJobData() virtual void CGridCgiApplication::PrepareJobData ( CGridClientgrid_client ) protectedpure virtual ◆ PrepareNextJob() void CGridJobBatchSubmitter::PrepareNextJob ( ) ◆ ProcessRequest() [1/2]

Do not override this method yourself! – it includes all the GRIDCGI specific machinery.

If you override it, do call CGridCgiApplication::ProcessRequest() from inside your overriding method.

Implements CCgiApplication.

Definition at line 242 of file grid_cgiapp.cpp.

References CGridClient::CancelJob(), CGridCgiContext::Clear(), CGridCgiApplication::CollectParams(), ctx, CNCBINode::eHTML, ERR_POST_X, CNetScheduleException::eTooManyPendingJobs, CGridCgiContext::GetEntryValue(), CException::GetErrCode(), CGridCgiApplication::GetGridClient(), CGridCgiContext::GetHiddenFields(), CGridCgiApplication::GetPageTemplate(), CGridCgiApplication::GetPageTitle(), CNcbiApplicationAPI::GetRWConfig(), CGridCgiContext::GetSelfURL(), kGridCgiForm, CGridCgiApplication::m_FirstDelay, CGridCgiApplication::m_RefreshDelay, CGridCgiApplication::m_Response, CGridCgiContext::NeedRenderPage(), CGridCgiApplication::OnBeginProcessRequest(), CGridCgiApplication::OnEndProcessRequest(), CGridCgiApplication::OnJobFailed(), CGridCgiApplication::OnJobSubmitted(), CGridCgiApplication::OnQueueIsBusy(), CCgiResponse::out(), CGridCgiApplication::PrepareJobData(), CGridCgiContext::PullUpPersistentEntry(), CGridCgiApplication::RenderRefresh(), CGridCgiContext::SetJobKey(), CGridCgiApplication::ShowParamsPage(), SleepMilliSec(), CGridClient::Submit(), CException::what(), CCgiResponse::WriteHeader(), CGridCgiApplication::x_CheckJobStatus(), and CGridCgiApplication::x_JobStopRequested().

◆ ProcessRequest() [2/2]

This is the method you should override.

It is called whenever the CGI application gets a syntaxically valid HTTP request.

Parameters
context Contains the parameters of the HTTP request
Returns
Exit code; it must be zero on success

Implements CCgiApplication.

Definition at line 807 of file cgi2rcgi.cpp.

References CNetScheduleAPIExt::AddToClientNode(), CCgi2RCgiApp::CheckJob(), ctx, eCgi_QueryString, eCgi_ServerPort, CHTMLPlainText::eHTMLEncode, entries, env, ERR_POST, CCgiRequest::GetEntries(), CGridCgiContext::GetJobKey(), CGridCgiContext::GetJqueryCallback(), CCgiRequest::GetPropertyName(), kGridCgiForm, kPlainTextView, kSinceTime, CCgi2RCgiApp::ListenJobs(), CGridCgiContext::LoadQueryStringTags(), CCgi2RCgiApp::m_ContentType, CCgi2RCgiApp::m_CustomHTTPHeader, CCgi2RCgiApp::m_ExceptionMessage, CCgi2RCgiApp::m_HTMLPassThrough, CCgi2RCgiApp::m_HtmlTemplate, CCgi2RCgiApp::m_InputValidator, CCgi2RCgiApp::m_InterceptJQueryCallback, CCgi2RCgiApp::m_NetScheduleAPI, CCgi2RCgiApp::m_Page, CCgi2RCgiApp::m_PortAdded, CCgi2RCgiApp::m_Response, CCgi2RCgiApp::m_TargetEncodeMode, CCgi2RCgiApp::m_Title, CGridCgiContext::NeedRenderPage(), CCgi2RCgiApp::OnJobFailed(), CCgi2RCgiApp::PopulatePage(), CGridCgiContext::PullUpPersistentEntry(), CCgi2RCgiApp::RenderPage(), CCgiResponse::RequireWriteHeader(), s_RemoveCallbackParameter(), CCgiResponse::SetContentType(), CNcbiApplicationAPI::SetEnvironment(), CCgi2RCgiApp::SubmitJob(), and CNetScheduleAPIExt::UpdateAuthString().

◆ PullUpPersistentEntry() [1/2] void CGridCgiContext::PullUpPersistentEntry ( const stringentry_name ) ◆ PullUpPersistentEntry() [2/2] ◆ PutFailure()

Submit job failure diagnostics.

This method indicates that job failed because of some fatal, unrecoverable error.

Parameters
job NetSchedule job description structure. its error_msg and optionally ret_code and output fields should be set no_retries Instruct NetSchedule to fail the job permanently. The job will not be rerun regardless of whether retries are enabled for the queue or not.

Definition at line 493 of file netschedule_api_executor.cpp.

References CNetScheduleJob::auth_token, cmd, CNetScheduleJob::error_msg, g_AppendClientIPSessionIDHitID(), CNetScheduleNewJob::job_id, kNetScheduleMaxDBErrSize, NCBI_THROW, NStr::NumericToString(), CNetScheduleJob::output, NStr::PrintableString(), CNetScheduleJob::ret_code, and s_CheckOutputSize().

Referenced by CGridCommandLineInterfaceApp::Cmd_CommitJob(), CGridCommandLineInterfaceApp::NetScheduleSanityCheck(), CJobCommitterThread::x_CommitJob(), and CWNJobWatcher::x_KillNode().

◆ PutProgressMessage() [1/2] ◆ PutProgressMessage() [2/2] ◆ PutProgressMsg() ◆ PutResult()

Put job result (job should be received by GetJob() or WaitJob())

Parameters
job NetSchedule job description structure. its ret_code and output fields should be set

Definition at line 452 of file netschedule_api_executor.cpp.

References CNetScheduleJob::auth_token, cmd, g_AppendClientIPSessionIDHitID(), CNetScheduleNewJob::job_id, NStr::NumericToString(), CNetScheduleJob::output, NStr::PrintableString(), CNetScheduleJob::ret_code, and s_CheckOutputSize().

Referenced by CGridCommandLineInterfaceApp::Cmd_CommitJob(), CGridCommandLineInterfaceApp::NetScheduleSanityCheck(), CSampleNetScheduleNode::Run(), and CJobCommitterThread::x_CommitJob().

◆ Read()

Incremental retrieval of jobs that are done or failed.

Parameters
job_id Placeholder for storing the identifier of the job that's done or failed. auth_token Placeholder for storing a reading reservation token, which guarantees that no other caller will be given the same job for reading. job_status Placeholder for storing the status of the job, either eDone or eFailed. timeout Number of seconds to wait before the status of jobs is automatically reverted to the original one ('Done' or 'Failed'). If zero, the default timeout of the NetSchedule queue will be used instead. job_group Only consider jobs belonging to the specified group.
Returns
True if a job that's done or failed has been returned via the job_id references. False if no servers reported jobs marked as either done or failed.

Definition at line 298 of file netschedule_api_submitter.cpp.

References cmd, CNetService::eRandomize, g_AppendClientIPSessionIDHitID(), NULL, and NStr::UIntToString().

◆ ReadConfirm() ◆ ReadFail()

Refuse from processing the results of the specified job and increase its counter of failed job result retrievals.

If this counter exceeds the failed_read_retries parameter specified in the configuration file, the job will permanently change its status to 'ReadFailed'.

Parameters
job_id Job key returned by Read(). auth_token Reservation token returned by Read(). error_message This message can be used to describe the cause why the job results could not be read.

Definition at line 356 of file netschedule_api_submitter.cpp.

Referenced by CGridCommandLineInterfaceApp::Cmd_ReadJob().

◆ ReadJob()

Definition at line 1480 of file cgi2rcgi.cpp.

References ctx, NStr::eNocase, ERR_POST, NStr::eTrunc_End, HTTP_NCBI_JSID, CCgi2RCgiApp::m_AddJobIdToHeader, CCgi2RCgiApp::m_ExceptionMessage, CCgi2RCgiApp::m_Response, NcbiStreamCopy(), CCgi2RCgiApp::OnJobFailed(), out(), CCgiResponse::out(), CException::ReportAll(), NStr::StartsWith(), NStr::TruncateSpacesInPlace(), Warning(), and CException::what().

Referenced by CCgi2RCgiApp::OnJobDone().

◆ ReadNextJob() ◆ ReadRollback() ◆ RemoveDataBlob() void CGridClient::RemoveDataBlob ( const stringdata_key ) private ◆ RemoveListener() ◆ RenderPage() int CCgi2RCgiApp::RenderPage ( ) private

Definition at line 1227 of file cgi2rcgi.cpp.

References CNCBINode::eHTML, NStr::eNocase, CNCBINode::ePlainText, ERR_POST, NStr::fSplit_MergeDelimiters, NStr::fSplit_Truncate, isspace(), CCgi2RCgiApp::m_CustomHTTPHeader, CCgi2RCgiApp::m_HtmlIncs, CCgi2RCgiApp::m_Page, CCgi2RCgiApp::m_Response, CCgi2RCgiApp::m_Title, out(), CCgiResponse::out(), CCgiResponse::SetStatus(), NStr::SplitInTwo(), NStr::StartsWith(), NStr::StringToUInt(), NStr::TruncateSpaces(), NStr::TruncateSpacesInPlace(), Warning(), and CCgiResponse::WriteHeader().

Referenced by CCgi2RCgiApp::ProcessRequest().

◆ RenderRefresh() ◆ RequestExclusiveMode() void CWorkerNodeJobContext::RequestExclusiveMode ( )

Instruct the system that this job requires all system's resources If this method is call, the node will not accept any other jobs until this one is done.

In the event if the mode has already been requested by another job this job will be returned back to the queue.

Definition at line 359 of file wn_main_loop.cpp.

References CWorkerNodeJobContext::m_Impl, and NCBI_THROW.

◆ RequestShutdown() [1/3] void CWorkerNodeIdleTaskContext::RequestShutdown ( void  ) ◆ RequestShutdown() [2/3] void CGridWorkerNode::RequestShutdown ( void  ) ◆ RequestShutdown() [3/3] void CRemoteCgiApp::RequestShutdown ( void  ) ◆ Reschedule() ◆ RescheduleJob() ◆ Reset() [1/4] void CGridJobBatchSubmitter::Reset ( void  ) ◆ Reset() [2/4] void CWorkerNodeIdleTaskContext::Reset ( void  ) ◆ Reset() [3/4] void CNetScheduleNewJob::Reset ( void  ) inline ◆ Reset() [4/4] void CNetScheduleJob::Reset ( void  ) inline

Definition at line 352 of file netschedule_api.hpp.

References CNetScheduleJob::auth_token, CNetScheduleJob::client_ip, CNetScheduleJob::error_msg, NULL, CNetScheduleJob::output, CNetScheduleJob::page_hit_id, CNetScheduleJob::progress_msg, CNetScheduleNewJob::Reset(), CNetScheduleJob::ret_code, CNetScheduleJob::server, and CNetScheduleJob::session_id.

Referenced by CJobCommitterThread::AllocJobContext(), CMostAffinityJob< TImpl >::Interrupt(), CGridClient::SetJobKey(), and CGridClient::Submit().

◆ Resume() void CGridWorkerNode::Resume ( ) ◆ ReturnJob() [1/2] void CWorkerNodeJobContext::ReturnJob ( ) ◆ ReturnJob() [2/2] ◆ Run() [1/3] ◆ Run() [2/3] ◆ Run() [3/3] int CRemoteCgiApp::Run ( void  ) virtual ◆ RunJob()

Definition at line 172 of file remote_cgiapp.cpp.

References CCgiApplication::ConfigureDiagnostics(), CCgiApplication::eEndRequest, CCgiApplication::eError, CCgiApplication::eException, CCgiApplication::eExit, CCgiApplication::eSuccess, CCgiRequest::fSetDiagProperties, CRemoteCgiApp::m_JobContext, CCgiApplication::m_RequestFlags, NULL, CCgiApplication::OnEvent(), CCgiApplication::OnException(), CCgiContext::ProcessCORSRequest(), and CCgiApplication::ProcessRequest().

Referenced by CCgiWorkerNodeJob::Do().

◆ s_GetCtgTime() ◆ s_IsPendingOrRunning() ◆ s_RemoveCallbackParameter() static void s_RemoveCallbackParameter ( stringquery_string ) static ◆ SelectView() void CGridCgiContext::SelectView ( const stringview_name ) ◆ SEntry()

template<class TF >

SInputValidator::SEntry::SEntry ( string  n, TF  f  ) inline

Definition at line 109 of file cgi2rcgi.cpp.

◆ SetAffinityPreference() ◆ SetClientNode() void CNetScheduleAPI::SetClientNode ( const stringclient_node ) ◆ SetClientSession() void CNetScheduleAPI::SetClientSession ( const stringclient_session ) ◆ SetClientType() ◆ SetCommunicationTimeout() void CNetScheduleAPI::SetCommunicationTimeout ( const STimeoutto ) inline ◆ SetCompleteResponse() void CGridCgiContext::SetCompleteResponse ( CNcbiIstreamis ) ◆ SetJobAffinity() [1/2] void CGridJobBatchSubmitter::SetJobAffinity ( const stringaffinity ) ◆ SetJobAffinity() [2/2] void CGridClient::SetJobAffinity ( const stringaffinity ) inline ◆ SetJobGroup() [1/2] ◆ SetJobGroup() [2/2] void CNetScheduleExecutor::SetJobGroup ( const stringjob_group ) ◆ SetJobInput() [1/3] void CGridJobBatchSubmitter::SetJobInput ( const stringinput ) ◆ SetJobInput() [2/3]

Set a job's input This string will be sent to then the job is submitted.

This method can be used to send a short data to the worker node. To send a large data use GetOStream method. Don't call this method after GetOStream method is called.

Definition at line 88 of file grid_client.cpp.

References CNetScheduleNewJob::input, input(), and CGridClient::m_Job.

◆ SetJobInput() [3/3] void CGridCgiContext::SetJobInput ( const stringinput ) inlineprivate ◆ SetJobKey() [1/2] ◆ SetJobKey() [2/2] void CGridCgiContext::SetJobKey ( const stringjob_key ) private ◆ SetJobMask() [1/2] ◆ SetJobMask() [2/2] ◆ SetJobOutput() [1/2] void CWorkerNodeJobContext::SetJobOutput ( const stringoutput )

Set a job's output.

This string will be sent to the queue when job is done.

This method can be used to send a short data back to the client. To send a large result use GetOStream method. Don't call this method after GetOStream method is called.

Definition at line 68 of file wn_main_loop.cpp.

References CWorkerNodeJobContext::m_Impl, and output.

◆ SetJobOutput() [2/2] void CGridCgiContext::SetJobOutput ( const stringoutput ) inlineprivate ◆ SetJobProgressMessage() void CGridCgiContext::SetJobProgressMessage ( const stringmsg ) inlineprivate ◆ SetJobRetCode() void CWorkerNodeJobContext::SetJobRetCode ( int  ret_code ) ◆ SetListener() ◆ SetProgramVersion() void CNetScheduleAPI::SetProgramVersion ( const stringpv ) ◆ SetRunAgain() void CWorkerNodeIdleTaskContext::SetRunAgain ( ) inline ◆ SetupArgDescriptions() ◆ SExceptionMessage() ◆ ShowParamsPage() virtual void CGridCgiApplication::ShowParamsPage ( CGridCgiContextctx ) const protectedpure virtual ◆ SInputValidator() SInputValidator::SInputValidator ( ) ◆ SJob() ◆ StatusToString()

Printable status type.

Definition at line 781 of file netschedule_api.cpp.

References _ASSERT, CNetScheduleAPI::eCanceled, CNetScheduleAPI::eConfirmed, CNetScheduleAPI::eDeleted, CNetScheduleAPI::eDone, CNetScheduleAPI::eFailed, CNetScheduleAPI::eJobNotFound, CNetScheduleAPI::ePending, CNetScheduleAPI::eReadFailed, CNetScheduleAPI::eReading, CNetScheduleAPI::eRunning, and kEmptyStr.

Referenced by CGridRPCBaseClient< CAsnBinCompressed >::Ask(), CGridRPCBaseClient< CAsnBinCompressed >::AskStream(), CNSNotificationList::BuildJobChangedNotification(), CCgi2RCgiApp::CheckIfJobDone(), CGridCommandLineInterfaceApp::Cmd_GetJobOutput(), CGridCommandLineInterfaceApp::Cmd_ReadJob(), CGridCommandLineInterfaceApp::Cmd_Replay(), CGridCommandLineInterfaceApp::Cmd_SubmitJob(), CGridCommandLineInterfaceApp::Cmd_WatchJob(), CStatisticsCounters::CStatisticsCounters(), CNetScheduleAdmin::DumpQueue(), g_DoPerfLogging(), g_ProcessJobInfo(), SWorkerNodeJobContextImpl::GetShutdownLevel(), CGridCommandLineInterfaceApp::JobInfo_PrintStatus(), operator<<(), CNSClient::Print(), CQueue::PrintJobsStat(), CGridCommandLineInterfaceApp::PrintJobStatusNotification(), s_FormResourceName(), CNetScheduleJobSerializer::SaveJobOutput(), CJob::x_AppendEvents(), CJob::x_AppendStatus(), CQueue::x_ChangeReadingStatus(), CGridCgiApplication::x_CheckJobStatus(), CNetScheduleHandler::x_FinalizeReadCommand(), CGridRPCBaseClient< CAsnBinCompressed >::x_GetJobById(), CNSGroupsRegistry::x_PrintOne(), CNSScopeRegistry::x_PrintOne(), CNSAffinityRegistry::x_PrintOne(), CNetScheduleHandler::x_ProcessFastStatusS(), CNetScheduleHandler::x_ProcessFastStatusW(), CNetScheduleHandler::x_ProcessJobDelayExpiration(), CNetScheduleHandler::x_ProcessJobDelayReadExpiration(), CNetScheduleHandler::x_ProcessListenJob(), CNetScheduleHandler::x_ProcessPut(), CNetScheduleHandler::x_ProcessPutFailure(), CNetScheduleHandler::x_ProcessQueueInfo(), CNetScheduleHandler::x_ProcessReading(), CNetScheduleHandler::x_ProcessRedo(), CNetScheduleHandler::x_ProcessReread(), CNetScheduleHandler::x_ProcessReschedule(), CNetScheduleHandler::x_ProcessReturn(), CNetScheduleHandler::x_ProcessStatistics(), CNetScheduleHandler::x_ProcessStatus(), and CNetScheduleHandler::x_RemoveDuplicateStatuses().

◆ StringToStatus()

Parse status string into enumerator value.

Acceptable string values: Pending, Running, Canceled, Failed, Done, Reading, Confirmed, ReadFailed, Abbreviated Pend, Run, Return, Cancel, Fail

Returns
eJobNotFound if string cannot be parsed

Definition at line 801 of file netschedule_api.cpp.

References NStr::CompareNocase(), CNetScheduleAPI::eCanceled, CNetScheduleAPI::eConfirmed, CNetScheduleAPI::eDeleted, CNetScheduleAPI::eDone, CNetScheduleAPI::eFailed, CNetScheduleAPI::eJobNotFound, CNetScheduleAPI::ePending, CNetScheduleAPI::eReadFailed, CNetScheduleAPI::eReading, and CNetScheduleAPI::eRunning.

Referenced by SNSCommandArguments::AssignValues(), CNetScheduleNotificationHandler::CheckJobStatusNotification(), CReadCmdExecutor::Consider(), g_LegacyStatToJson(), CNetScheduleAPI::GetJobDetails(), CNetScheduleNotificationHandler::GetJobDetailsIfCompleted(), SNetScheduleAPIImpl::GetJobStatus(), CCgi2RCgiApp::GetStatusAndCtgTime(), CCgi2RCgiApp::ListenJobs(), CNetScheduleNotificationHandler::RequestJobWatching(), s_ParseReadJobResponse(), and CGridCommandLineInterfaceApp::StringToJobStatus().

◆ Submit() [1/2]

Submit a job to the queue.

Returns
a job key

Definition at line 103 of file grid_client.cpp.

References CNetScheduleNewJob::affinity, CGridClient::CloseStream(), CGridClient::GetNetScheduleSubmitter(), SNetScheduleSubmitterImpl::m_API, CGridClient::m_Job, SNetScheduleAPIImpl::m_JobTtl, CGridClient::m_NetScheduleSubmitter, CNetScheduleJob::Reset(), CNetScheduleSubmitter::SubmitJob(), and CGridClient::x_RenewAllJobBlobs().

Referenced by CGridCgiApplication::ProcessRequest(), CGridClientSampleApp::Run(), and CRemoteAppClientSampleApp::Run().

◆ Submit() [2/2] ◆ SubmitAndWait() ◆ SubmitJob() [1/2]

Definition at line 1097 of file cgi2rcgi.cpp.

References CCgi2RCgiApp::CheckIfJobDone(), CGridCgiContext::Clear(), crc32, CGridCgiContext::DefinePersistentEntry(), CCgi2RCgiApp::DefineRefreshTags(), done, CChecksum::eCRC32, ERR_POST, CNetScheduleException::eTooManyPendingJobs, CDiagContext::Extra(), CCgiRequest::GetContent(), GetDiagContext(), CException::GetErrCode(), GetFastLocalTime(), CGridCgiContext::GetJobKey(), CGridCgiContext::GetSelfURL(), CNetScheduleNewJob::job_id, kEmptyStr, kSinceTime, CCgi2RCgiApp::m_AffinityName, CCgi2RCgiApp::m_AffinitySetLimit, CCgi2RCgiApp::m_AffinitySource, CCgi2RCgiApp::m_ExceptionMessage, CCgi2RCgiApp::m_FirstDelay, CCgi2RCgiApp::m_GridClient, CCgi2RCgiApp::m_RefreshDelay, NStr::NumericToString(), CCgi2RCgiApp::OnJobFailed(), CDiagContext_Extra::Print(), CGridCgiContext::PullUpPersistentEntry(), s_IsPendingOrRunning(), CGridCgiContext::SelectView(), CCgiRequest::Serialize(), NStr::UIntToString(), and CException::what().

Referenced by CCgi2RCgiApp::ProcessRequest().

◆ SubmitJob() [2/2] ◆ SubmitJobAndWait()

Submit job to server and wait for the result.

This function should be used if we expect that job execution infrastructure is capable of finishing job in the specified time frame. This method can save a lot of round trips with the NetSchedule server (comparing to series of GetStatus calls).

Parameters
job NetSchedule job description structure wait_time Time in seconds function waits for the job to finish. If job does not finish in the output parameter will hold the empty string.
Returns
job status
Note
the result fields of the job description structure will be set if the job is finished during specified time.

Definition at line 404 of file netschedule_api_submitter.cpp.

◆ SubmitJobBatch()

Submit job batch.

Method automatically splits the submission into reasonable sized transactions, so there is no limit on the input batch size.

Every job in the job list receives job id

Definition at line 132 of file netschedule_api_submitter.cpp.

References cmd, CNetServer::SExecResult::conn, CNetServerConnection::Exec(), CNetScheduleKeyGenerator::Generate(), i, ITERATE, NCBI_THROW, s_CheckInputSize(), s_SerializeJob(), NStr::UIntToString(), and SNetServerConnectionImpl::WriteLine().

Referenced by CGridJobBatchSubmitter::Submit().

◆ Suspend() void CGridWorkerNode::Suspend ( bool  pullback, unsigned  timeout  ) ◆ TestAttribute() ◆ UseAutomaticCleanup() bool CGridClientApp::UseAutomaticCleanup ( ) const protectedvirtual ◆ UseProgressMessage() bool CGridClientApp::UseProgressMessage ( ) const protectedvirtual ◆ WaitForJob() [1/2] ◆ WaitForJob() [2/2] ◆ WarningTypeToString() ◆ x_CheckAllJobBlobs()

Definition at line 218 of file grid_client.cpp.

References CNetScheduleAPI::eCanceled, CNetScheduleAPI::eDone, CGridClient::GetNetScheduleSubmitter(), CNetScheduleSubmitter::GetProgressMsg(), CNetScheduleNewJob::input, CGridClient::m_AutoCleanUp, CGridClient::m_Job, CGridClient::m_JobDetailsRead, CGridClient::m_UseProgress, CNetScheduleJob::progress_msg, CGridClient::RemoveDataBlob(), s_TimeToTtl(), and CGridClient::x_RenewAllJobBlobs().

Referenced by CGridClient::GetStatus(), CGridClient::SubmitAndWait(), and CGridClient::WaitForJob().

◆ x_CheckJobStatus()

Definition at line 392 of file grid_cgiapp.cpp.

References _ASSERT, CNetScheduleAPI::eCanceled, CNetScheduleAPI::eDone, CNetScheduleAPI::eFailed, CNetScheduleAPI::eJobNotFound, CNetScheduleAPI::ePending, CNetScheduleAPI::eRunning, CGridCgiContext::GetCGIContext(), CGridCgiContext::GetEntryValue(), CGridClient::GetErrorMessage(), CGridCgiApplication::GetGridClient(), CGridClient::GetJobInput(), CGridClient::GetJobOutput(), CGridClient::GetProgressMessage(), CCgiContext::GetResponse(), CGridClient::GetStatus(), CGridCgiApplication::OnJobCanceled(), CGridCgiApplication::OnJobDone(), CGridCgiApplication::OnJobFailed(), CGridCgiApplication::OnJobPending(), CGridCgiApplication::OnJobRunning(), CGridCgiContext::SetJobInput(), CGridClient::SetJobKey(), CGridCgiContext::SetJobOutput(), CGridCgiContext::SetJobProgressMessage(), CCgiApplication::SetRequestId(), and CNetScheduleAPI::StatusToString().

Referenced by CGridCgiApplication::ProcessRequest().

◆ x_GetJobDetails() void CGridClient::x_GetJobDetails ( ) private ◆ x_JobStopRequested() ◆ x_ProlongBlobLifetime() void CGridClient::x_ProlongBlobLifetime ( const stringblob_key, unsigned  ttl  ) private ◆ x_ProlongJobFieldLifetime() bool CGridClient::x_ProlongJobFieldLifetime ( const stringjob_field, unsigned  ttl  ) private ◆ x_RenewAllJobBlobs() void CGridClient::x_RenewAllJobBlobs ( unsigned  ttl ) private

Definition at line 326 of file grid_client.cpp.

References CNetCacheAPI::GetCompoundIDPool(), CNetScheduleNewJob::input, CGridClient::m_Job, CGridClient::m_NetCacheAPI, NULL, CNetScheduleJob::output, CNetCacheKey::ParseBlobKey(), CNetScheduleJob::progress_msg, CGridClient::x_ProlongBlobLifetime(), and CGridClient::x_ProlongJobFieldLifetime().

Referenced by CGridClient::Submit(), CGridClient::x_CheckAllJobBlobs(), and CGridClient::x_GetJobDetails().

◆ ~CGridCgiContext() ◆ ~IWorkerNodeCleanupEventListener() virtual IWorkerNodeCleanupEventListener::~IWorkerNodeCleanupEventListener ( ) inlinevirtual

Definition at line 90 of file grid_worker.hpp.

◆ ~IWorkerNodeIdleTask() virtual IWorkerNodeIdleTask::~IWorkerNodeIdleTask ( ) inlinevirtual

Definition at line 404 of file grid_worker.hpp.

◆ ~IWorkerNodeInitBaseContext() virtual IWorkerNodeInitBaseContext::~IWorkerNodeInitBaseContext ( ) inlinevirtual

Definition at line 117 of file grid_worker.hpp.

◆ ~IWorkerNodeJob() virtual IWorkerNodeJob::~IWorkerNodeJob ( ) inlinevirtual

Definition at line 162 of file grid_worker.hpp.

◆ ~IWorkerNodeJobFactory() virtual IWorkerNodeJobFactory::~IWorkerNodeJobFactory ( ) inlinevirtual

Definition at line 419 of file grid_worker.hpp.

◆ ~IWorkerNodeJobWatcher() IWorkerNodeJobWatcher::~IWorkerNodeJobWatcher ( ) virtual

Definition at line 55 of file grid_worker.cpp.

◆ affinity string CNetScheduleNewJob::affinity

Definition at line 328 of file netschedule_api.hpp.

Referenced by CCgiEnvHolder::CCgiEnvHolder(), CGridCommandLineInterfaceApp::Cmd_SubmitJob(), CMostAffinityJob< TImpl >::Done(), SNetScheduleExecutorImpl::ExecGET(), CAppEnvHolder::GetEnv(), CNetScheduleExecutor::GetJob(), CNetScheduleAPI::GetJobDetails(), CNetScheduleJobSerializer::LoadJobInput(), CGridCommandLineInterfaceApp::PrintJobAttrsAndDumpInput(), CNetScheduleExecutor::Reschedule(), CNetScheduleNewJob::Reset(), s_DoParseGet2JobResponse(), s_ParseReadJobResponse(), s_SerializeJob(), CNetScheduleJobSerializer::SaveJobInput(), CGridClient::SetJobAffinity(), and CGridClient::Submit().

◆ auth_token string CNetScheduleJob::auth_token

Definition at line 377 of file netschedule_api.hpp.

Referenced by SGridWorkerNodeImpl::SJobsInProgress::Add(), CGridCommandLineInterfaceApp::Cmd_CommitJob(), CGridCommandLineInterfaceApp::Cmd_ReadJob(), CGridCommandLineInterfaceApp::Cmd_ReturnJob(), CGridCommandLineInterfaceApp::PrintJobAttrsAndDumpInput(), CNetScheduleExecutor::PutFailure(), CNetScheduleExecutor::PutResult(), CNetScheduleExecutor::Reschedule(), CNetScheduleJob::Reset(), SNetScheduleJobReaderImpl::CImpl::ReturnJob(), SNetScheduleExecutorImpl::ReturnJob(), s_DoParseGet2JobResponse(), s_ParseReadJobResponse(), and SGridWorkerNodeImpl::SJobsInProgress::Update().

◆ client_ip string CNetScheduleJob::client_ip ◆ error_msg string CNetScheduleJob::error_msg ◆ group string CNetScheduleNewJob::group ◆ host ◆ id unsigned CNetScheduleKey::id ◆ input string CNetScheduleNewJob::input

Input data.

Arbitrary string that contains input data for the job. It is suggested to use NetCache to keep the actual data and pass NetCache key as job input.

Definition at line 326 of file netschedule_api.hpp.

Referenced by CGridCommandLineInterfaceApp::Cmd_GetJobInput(), CGridCommandLineInterfaceApp::Cmd_Replay(), CGridCommandLineInterfaceApp::Cmd_SubmitJob(), g_ProcessJobInfo(), SWorkerNodeJobContextImpl::GetIStream(), CNetScheduleAPI::GetJobDetails(), CGridClient::GetJobInput(), CGridClient::GetOStream(), CNetScheduleJobSerializer::LoadJobInput(), CGridCommandLineInterfaceApp::NetScheduleSanityCheck(), CGridCommandLineInterfaceApp::PrintJobAttrsAndDumpInput(), CNetScheduleNewJob::Reset(), CSampleNetScheduleNode::Run(), s_DoParseGet2JobResponse(), s_SerializeJob(), CNetScheduleJobSerializer::SaveJobInput(), CGridClient::SetJobInput(), SNetScheduleSubmitterImpl::SubmitJobImpl(), CGridClient::x_CheckAllJobBlobs(), and CGridClient::x_RenewAllJobBlobs().

◆ job_id string CNetScheduleNewJob::job_id

Output job key.

Definition at line 335 of file netschedule_api.hpp.

Referenced by SGridWorkerNodeImpl::SJobsInProgress::Add(), CCgiEnvHolder::CCgiEnvHolder(), SWorkerNodeJobContextImpl::CheckIfJobIsLost(), CGridCommandLineInterfaceApp::Cmd_CommitJob(), CGridCommandLineInterfaceApp::Cmd_GetJobInput(), CGridCommandLineInterfaceApp::Cmd_GetJobOutput(), CGridCommandLineInterfaceApp::Cmd_JobInfo(), CGridCommandLineInterfaceApp::Cmd_ReadJob(), CGridCommandLineInterfaceApp::Cmd_Replay(), CGridCommandLineInterfaceApp::Cmd_RequestJob(), CGridCommandLineInterfaceApp::Cmd_ReturnJob(), CGridCommandLineInterfaceApp::Cmd_SubmitJob(), CGridCommandLineInterfaceApp::Cmd_UpdateJob(), CMostAffinityJob< TImpl >::Done(), g_ProcessJobInfo(), CAppEnvHolder::GetEnv(), CNetScheduleAPI::GetJobDetails(), CNetScheduleNotificationHandler::GetJobDetailsIfCompleted(), CNetScheduleSubmitter::GetJobStatus(), SNetScheduleAPIImpl::GetJobStatus(), CNetScheduleAPI::GetProgressMsg(), SNetScheduleAPIImpl::GetServer(), SWorkerNodeJobContextImpl::GetShutdownLevel(), CNetScheduleExecutor::JobDelayExpiration(), CNetScheduleJobSerializer::LoadJobInput(), CGridCommandLineInterfaceApp::NetScheduleSanityCheck(), CGridCommandLineInterfaceApp::PrintJobAttrsAndDumpInput(), CNetScheduleExecutor::PutFailure(), SWorkerNodeJobContextImpl::PutProgressMessage(), CNetScheduleExecutor::PutProgressMsg(), CNetScheduleExecutor::PutResult(), SGridWorkerNodeImpl::SJobsInProgress::Remove(), CNetScheduleExecutor::Reschedule(), CNetScheduleNewJob::Reset(), SNetScheduleJobReaderImpl::CImpl::ReturnJob(), SNetScheduleExecutorImpl::ReturnJob(), CSampleNetScheduleClient::Run(), CSampleNetScheduleNode::Run(), s_DoParseGet2JobResponse(), s_ParseReadJobResponse(), CNetScheduleJobSerializer::SaveJobInput(), CNetScheduleJobSerializer::SaveJobOutput(), CGridClient::SetJobKey(), SJob::SJob(), CCgi2RCgiApp::SubmitJob(), SNetScheduleSubmitterImpl::SubmitJobImpl(), SGridWorkerNodeImpl::SJobsInProgress::Update(), CNetScheduleNotificationHandler::WaitForJobCompletion(), CJobCommitterThread::x_CommitJob(), CGridRPCBaseClient< CAsnBinCompressed >::x_GetJobById(), CMainLoopThread::x_GetNextJob(), SWorkerNodeJobContextImpl::x_RunJob(), and SOfflineJobContextImpl::x_RunJob().

◆ kGridCgiForm ◆ kPlainTextView ◆ m_AddJobIdToHeader bool CCgi2RCgiApp::m_AddJobIdToHeader private ◆ m_AffinityName string CCgi2RCgiApp::m_AffinityName private ◆ m_AffinitySetLimit int CCgi2RCgiApp::m_AffinitySetLimit private ◆ m_AffinitySource int CCgi2RCgiApp::m_AffinitySource private ◆ m_AppImpl ◆ m_AppName

template<typename TWorkerNodeJob >

◆ m_AutoCleanUp bool CGridClient::m_AutoCleanUp private ◆ m_BlobSize size_t CGridClient::m_BlobSize = 0 private ◆ m_CancelGoBackDelay int CCgi2RCgiApp::m_CancelGoBackDelay private ◆ m_CgiContext ◆ m_ContentType string CCgi2RCgiApp::m_ContentType private ◆ m_CustomHTTPHeader [1/2] CHTMLPage& CGridCgiContext::m_CustomHTTPHeader private ◆ m_CustomHTTPHeader [2/2] unique_ptr<CHTMLPage> CCgi2RCgiApp::m_CustomHTTPHeader private ◆ m_DateFormat string CCgi2RCgiApp::m_DateFormat private ◆ m_DisplayDonePage bool CCgi2RCgiApp::m_DisplayDonePage private ◆ m_ElapsedTimeFormat string CCgi2RCgiApp::m_ElapsedTimeFormat private ◆ m_Entries vector<SEntry> SInputValidator::m_Entries private ◆ m_ExceptionMessage ◆ m_FallBackDelay int CCgi2RCgiApp::m_FallBackDelay private ◆ m_FallBackUrl string CCgi2RCgiApp::m_FallBackUrl private ◆ m_FirstDelay [1/2] int CGridCgiApplication::m_FirstDelay private ◆ m_FirstDelay [2/2] int CCgi2RCgiApp::m_FirstDelay private ◆ m_Func function<void(const string&)> SInputValidator::SEntry::m_Func private ◆ m_GridClient [1/4] ◆ m_GridClient [2/4] ◆ m_GridClient [3/4] unique_ptr<CGridClient> CGridCgiApplication::m_GridClient private ◆ m_GridClient [4/4] ◆ m_GridRead ◆ m_GridWrite [1/2] ◆ m_GridWrite [2/2] ◆ m_HasBeenSubmitted bool CGridJobBatchSubmitter::m_HasBeenSubmitted private ◆ m_HostIPv4Addr unsigned CNetScheduleKeyGenerator::m_HostIPv4Addr private

Definition at line 96 of file netschedule_key.hpp.

◆ m_HostName ◆ m_HtmlIncs vector<string> CCgi2RCgiApp::m_HtmlIncs private ◆ m_HTMLPassThrough bool CCgi2RCgiApp::m_HTMLPassThrough private ◆ m_HtmlTemplate string CCgi2RCgiApp::m_HtmlTemplate private ◆ m_IdleTask

template<typename TWorkerNodeJob , typename TWorkerNodeIdleTask >

unique_ptr<TWorkerNodeIdleTask> CSimpleJobFactoryEx< TWorkerNodeJob, TWorkerNodeIdleTask >::m_IdleTask private ◆ m_Impl [1/6]

Definition at line 197 of file grid_worker.hpp.

Referenced by CWorkerNodeJobContext::CloseStreams(), CWorkerNodeJobContext::CommitJob(), CWorkerNodeJobContext::CommitJobWithFailure(), CWorkerNodeJobContext::GetCleanupEventSource(), CWorkerNodeJobContext::GetClientName(), CWorkerNodeJobContext::GetCommitStatus(), CWorkerNodeJobContext::GetInputBlobSize(), CWorkerNodeJobContext::GetIStream(), CWorkerNodeJobContext::GetJob(), CWorkerNodeJobContext::GetJobInput(), CWorkerNodeJobContext::GetJobKey(), CWorkerNodeJobContext::GetJobMask(), CWorkerNodeJobContext::GetJobNumber(), CWorkerNodeJobContext::GetJobOutput(), CWorkerNodeJobContext::GetOStream(), CWorkerNodeJobContext::GetQueueName(), CWorkerNodeJobContext::GetShutdownLevel(), CWorkerNodeJobContext::GetWorkerNode(), CWorkerNodeJobContext::IsJobCommitted(), CWorkerNodeJobContext::IsJobLost(), CWorkerNodeJobContext::IsLogRequested(), CWorkerNodeJobContext::JobDelayExpiration(), CWorkerNodeJobContext::PutProgressMessage(), CWorkerNodeJobContext::RequestExclusiveMode(), CWorkerNodeJobContext::RescheduleJob(), CWorkerNodeJobContext::ReturnJob(), CWorkerNodeJobContext::SetJobOutput(), and CWorkerNodeJobContext::SetJobRetCode().

◆ m_Impl [2/6]

Definition at line 540 of file grid_worker.hpp.

Referenced by CGridWorkerNode::ForceSingleThread(), CGridWorkerNode::GetAppName(), CGridWorkerNode::GetAppVersion(), CGridWorkerNode::GetCheckStatusPeriod(), CGridWorkerNode::GetCleanupEventSource(), CGridWorkerNode::GetClientName(), CGridWorkerNode::GetCommitJobInterval(), CGridWorkerNode::GetJobFactory(), CGridWorkerNode::GetMaxThreads(), CGridWorkerNode::GetNetCacheAPI(), CGridWorkerNode::GetNetScheduleAPI(), CGridWorkerNode::GetNSExecutor(), CGridWorkerNode::GetQueueName(), CGridWorkerNode::GetQueueTimeout(), CGridWorkerNode::GetServiceName(), CGridWorkerNode::GetStartupTime(), CGridWorkerNode::GetTotalMemoryLimit(), CGridWorkerNode::GetTotalTimeLimit(), CGridWorkerNode::Init(), CGridWorkerNode::IsHostInAdminHostsList(), CGridWorkerNode::IsSuspended(), CGridWorkerNode::Resume(), CGridWorkerNode::Run(), CGridWorkerNode::SetListener(), and CGridWorkerNode::Suspend().

◆ m_Impl [3/6] ◆ m_Impl [4/6] ◆ m_Impl [5/6] ◆ m_Impl [6/6] ◆ m_InputValidator [1/2] ◆ m_InputValidator [2/2] ◆ m_InterceptJQueryCallback bool CCgi2RCgiApp::m_InterceptJQueryCallback private ◆ m_Job

Definition at line 269 of file grid_client.hpp.

Referenced by CGridClient::GetErrorMessage(), CGridClient::GetIStream(), CGridClient::GetJob(), CGridClient::GetJobInput(), CGridClient::GetJobOutput(), CGridClient::GetOStream(), CGridClient::GetProgressMessage(), CGridClient::GetReturnCode(), CGridClient::GetStatus(), CGridClient::SetJobAffinity(), CGridClient::SetJobGroup(), CGridClient::SetJobInput(), CGridClient::SetJobKey(), CGridClient::SetJobMask(), CGridClient::Submit(), CGridClient::SubmitAndWait(), CGridClient::x_CheckAllJobBlobs(), CGridClient::x_GetJobDetails(), and CGridClient::x_RenewAllJobBlobs().

◆ m_JobBatchSubmitter ◆ m_JobContext ◆ m_JobDetailsRead ◆ m_JobIndex size_t CGridJobBatchSubmitter::m_JobIndex private ◆ m_JobInput string CGridCgiContext::m_JobInput private ◆ m_JobKey string CGridCgiContext::m_JobKey private ◆ m_JobOutput string CGridCgiContext::m_JobOutput private ◆ m_Jobs ◆ m_JobVersion

template<typename TWorkerNodeJob >

◆ m_JqueryCallback string CGridCgiContext::m_JqueryCallback private ◆ m_NeedMetaRefresh bool CGridCgiContext::m_NeedMetaRefresh private ◆ m_NeedRenderPage bool CGridCgiContext::m_NeedRenderPage private ◆ m_NetCacheAPI [1/3] ◆ m_NetCacheAPI [2/3] ◆ m_NetCacheAPI [3/3] ◆ m_NetScheduleAPI ◆ m_NetScheduleSubmitter ◆ m_NSClient ◆ m_Page [1/3] ◆ m_Page [2/3] ◆ m_Page [3/3] ◆ m_ParsedQueryString ◆ m_PersistedEntries ◆ m_PersistentEntries ◆ m_Port unsigned short CNetScheduleKeyGenerator::m_Port private

Definition at line 98 of file netschedule_key.hpp.

◆ m_PortAdded bool CCgi2RCgiApp::m_PortAdded private ◆ m_ProgressMsg string CGridCgiContext::m_ProgressMsg private ◆ m_QueueName ◆ m_RefreshDelay [1/2] int CGridCgiApplication::m_RefreshDelay private ◆ m_RefreshDelay [2/2] int CCgi2RCgiApp::m_RefreshDelay private ◆ m_RefreshWait int CCgi2RCgiApp::m_RefreshWait private ◆ m_Registry ◆ m_Response [1/2] ◆ m_Response [2/2] ◆ m_RunAgain bool CWorkerNodeIdleTaskContext::m_RunAgain private ◆ m_TargetEncodeMode ◆ m_Thread ◆ m_Title ◆ m_UseIPv4Addr ◆ m_UseProgress bool CGridClient::m_UseProgress private ◆ m_V1HostPortQueue ◆ m_Validated bool SInputValidator::SEntry::m_Validated = false private ◆ m_WorkerNodeInitContext

template<typename TWorkerNodeJob >

◆ mask ◆ max_input_size size_t CNetScheduleAPI::SServerParams::max_input_size ◆ max_output_size size_t CNetScheduleAPI::SServerParams::max_output_size ◆ name string SInputValidator::SEntry::name ◆ output string CNetScheduleJob::output

Job result data.

Definition at line 373 of file netschedule_api.hpp.

Referenced by CGridRPCBaseClient< CAsnBinCompressed >::Ask(), CGridRPCBaseClient< CAsnBinCompressed >::AskStream(), CGridCommandLineInterfaceApp::Cmd_CommitJob(), CGridCommandLineInterfaceApp::Cmd_GetJobOutput(), CGridCommandLineInterfaceApp::Cmd_ReadJob(), CGridCommandLineInterfaceApp::Cmd_SubmitJob(), g_ProcessJobInfo(), CGridClient::GetIStream(), CNetScheduleAPI::GetJobDetails(), CGridClient::GetJobOutput(), SWorkerNodeJobContextImpl::GetOStream(), CGridCommandLineInterfaceApp::NetScheduleSanityCheck(), CNetScheduleExecutor::PutFailure(), CNetScheduleExecutor::PutResult(), CNetScheduleJob::Reset(), CSampleNetScheduleClient::Run(), CSampleNetScheduleNode::Run(), CNetScheduleJobSerializer::SaveJobOutput(), CGridRPCBaseClient< CAsnBinCompressed >::x_GetJobById(), and CGridClient::x_RenewAllJobBlobs().

◆ page_hit_id string CNetScheduleJob::page_hit_id ◆ port unsigned short CNetScheduleKey::port ◆ progress_msg string CNetScheduleJob::progress_msg ◆ progress_msg_truncated ◆ queue ◆ ret_code int CNetScheduleJob::ret_code

Job return code.

Definition at line 371 of file netschedule_api.hpp.

Referenced by CGridCommandLineInterfaceApp::Cmd_CommitJob(), CNetScheduleAPI::GetJobDetails(), CGridClient::GetReturnCode(), CGridCommandLineInterfaceApp::NetScheduleSanityCheck(), CNetScheduleExecutor::PutFailure(), CNetScheduleExecutor::PutResult(), CNetScheduleJob::Reset(), CSampleNetScheduleClient::Run(), CNetScheduleJobSerializer::SaveJobOutput(), SWorkerNodeJobContextImpl::x_PrintRequestStop(), and SWorkerNodeJobContextImpl::x_RunJob().

◆ server ◆ session_id string CNetScheduleJob::session_id ◆ status ◆ version unsigned CNetScheduleKey::version ◆ CCgiWorkerNodeJob ◆ CGridCgiApplication ◆ CGridClient ◆ CWorkerNodeIdleThread ◆ operator<<

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4