NCBI C++ ToolKit
Classes | Macros | Enumerations | Functions | Variables
grid_cli.cpp File Reference
#include <ncbi_pch.hpp>
#include "grid_cli.hpp"
#include <connect/ncbi_userhost.hpp>
#include <connect/impl/connect_misc.hpp>
#include <connect/services/clparser.hpp>
#include <connect/services/grid_app_version_info.hpp>
#include <common/test_assert.h>
+ Include dependency graph for grid_cli.cpp:

Go to the source code of this file.

Go to the SVN repository for this file.

Classes

struct  SOptionDefinition
 
struct  SCommandCategoryDefinition
 
struct  SCommandDefinition
 
class  COutputFileHelper
 

Macros

#define ANY_JOB_STATUS   "Any"
 
#define OPT_DEF(opt_type, opt_id)   CCommandLineParser::opt_type, opt_id
 
#define ICACHE_KEY_FORMAT_EXPLANATION_BASE
 
#define ICACHE_KEY_FORMAT_EXPLANATION
 
#define ICACHE_KEY_FORMAT_EXPLANATION_OPT_VERSION
 
#define MAY_REQUIRE_LOCATION_HINTING
 
#define ABOUT_NETSTORAGE_OPTION
 
#define WN_NOT_NOTIFIED_DISCLAIMER
 
#define ABOUT_SWITCH_ARG    "The " SWITCH_ARG " argument can be either 'on' or 'off'."
 
#define ALLOW_XSITE_CONN_IF_SUPPORTED
 
#define NETSTORAGE_COMMON_OPTIONS
 
#define NETSTORAGE_DIRECT_OPTIONS    eDirectMode, eNetCache, eFileTrackSite
 
#define TOTAL_NUMBER_OF_COMMANDS
 

Enumerations

enum  ECommandCategory {
  eGeneralCommand , eNetCacheCommand , eNetStorageCommand , eNetScheduleCommand ,
  eSubmitterCommand , eWorkerNodeCommand , eAdministrativeCommand , eExtendedCLICommand ,
  eNumberOfCommandCategories
}
 

Functions

CLogLatencies::EWhich s_GetLatency (const char *arg)
 
int main (int argc, const char *argv[])
 

Variables

 USING_NCBI_SCOPE
 
struct SOptionDefinition s_OptionDefinitions [eNumberOfOptions]
 
struct SCommandCategoryDefinition s_CategoryDefinitions [eNumberOfCommandCategories]
 
struct SCommandDefinition s_CommandDefinitions []
 
static const char *const s_OutputFormats [eNumberOfOutputFormats]
 
static char s_ConnDebugEnv [] = "CONN_DEBUG_PRINTOUT=DATA"
 

Macro Definition Documentation

◆ ABOUT_NETSTORAGE_OPTION

#define ABOUT_NETSTORAGE_OPTION
Value:
"\n\nIf a NetStorage service (or server) is specified " \
"via the '--" NETSTORAGE_OPTION "' option or provided object locator " \
"contains a NetStorage service, that service " \
"or server will be used as a gateway to the actual storage " \
"back-end (e.g. NetCache). If the option is not specified " \
"and either the locator does not contain a NetStorage service " \
"or '--" DIRECT_MODE_OPTION "' option specified, " \
"a direct connection to the storage back-end is established."
#define NETSTORAGE_OPTION
Definition: grid_cli.hpp:73
#define DIRECT_MODE_OPTION
Definition: grid_cli.hpp:124

Definition at line 538 of file grid_cli.cpp.

◆ ABOUT_SWITCH_ARG

#define ABOUT_SWITCH_ARG    "The " SWITCH_ARG " argument can be either 'on' or 'off'."

Definition at line 552 of file grid_cli.cpp.

◆ ALLOW_XSITE_CONN_IF_SUPPORTED

#define ALLOW_XSITE_CONN_IF_SUPPORTED

Definition at line 558 of file grid_cli.cpp.

◆ ANY_JOB_STATUS

#define ANY_JOB_STATUS   "Any"

Definition at line 52 of file grid_cli.cpp.

◆ ICACHE_KEY_FORMAT_EXPLANATION

#define ICACHE_KEY_FORMAT_EXPLANATION
Value:
" * \"key\" \"version\" \"subkey\""
#define ICACHE_KEY_FORMAT_EXPLANATION_BASE
Definition: grid_cli.cpp:518

Definition at line 524 of file grid_cli.cpp.

◆ ICACHE_KEY_FORMAT_EXPLANATION_BASE

#define ICACHE_KEY_FORMAT_EXPLANATION_BASE
Value:
"\n\nBoth NetCache and ICache modes are supported. " \
"ICache mode requires blob ID to be specified in one of the " \
"following formats:\n" \
" * \"key,version,subkey\"\n"

Definition at line 518 of file grid_cli.cpp.

◆ ICACHE_KEY_FORMAT_EXPLANATION_OPT_VERSION

#define ICACHE_KEY_FORMAT_EXPLANATION_OPT_VERSION
Value:
" * \"key\" [\"version\"] \"subkey\"\n" \
" (version could be omitted only if " PASSWORD_OPTION ", " \
OFFSET_OPTION " and " SIZE_OPTION " options are not used)."
#define PASSWORD_OPTION
Definition: grid_cli.hpp:120
#define SIZE_OPTION
Definition: grid_cli.hpp:122

