NCBI C++ ToolKit
Public Member Functions | Public Attributes | Private Member Functions | List of all members
SNSCommandArguments Struct Reference

Search Toolkit Book for SNSCommandArguments

#include "ns_command_arguments.hpp"
(Private to src/app/netschedule.)

Public Member Functions

void AssignValues (TNSProtoParams &params, const string &command, bool need_to_generate, CSocket &peer_socket, CCompoundIDPool::TInstance id_pool)
 

Public Attributes

unsigned int job_id
 
int job_return_code
 
unsigned int port
 
unsigned int timeout
 
unsigned int job_mask
 
unsigned int start_after_job_id
 
unsigned int count
 
int client_data_version
 
string cmd
 
string auth_token
 
string input
 
string output
 
string affinity_token
 
string job_key
 
string queue_from_job_key
 
string err_msg
 
string comment
 
string description
 
string ip
 
string option
 
string progress_msg
 
string qname
 
string qclass
 
string sid
 
string job_statuses_string
 
string aff_to_add
 
string aff_to_del
 
string start_after
 
string group
 
string alert
 
string service
 
string user
 
string client_data
 
string ncbi_phid
 
string scope
 
bool any_affinity
 
bool wnode_affinity
 
bool reader_affinity
 
bool exclusive_new_aff
 
bool mode
 
bool drain
 
bool effective
 
bool pullback
 
bool blacklist
 
bool no_retries
 
bool prioritized_aff
 
bool affinity_may_change
 
bool group_may_change
 
bool need_progress_msg
 
bool need_stolen
 
bool order_first
 
TDumpFields dump_fields
 
vector< TJobStatusjob_statuses
 

Private Member Functions

void x_Reset ()
 
void x_CheckAffinityList (const string &val)
 
void x_CheckGroupList (const string &val)
 
void x_CheckQueueName (const string &val, const string &key)
 
bool x_GetBooleanValue (const string &val, const string &key)
 
string x_NormalizeErrorMessage (const string &val)
 
bool x_GetOrderFirst (const string &val)
 
TDumpFields x_GetDumpFields (const string &val)
 

Detailed Description

Definition at line 88 of file ns_command_arguments.hpp.

Member Function Documentation

◆ AssignValues()

void SNSCommandArguments::AssignValues ( TNSProtoParams params,
const string command,
bool  need_to_generate,
CSocket peer_socket,
CCompoundIDPool::TInstance  id_pool 
)

Definition at line 190 of file ns_command_arguments.cpp.

References aff_to_add, aff_to_del, affinity_may_change, affinity_token, alert, any_affinity, auth_token, blacklist, client_data, client_data_version, cmd, command, comment, count, description, drain, dump_fields, effective, err_msg, eSAF_IP, exclusive_new_aff, NStr::fConvErr_NoThrow, CSocket::GetPeerAddress(), CDiagContext::GetRequestContext(), group, group_may_change, CNetScheduleKey::id, input, ip, job_id, job_key, job_mask, job_return_code, job_statuses, job_statuses_string, ncbi::grid::netcache::search::fields::key, kNetScheduleMaxDBDataSize, kNetScheduleMaxOverflowSize, mode, ncbi_phid, NCBI_THROW, need_progress_msg, need_stolen, no_retries, NON_CONST_ITERATE, option, order_first, output, NStr::ParseEscapes(), port, prioritized_aff, progress_msg, pullback, qclass, qname, CNetScheduleKey::queue, queue_from_job_key, reader_affinity, s_AddOption, s_AffinityMayChangeOption, s_AffOption, s_AlertOption, s_AnyAffOption, s_AuthTokenOption, s_BlacklistOption, s_CommentOption, s_CountOption, s_DataOption, s_DelOption, s_DescriptionOption, s_DrainOption, s_EffectiveOption, s_ErrMsgOption, s_ExclusiveNewAffOption, s_FieldsOption, s_GroupMayChangeOption, s_GroupOption, s_InputOption, s_IpOption, s_JobKeyOption, s_JobReturnCodeOption, s_ModeOption, s_MskOption, s_NcbiPhidOption, s_NeedProgressMsgOption, s_NeedStolenOption, s_NoRetriesOption, s_OptionOption, s_OrderOption, s_OutputOption, s_PortOption, s_PrioritizedAffOption, s_ProgressMsgOption, s_PullbackOption, s_QClassOption, s_QNameOption, s_ReaderAffOption, s_ScopeOption, s_ServiceOption, s_SidOption, s_StartAfterOption, s_StatusOption, s_TimeoutOption, s_UserOption, s_VersionOption, s_WnodeAffOption, scope, service, CRequestContext::SetHitID(), CRequestContext::SetSessionID(), sid, NStr::Split(), start_after, start_after_job_id, NStr::StringToInt(), CNetScheduleAPI::StringToStatus(), NStr::StringToUInt(), timeout, user, val, wnode_affinity, x_CheckAffinityList(), x_CheckGroupList(), x_CheckQueueName(), x_GetBooleanValue(), x_GetDumpFields(), x_GetOrderFirst(), x_NormalizeErrorMessage(), and x_Reset().

Referenced by CNetScheduleHandler::x_ProcessMsgBatchJob(), and CNetScheduleHandler::x_ProcessMsgRequest().

◆ x_CheckAffinityList()

void SNSCommandArguments::x_CheckAffinityList ( const string val)
private

