NCBI C++ ToolKit
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SNetServerImpl Struct Reference

Search Toolkit Book for SNetServerImpl

#include "srv_connections_impl.hpp"
(Private to src/connect/services.)

+ Inheritance diagram for SNetServerImpl:
+ Collaboration diagram for SNetServerImpl:

Classes

struct  SConnectDeadline
 

Public Member Functions

 SNetServerImpl (CNetService::TInstance service, SNetServerInPool *server_in_pool)
 
void TryExec (INetServerExecHandler &handler, const STimeout *timeout=NULL)
 
CNetServer::SExecResult ConnectAndExec (const string &cmd, bool multiline_output, bool retry_on_exception=false)
 
void ConnectAndExec (const string &cmd, bool multiline_output, CNetServer::SExecResult &exec_result, const STimeout *timeout=NULL, INetServerExecListener *exec_listener=NULL)
 
template<class TProperties >
CRef< TProperties > Get ()
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Static Public Member Functions

static void ConnectImpl (CSocket &, SConnectDeadline &, const SSocketAddress &, const SSocketAddress &)
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 

Public Attributes

CNetService m_Service
 
CRef< SNetServerInPoolm_ServerInPool
 

Additional Inherited Members

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 250 of file srv_connections_impl.hpp.

Constructor & Destructor Documentation

◆ SNetServerImpl()

SNetServerImpl::SNetServerImpl ( CNetService::TInstance  service,
SNetServerInPool server_in_pool 
)
inline

Definition at line 254 of file srv_connections_impl.hpp.

Member Function Documentation

◆ ConnectAndExec() [1/2]

CNetServer::SExecResult SNetServerImpl::ConnectAndExec ( const string cmd,
bool  multiline_output,
bool  retry_on_exception = false 
)

◆ ConnectAndExec() [2/2]

void SNetServerImpl::ConnectAndExec ( const string cmd,
bool  multiline_output,
CNetServer::SExecResult exec_result,
const STimeout timeout = NULL,
INetServerExecListener exec_listener = NULL 
)

Definition at line 661 of file srv_connections.cpp.

References cmd, and TryExec().

◆ ConnectImpl()

void SNetServerImpl::ConnectImpl ( CSocket socket,
SConnectDeadline deadline,
const SSocketAddress actual,
const SSocketAddress original 
)
static

◆ Get()

template<class TProperties >
CRef<TProperties> SNetServerImpl::Get ( void  )
inline

◆ TryExec()

void SNetServerImpl::TryExec ( INetServerExecHandler handler,
const STimeout timeout = NULL 
)

Member Data Documentation

◆ m_ServerInPool

CRef<SNetServerInPool> SNetServerImpl::m_ServerInPool

◆ m_Service

CNetService SNetServerImpl::m_Service

The documentation for this struct was generated from the following files:
Modified on Sat Dec 02 09:21:55 2023 by modify_doxy.py rev. 669887