NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
CNetService Class Reference

Search Toolkit Book for CNetService

#include <connect/services/netservice_api.hpp>

+ Collaboration diagram for CNetService:

Public Types

enum  EIterationMode { eSortByLoad , eRandomize , eRoundRobin , eIncludePenalized }
 
enum  ECmdOutputStyle {
  eSingleLineOutput , eUrlEncodedOutput , eMultilineOutput , eMultilineOutput_NoHeaders ,
  eMultilineOutput_NetCacheStyle
}
 
typedef SNetServiceImpl * TInstance
 
using TEventHandler = function< bool(const string &, CNetServer)>
 

Public Member Functions

 CNetService (EVoid)
 
 CNetService (SNetServiceImpl *impl)
 
CNetService & operator= (SNetServiceImpl *impl)
 
 operator SNetServiceImpl * ()
 
 operator const SNetServiceImpl * () const
 
SNetServiceImpl & operator-- (int)
 
const SNetServiceImpl & operator-- (int) const
 
SNetServiceImpl * operator-> ()
 
const SNetServiceImpl * operator-> () const
 
 CNetService ()
 
const string & GetServiceName () const
 
CNetServerPool GetServerPool ()
 
CNetServer GetServer (unsigned host, unsigned short port)
 
CNetServer GetServer (const string &host, unsigned short port)
 
CNetServiceIterator Iterate (EIterationMode mode=eSortByLoad)
 
CNetServiceIterator Iterate (CNetServer::TInstance priority_server)
 
CNetServiceIterator IterateByWeight (const string &key)
 
CNetServiceIterator ExcludeServer (CNetServer::TInstance server)
 Start iteration excluding 'server' (return the next server after 'server' or NULL). More...
 
CNetServiceIterator FindServer (INetServerFinder *finder, EIterationMode mode=eSortByLoad)
 
bool IsLoadBalanced () const
 
CNetServer::SExecResult FindServerAndExec (const string &cmd, bool multiline_output=false)
 
void ExecOnAllServers (const string &cmd)
 
void PrintCmdOutput (const string &cmd, CNcbiOstream &output_stream, ECmdOutputStyle output_style, CNetService::EIterationMode=CNetService::eSortByLoad)
 
CNetService Clone (const string &name)
 
void SetErrorHandler (TEventHandler error_handler)
 
void SetWarningHandler (TEventHandler warning_handler)
 

Static Public Member Functions

static void AllowXSiteConnections ()
 
static bool IsUsingXSiteProxy ()
 
static CNetService Create (const string &api_name, const string &service_name, const string &client_name)
 

Protected Attributes

CNetRef< SNetServiceImpl > m_Impl
 

Detailed Description

Definition at line 85 of file netservice_api.hpp.

Member Typedef Documentation

◆ TEventHandler

using CNetService::TEventHandler = function<bool(const string&, CNetServer)>

Definition at line 136 of file netservice_api.hpp.

◆ TInstance

typedef SNetServiceImpl* CNetService::TInstance

Definition at line 87 of file netservice_api.hpp.

Member Enumeration Documentation

◆ ECmdOutputStyle

enum CNetService::ECmdOutputStyle
Enumerator
eSingleLineOutput 
eUrlEncodedOutput 
eMultilineOutput 
eMultilineOutput_NoHeaders 
eMultilineOutput_NetCacheStyle 

Definition at line 121 of file netservice_api.hpp.

◆ EIterationMode

enum CNetService::EIterationMode
Enumerator
eSortByLoad 
eRandomize 
eRoundRobin 
eIncludePenalized 

Definition at line 93 of file netservice_api.hpp.

Constructor & Destructor Documentation

◆ CNetService() [1/3]

CNetService::CNetService ( EVoid  )
inline

Definition at line 87 of file netservice_api.hpp.

◆ CNetService() [2/3]

CNetService::CNetService ( SNetServiceImpl *  impl)
inline

Definition at line 87 of file netservice_api.hpp.

◆ CNetService() [3/3]

CNetService::CNetService ( )
inline

Definition at line 87 of file netservice_api.hpp.

Member Function Documentation

◆ AllowXSiteConnections()

static void CNetService::AllowXSiteConnections ( )
static

Referenced by NAutomation::CAutomationProc::ExecAllowXSite(), and CGridCommandLineInterfaceApp::Run().

◆ Clone()

CNetService CNetService::Clone ( const string &  name)

Definition at line 1378 of file netservice_api.cpp.

References _ASSERT, SNetServiceImpl::Clone(), and m_Impl.

Referenced by Create(), and SNetStorageRPC::GetServiceIfLocator().

◆ Create()

CNetService CNetService::Create ( const string &  api_name,
const string &  service_name,
const string &  client_name 
)
static

Definition at line 1455 of file netservice_api.cpp.

References Clone(), and SNetServiceImpl::Create().

Referenced by CGridCommandLineInterfaceApp::Cmd_Discover(), and g_DiscoverService().

◆ ExcludeServer()

