NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
INetServerConnectionListener Struct Referenceabstract

Search Toolkit Book for INetServerConnectionListener

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

+ Inheritance diagram for INetServerConnectionListener:
+ Collaboration diagram for INetServerConnectionListener:

Public Types

using TPropCreator = function< INetServerProperties *()>
 
using TEventHandler = CNetService::TEventHandler
 
- 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...
 

Public Member Functions

virtual TPropCreator GetPropCreator () const
 
virtual INetServerConnectionListenerClone ()=0
 
virtual void OnConnected (CNetServerConnection &connection)=0
 
void OnError (const string &err_msg, CNetServer &server)
 
void OnWarning (const string &warn_msg, CNetServer &server)
 
void SetErrorHandler (TEventHandler error_handler)
 
void SetWarningHandler (TEventHandler warning_handler)
 
- 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
 

Protected Member Functions

 INetServerConnectionListener ()=default
 
 INetServerConnectionListener (const INetServerConnectionListener &)
 
INetServerConnectionListeneroperator= (const INetServerConnectionListener &)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Private Member Functions

virtual void OnErrorImpl (const string &err_msg, CNetServer &server)=0
 
virtual void OnWarningImpl (const string &warn_msg, CNetServer &server)=0
 

Private Attributes

TEventHandler m_ErrorHandler
 
TEventHandler m_WarningHandler
 

Additional Inherited Members

- 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)
 
- 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...
 

Detailed Description

Definition at line 78 of file srv_connections_impl.hpp.

Member Typedef Documentation

◆ TEventHandler

Definition at line 81 of file srv_connections_impl.hpp.

◆ TPropCreator

Definition at line 80 of file srv_connections_impl.hpp.

Constructor & Destructor Documentation

◆ INetServerConnectionListener() [1/2]

INetServerConnectionListener::INetServerConnectionListener ( )
protecteddefault

◆ INetServerConnectionListener() [2/2]

INetServerConnectionListener::INetServerConnectionListener ( const INetServerConnectionListener )
protected

Definition at line 120 of file srv_connections.cpp.

Member Function Documentation

◆ Clone()

virtual INetServerConnectionListener* INetServerConnectionListener::Clone ( )
pure virtual

◆ GetPropCreator()

INetServerConnectionListener::TPropCreator INetServerConnectionListener::GetPropCreator ( ) const
virtual

Reimplemented in CNetScheduleServerListener, and CNetCacheServerListener.

Definition at line 101 of file srv_connections.cpp.

◆ OnConnected()

virtual void INetServerConnectionListener::OnConnected ( CNetServerConnection connection)
pure virtual

◆ OnError()

void INetServerConnectionListener::OnError ( const string err_msg,
CNetServer server 
)

Definition at line 106 of file srv_connections.cpp.

References m_ErrorHandler, and OnErrorImpl().

Referenced by s_TrapErrors().

◆ OnErrorImpl()

virtual void INetServerConnectionListener::OnErrorImpl ( const string err_msg,
CNetServer server 
)
privatepure virtual

◆ OnWarning()

void INetServerConnectionListener::OnWarning ( const string warn_msg,
CNetServer server 
)

◆ OnWarningImpl()

virtual void INetServerConnectionListener::OnWarningImpl ( const string warn_msg,
CNetServer server 
)
privatepure virtual

◆ operator=()

INetServerConnectionListener & INetServerConnectionListener::operator= ( const INetServerConnectionListener )
protected

Definition at line 125 of file srv_connections.cpp.

◆ SetErrorHandler()

void INetServerConnectionListener::SetErrorHandler ( TEventHandler  error_handler)

Definition at line 131 of file srv_connections.cpp.

References _ASSERT, and m_ErrorHandler.

◆ SetWarningHandler()

void INetServerConnectionListener::SetWarningHandler ( TEventHandler  warning_handler)

Member Data Documentation

◆ m_ErrorHandler

TEventHandler INetServerConnectionListener::m_ErrorHandler
private

Definition at line 104 of file srv_connections_impl.hpp.

Referenced by OnError(), and SetErrorHandler().

◆ m_WarningHandler

TEventHandler INetServerConnectionListener::m_WarningHandler
private

Definition at line 105 of file srv_connections_impl.hpp.

Referenced by OnWarning(), and SetWarningHandler().


The documentation for this struct was generated from the following files:
Modified on Wed Jun 19 17:04:59 2024 by modify_doxy.py rev. 669887