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

Search Toolkit Book for CNetScheduleKey

Meaningful information encoded in the NetSchedule key. More...

#include <connect/services/netschedule_key.hpp>

Public Member Functions

 CNetScheduleKey (const string &str_key, CCompoundIDPool::TInstance id_pool=NULL)
 Parse NetSchedule key; throw an exception if the key cannot be recognized. More...
 
 CNetScheduleKey ()
 Construct an empty object for use with ParseJobKey(). More...
 
bool ParseJobKey (const string &key_str, CCompoundIDPool::TInstance id_pool=NULL)
 

Public Attributes

unsigned version
 Key version. More...
 
string host
 Server name. More...
 
unsigned short port
 TCP/IP port number. More...
 
string queue
 Queue name, optional. More...
 
unsigned id
 Job id. More...
 

Detailed Description

Meaningful information encoded in the NetSchedule key.

Definition at line 63 of file netschedule_key.hpp.

Constructor & Destructor Documentation

CNetScheduleKey::CNetScheduleKey ( const string str_key,
CCompoundIDPool::TInstance  id_pool = NULL 
)
explicit

Parse NetSchedule key; throw an exception if the key cannot be recognized.

Definition at line 52 of file netschedule_key.cpp.

References NCBI_THROW_FMT, and NStr::PrintableString().

CNetScheduleKey::CNetScheduleKey ( )
inline

Construct an empty object for use with ParseJobKey().

Definition at line 71 of file netschedule_key.hpp.

Member Function Documentation

bool CNetScheduleKey::ParseJobKey ( const string key_str,
CCompoundIDPool::TInstance  id_pool = NULL 
)

Member Data Documentation

string CNetScheduleKey::host
unsigned CNetScheduleKey::id
unsigned short CNetScheduleKey::port
string CNetScheduleKey::queue
unsigned CNetScheduleKey::version

Key version.

Definition at line 76 of file netschedule_key.hpp.

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


The documentation for this struct was generated from the following files:
Modified on Wed Apr 25 11:18:12 2018 by modify_doxy.py rev. 546573