CNetServiceIterator CNetService::ExcludeServer ( CNetServer::TInstance  server)

Start iteration excluding 'server' (return the next server after 'server' or NULL).

Definition at line 1316 of file netservice_api.cpp.

References ITERATE, m_Impl, SNetServerImpl::m_ServerInPool, SDiscoveredServers::m_Servers, and NULL.

Referenced by CCgi2RCgiApp::GetStatus().

◆ ExecOnAllServers()

void CNetService::ExecOnAllServers ( const string &  cmd)

Definition at line 913 of file netservice_api.cpp.

References cmd, eIncludePenalized, and Iterate().

Referenced by SNetCacheAdminImpl::ExecOnAllServers(), g_ResumeNetSchedule(), and g_SuspendNetSchedule().

◆ FindServer()

CNetServiceIterator CNetService::FindServer ( INetServerFinder *  finder,
CNetService::EIterationMode  mode = eSortByLoad 
)

Definition at line 1338 of file netservice_api.cpp.

References INetServerFinder::Consider(), CNetServiceException::eCommunicationError, CException::GetErrCode(), Iterate(), LOG_POST, and CException::what().

Referenced by CNetScheduleNotificationHandler::RequestJob().

◆ FindServerAndExec()

CNetServer::SExecResult CNetService::FindServerAndExec ( const string &  cmd,
bool  multiline_output = false 
)

Definition at line 907 of file netservice_api.cpp.

References cmd, and m_Impl.

Referenced by SNetScheduleAPIImpl::GetQueueParams(), SNetCacheAPIImpl::InitiateWriteCmd(), and SNetScheduleAPIImpl::SServerParamsSync::operator()().

◆ GetServer() [1/2]

CNetServer CNetService::GetServer ( const string &  host,
unsigned short  port 
)

Definition at line 838 of file netservice_api.cpp.

References m_Impl.

◆ GetServer() [2/2]

CNetServer CNetService::GetServer ( unsigned  host,
unsigned short  port 
)

Definition at line 844 of file netservice_api.cpp.

References m_Impl.

Referenced by SNetCacheAPIImpl::ExecMirrorAware(), and CCgi2RCgiApp::GetStatus().

◆ GetServerPool()

CNetServerPool CNetService::GetServerPool ( )

Definition at line 734 of file netservice_api.cpp.

References m_Impl.

Referenced by CStringOrBlobStorageReader::CStringOrBlobStorageReader(), CNetCacheAPI::SetCommunicationTimeout(), CNetScheduleAPI::SetCommunicationTimeout(), CGridCommandLineInterfaceApp::SetUp_NetCacheCmd(), and CGridCommandLineInterfaceApp::SetUp_NetScheduleCmd().

◆ GetServiceName()

const string & CNetService::GetServiceName ( ) const

Definition at line 729 of file netservice_api.cpp.

References m_Impl.

Referenced by SNetCacheAPIImpl::ExecMirrorAware(), CDataCrawlerCache::GetCompoundKey(), SNetCacheAPIImpl::Init(), SNetCacheAPIImpl::InitiateWriteCmd(), CGetStatisticsProcessor::Process(), and NDirectNetStorageImpl::CNetCache::SetLocator().

◆ IsLoadBalanced()

bool CNetService::IsLoadBalanced ( ) const

Definition at line 739 of file netservice_api.cpp.

References m_Impl.

Referenced by CGridCommandLineInterfaceApp::Cmd_PutBlob(), CGridCommandLineInterfaceApp::Cmd_ServerInfo(), SNetCacheAPIImpl::ExecMirrorAware(), g_ExecToJson(), SNetCacheAPIImpl::InitiateWriteCmd(), PrintCmdOutput(), CGridCommandLineInterfaceApp::PrintNetStorageServerInfo(), and SNetScheduleAPIImpl::x_ClearNode().

◆ IsUsingXSiteProxy()

static bool CNetService::IsUsingXSiteProxy ( )
static

◆ Iterate() [1/2]

CNetServiceIterator CNetService::Iterate ( CNetServer::TInstance  priority_server)

Definition at line 1272 of file netservice_api.cpp.

References m_Impl.

◆ Iterate() [2/2]

CNetServiceIterator CNetService::Iterate ( CNetService::EIterationMode  mode = eSortByLoad)

Definition at line 1248 of file netservice_api.cpp.

References eIncludePenalized, eRoundRobin, eSortByLoad, m_Impl, SDiscoveredServers::m_Servers, SDiscoveredServers::m_SuppressedBegin, and NCBI_THROW.