Definition at line 454 of file ns_command_arguments.cpp.

References kNetScheduleMaxDBDataSize, NCBI_THROW, NStr::Split(), and val.

Referenced by AssignValues().

◆ x_CheckGroupList()

void SNSCommandArguments::x_CheckGroupList ( const string val)
private

Definition at line 472 of file ns_command_arguments.cpp.

References group, kNetScheduleMaxDBDataSize, NCBI_THROW, NStr::Split(), and val.

Referenced by AssignValues().

◆ x_CheckQueueName()

void SNSCommandArguments::x_CheckQueueName ( const string val,
const string key 
)
private

◆ x_GetBooleanValue()

bool SNSCommandArguments::x_GetBooleanValue ( const string val,
const string key 
)
private

Definition at line 501 of file ns_command_arguments.cpp.

References ncbi::grid::netcache::search::fields::key, NCBI_THROW, and val.

Referenced by AssignValues().

◆ x_GetDumpFields()

TDumpFields SNSCommandArguments::x_GetDumpFields ( const string val)
private

Definition at line 548 of file ns_command_arguments.cpp.

References eAll, ERR_POST, ks_DumpFields, NStr::Split(), val, and Warning().

Referenced by AssignValues().

◆ x_GetOrderFirst()

bool SNSCommandArguments::x_GetOrderFirst ( const string val)
private

Definition at line 533 of file ns_command_arguments.cpp.

References first(), last(), NCBI_THROW, and val.

Referenced by AssignValues().

◆ x_NormalizeErrorMessage()

string SNSCommandArguments::x_NormalizeErrorMessage ( const string val)
private

Definition at line 517 of file ns_command_arguments.cpp.

References ERR_POST, kNetScheduleMaxDBErrSize, suffix, val, and Warning().

Referenced by AssignValues().

◆ x_Reset()

void SNSCommandArguments::x_Reset ( void  )
private

Member Data Documentation

◆ aff_to_add

string SNSCommandArguments::aff_to_add

◆ aff_to_del

string SNSCommandArguments::aff_to_del

◆ affinity_may_change

bool SNSCommandArguments::affinity_may_change

◆ affinity_token

string SNSCommandArguments::affinity_token

◆ alert

string SNSCommandArguments::alert

◆ any_affinity

bool SNSCommandArguments::any_affinity

◆ auth_token

string SNSCommandArguments::auth_token

◆ blacklist

bool SNSCommandArguments::blacklist

◆ client_data

string SNSCommandArguments::client_data

◆ client_data_version

int SNSCommandArguments::client_data_version

◆ cmd

string SNSCommandArguments::cmd

◆ comment

string SNSCommandArguments::comment

◆ count

unsigned int SNSCommandArguments::count

◆ description

string SNSCommandArguments::description

◆ drain

bool SNSCommandArguments::drain

◆ dump_fields

TDumpFields SNSCommandArguments::dump_fields

◆ effective

bool SNSCommandArguments::effective

◆ err_msg

string SNSCommandArguments::err_msg

◆ exclusive_new_aff

bool SNSCommandArguments::exclusive_new_aff

◆ group

string SNSCommandArguments::group

◆ group_may_change

bool SNSCommandArguments::group_may_change

◆ input

string SNSCommandArguments::input

◆ ip

string SNSCommandArguments::ip

◆ job_id

unsigned int SNSCommandArguments::job_id

◆ job_key

string SNSCommandArguments::job_key

◆ job_mask

unsigned int SNSCommandArguments::job_mask

◆ job_return_code

int SNSCommandArguments::job_return_code

◆ job_statuses

vector<TJobStatus> SNSCommandArguments::job_statuses

◆ job_statuses_string

string SNSCommandArguments::job_statuses_string

◆ mode

bool SNSCommandArguments::mode

◆ ncbi_phid

string SNSCommandArguments::ncbi_phid

◆ need_progress_msg

bool SNSCommandArguments::need_progress_msg

◆ need_stolen

bool SNSCommandArguments::need_stolen

◆ no_retries

bool SNSCommandArguments::no_retries

◆ option

string SNSCommandArguments::option

◆ order_first

bool SNSCommandArguments::order_first

◆ output

string SNSCommandArguments::output

◆ port

unsigned int SNSCommandArguments::port

◆ prioritized_aff

bool SNSCommandArguments::prioritized_aff

◆ progress_msg

string SNSCommandArguments::progress_msg

◆ pullback

bool SNSCommandArguments::pullback

◆ qclass

string SNSCommandArguments::qclass

◆ qname

string SNSCommandArguments::qname

◆ queue_from_job_key

string SNSCommandArguments::queue_from_job_key

◆ reader_affinity

bool SNSCommandArguments::reader_affinity

◆ scope

string SNSCommandArguments::scope

◆ service

string SNSCommandArguments::service

◆ sid

string SNSCommandArguments::sid

◆ start_after

string SNSCommandArguments::start_after

Definition at line 118 of file ns_command_arguments.hpp.

Referenced by AssignValues(), and x_Reset().

◆ start_after_job_id

unsigned int SNSCommandArguments::start_after_job_id

◆ timeout

unsigned int SNSCommandArguments::timeout

◆ user

string SNSCommandArguments::user

◆ wnode_affinity

bool SNSCommandArguments::wnode_affinity

The documentation for this struct was generated from the following files:
Modified on Fri Jun 14 16:54:34 2024 by modify_doxy.py rev. 669887