Definition at line 528 of file grid_cli.cpp.

◆ MAY_REQUIRE_LOCATION_HINTING

#define MAY_REQUIRE_LOCATION_HINTING
Value:
"Some object locators may require additional options " \
"to hint at the actual object location."

Definition at line 534 of file grid_cli.cpp.

◆ NETSTORAGE_COMMON_OPTIONS

#define NETSTORAGE_COMMON_OPTIONS
Value:
eAuth, eLoginToken
@ eNoMetaData
Definition: grid_cli.hpp:189
@ eCacheable
Definition: grid_cli.hpp:188
@ eLoginToken
Definition: grid_cli.hpp:161
@ eNetStorage
Definition: grid_cli.hpp:181
@ eMovable
Definition: grid_cli.hpp:187
@ ePersistent
Definition: grid_cli.hpp:185
@ eNamespace
Definition: grid_cli.hpp:184
@ eObjectKey
Definition: grid_cli.hpp:182
@ eUserKey
Definition: grid_cli.hpp:183

Definition at line 561 of file grid_cli.cpp.

◆ NETSTORAGE_DIRECT_OPTIONS

#define NETSTORAGE_DIRECT_OPTIONS    eDirectMode, eNetCache, eFileTrackSite

Definition at line 566 of file grid_cli.cpp.

◆ OPT_DEF

#define OPT_DEF (   opt_type,
  opt_id 
)    CCommandLineParser::opt_type, opt_id

Definition at line 67 of file grid_cli.cpp.

◆ TOTAL_NUMBER_OF_COMMANDS

#define TOTAL_NUMBER_OF_COMMANDS
Value:
struct SCommandDefinition s_CommandDefinitions[]
unsigned int
A callback function used to compare two keys in a database.
Definition: types.hpp:1210

Definition at line 1227 of file grid_cli.cpp.

◆ WN_NOT_NOTIFIED_DISCLAIMER

#define WN_NOT_NOTIFIED_DISCLAIMER
Value:
"Worker nodes that may have already " \
"started job processing will not be notified."

Definition at line 548 of file grid_cli.cpp.

Enumeration Type Documentation

◆ ECommandCategory

Enumerator
eGeneralCommand 
eNetCacheCommand 
eNetStorageCommand 
eNetScheduleCommand 
eSubmitterCommand 
eWorkerNodeCommand 
eAdministrativeCommand 
eExtendedCLICommand 
eNumberOfCommandCategories 

Definition at line 492 of file grid_cli.cpp.

Function Documentation

◆ main()

int main ( int  argc,
const char *  argv[] 
)

Definition at line 1892 of file grid_cli.cpp.

References CNcbiApplicationAPI::AppMain().

◆ s_GetLatency()

CLogLatencies::EWhich s_GetLatency ( const char *  arg)

Variable Documentation

◆ s_CategoryDefinitions

Initial value:
= {
{eGeneralCommand, "General commands"},
{eNetCacheCommand, "NetCache commands"},
{eNetStorageCommand, "NetStorage commands"},
{eNetScheduleCommand, "Universal NetSchedule commands"},
{eSubmitterCommand, "Submitter commands"},
{eWorkerNodeCommand, "Worker node commands"},
{eAdministrativeCommand, "Administrative commands"},
{eExtendedCLICommand, "Extended commands"},
}
@ eGeneralCommand
Definition: grid_cli.cpp:493
@ eNetScheduleCommand
Definition: grid_cli.cpp:496
@ eAdministrativeCommand
Definition: grid_cli.cpp:499
@ eNetStorageCommand
Definition: grid_cli.cpp:495
@ eNetCacheCommand
Definition: grid_cli.cpp:494
@ eExtendedCLICommand
Definition: grid_cli.cpp:500
@ eSubmitterCommand
Definition: grid_cli.cpp:497
@ eWorkerNodeCommand
Definition: grid_cli.cpp:498

Referenced by CGridCommandLineInterfaceApp::Run().

◆ s_CommandDefinitions

struct SCommandDefinition s_CommandDefinitions[]

◆ s_ConnDebugEnv

char s_ConnDebugEnv[] = "CONN_DEBUG_PRINTOUT=DATA"
static

Definition at line 1236 of file grid_cli.cpp.

Referenced by CGridCommandLineInterfaceApp::Run().

◆ s_OptionDefinitions

struct SOptionDefinition s_OptionDefinitions[eNumberOfOptions]

◆ s_OutputFormats

const char* const s_OutputFormats[eNumberOfOutputFormats]
static
Initial value:
= {
"human-readable" ,
"raw" ,
"json"
}

Definition at line 1230 of file grid_cli.cpp.

Referenced by CGridCommandLineInterfaceApp::Run().

◆ USING_NCBI_SCOPE

USING_NCBI_SCOPE

Definition at line 50 of file grid_cli.cpp.

Modified on Wed Feb 28 07:14:09 2024 by modify_doxy.py rev. 669887