Referenced by SNetCacheMirrorTraversal::BeginIteration(), SRandomServiceTraversal::BeginIteration(), CGridCommandLineInterfaceApp::Cmd_Discover(), CGridCommandLineInterfaceApp::Cmd_Resume(), CGridCommandLineInterfaceApp::Cmd_ServerInfo(), CGridCommandLineInterfaceApp::Cmd_Stats(), CGridCommandLineInterfaceApp::Cmd_Suspend(), NAutomation::SNetCacheServer::Create(), NAutomation::SNetScheduleServer::Create(), NAutomation::SNetStorageServer::Create(), SNetStorageRPC::Exchange(), NAutomation::SNetCacheService::ExecGetServers(), NAutomation::SNetScheduleService::ExecGetServers(), NAutomation::SNetStorageService::ExecGetServers(), SNetCacheAPIImpl::ExecMirrorAware(), ExecOnAllServers(), FindServer(), g_ExecToJson(), g_GetWorkerNodeInfo(), g_GetWorkerNodes(), NAutomation::SNetServiceBase::GetServer(), SNetCacheMirrorTraversal::NextServer(), PrintCmdOutput(), CGridCommandLineInterfaceApp::PrintNetScheduleStats(), CGridCommandLineInterfaceApp::PrintNetScheduleStats_Generic(), CGridCommandLineInterfaceApp::PrintNetStorageServerConfig(), CGridCommandLineInterfaceApp::PrintNetStorageServerInfo(), SNetStorageObjectRPC::Read(), SNetStorageObjectRPC::Relocate(), CGridCommandLineInterfaceApp::ShutdownNetStorageServer(), and SNetScheduleAPIImpl::x_ClearNode().

◆ IterateByWeight()

CNetServiceIterator CNetService::IterateByWeight ( const string &  key)

Definition at line 1298 of file netservice_api.cpp.

References CChecksum::AddChars(), CChecksum::eCRC32, CChecksum::GetChecksum(), ncbi::grid::netcache::search::fields::key, m_Impl, SDiscoveredServers::m_Servers, SDiscoveredServers::m_SuppressedBegin, and NCBI_THROW.

Referenced by SWeightedServiceTraversal::BeginIteration().

◆ operator const SNetServiceImpl *()

CNetService::operator const SNetServiceImpl * ( ) const
inline

Definition at line 87 of file netservice_api.hpp.

◆ operator SNetServiceImpl *()

CNetService::operator SNetServiceImpl * ( )
inline

Definition at line 87 of file netservice_api.hpp.

◆ operator--() [1/2]

SNetServiceImpl& CNetService::operator-- ( int  )
inline

Definition at line 87 of file netservice_api.hpp.

◆ operator--() [2/2]

const SNetServiceImpl& CNetService::operator-- ( int  ) const
inline

Definition at line 87 of file netservice_api.hpp.

◆ operator->() [1/2]

SNetServiceImpl* CNetService::operator-> ( void  )
inline

Definition at line 87 of file netservice_api.hpp.

◆ operator->() [2/2]

const SNetServiceImpl* CNetService::operator-> ( void  ) const
inline

Definition at line 87 of file netservice_api.hpp.

◆ operator=()

CNetService& CNetService::operator= ( SNetServiceImpl *  impl)
inline

Definition at line 87 of file netservice_api.hpp.

◆ PrintCmdOutput()

void CNetService::PrintCmdOutput ( const string &  cmd,
CNcbiOstream &  output_stream,
CNetService::ECmdOutputStyle  output_style,
CNetService::EIterationMode  iteration_mode = CNetService::eSortByLoad 
)

Definition at line 749 of file netservice_api.cpp.

References cmd, eMultilineOutput_NetCacheStyle, eMultilineOutput_NoHeaders, eSingleLineOutput, eUrlEncodedOutput, CUrlArgs::GetArgs(), IsLoadBalanced(), Iterate(), ITERATE, and output.

Referenced by CGridCommandLineInterfaceApp::Cmd_Exec(), CGridCommandLineInterfaceApp::Cmd_QueueInfo(), CGridCommandLineInterfaceApp::Cmd_ServerInfo(), SNetCacheAdminImpl::PrintCmdOutput(), CGridCommandLineInterfaceApp::PrintNetScheduleStats(), and CGridCommandLineInterfaceApp::PrintNetScheduleStats_Generic().

◆ SetErrorHandler()

void CNetService::SetErrorHandler ( TEventHandler  error_handler)

Definition at line 1385 of file netservice_api.cpp.

References m_Impl.

◆ SetWarningHandler()

void CNetService::SetWarningHandler ( TEventHandler  warning_handler)

Definition at line 1390 of file netservice_api.cpp.

References m_Impl.

Referenced by CGridCommandLineInterfaceApp::SetUp_NetScheduleCmd(), NAutomation::SNetCacheService::SNetCacheService(), NAutomation::SNetScheduleService::SNetScheduleService(), and NAutomation::SNetStorageService::SNetStorageService().

Member Data Documentation

◆ m_Impl

CNetRef< SNetServiceImpl > CNetService::m_Impl
protected

Definition at line 87 of file netservice_api.hpp.

Referenced by Clone(), ExcludeServer(), FindServerAndExec(), GetServer(), GetServerPool(), GetServiceName(), IsLoadBalanced(), Iterate(), IterateByWeight(), SetErrorHandler(), and SetWarningHandler().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Fri Sep 20 14:57:19 2024 by modify_doxy.py rev. 669887