NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
CRef< C, Locker > Class Template Reference

Search Toolkit Book for CRef

CRef –. More...

#include <corelib/ncbiobj.hpp>

Inherited by CBlockingQueue< TRequest >::CCompletingHandle, and CBlockingQueue_ForServer::CCompletingHandle.

+ Collaboration diagram for CRef< C, Locker >:

Public Types

typedef C element_type
 Define alias element_type. More...
 
typedef element_type TObjectType
 Define alias TObjectType. More...
 
typedef Locker locker_type
 Define alias for locking type. More...
 
typedef CRef< C, Locker > TThisType
 Alias for this template type. More...
 

Public Member Functions

 CRef (void) noexcept
 Constructor for null pointer. More...
 
 CRef (ENull) noexcept
 Constructor for ENull pointer. More...
 
 CRef (TObjectType *ptr)
 Constructor for explicit type conversion from pointer to object. More...
 
 CRef (TObjectType *ptr, const locker_type &locker_value)
 Constructor for explicit type conversion from pointer to object. More...
 
 CRef (const TThisType &ref)
 Copy constructor from an existing CRef object. More...
 
template<class TDerived >
requires derived_from< TDerived, TObjectType > CRef (const CRef< TDerived, Locker > &ref)
 Copy constructor from an existing CRef object of derived type. More...
 
 CRef (TThisType &&ref) noexcept
 Move constructor from an existing CRef object. More...
 
template<class TDerived >
requires derived_from< TDerived, TObjectType > CRef (CRef< TDerived, Locker > &&ref) noexcept
 Move constructor from an existing CRef object of derived type. More...
 
 ~CRef (void)
 Destructor. More...
 
const locker_type & GetLocker (void) const noexcept
 Get reference to locker object. More...
 
bool operator! (void) const noexcept
 Check if CRef is empty – not pointing to any object, which means having a null value. More...
 
bool Empty (void) const noexcept
 Check if CRef is empty – not pointing to any object, which means having a null value. More...
 
bool NotEmpty (void) const noexcept
 Check if CRef is not empty – pointing to an object and has a non-null value. More...
 
bool IsNull (void) const noexcept
 Check if pointer is null – same effect as Empty(). More...
 
bool NotNull (void) const noexcept
 Check if pointer is not null – same effect as NotEmpty(). More...
 
void Swap (TThisType &ref) noexcept
 Swaps the pointer with another reference. More...
 
void Reset (void) noexcept
 Reset reference object. More...
 
void Reset (TObjectType *newPtr)
 Reset reference object to new pointer. More...
 
TObjectType * ReleaseOrNull (void)
 Release a reference to the object and return a pointer to the object. More...
 
TObjectType * Release (void)
 Release a reference to the object and return a pointer to the object. More...
 
void AtomicResetFrom (const TThisType &ref)
 Reset reference object to new pointer. More...
 
void AtomicReleaseTo (TThisType &ref)
 Release referenced object to another CRef<> object. More...
 
TThisType & operator= (const TThisType &ref)
 Assignment operator for references. More...
 
template<class TDerived >
requires derived_from< TDerived, TObjectType > TThisType & operator= (const CRef< TDerived, Locker > &ref)
 Assignment operator for references of derived types. More...
 
TThisType & operator= (TThisType &&ref) noexcept
 Move assignment operator for references. More...
 
template<class TDerived >
requires derived_from< TDerived, TObjectType > TThisType & operator= (CRef< TDerived, Locker > &&ref) noexcept
 Move assignment operator for references of derived types. More...
 
TThisType & operator= (TObjectType *ptr)
 Assignment operator for references with right hand side set to a pointer. More...
 
TThisType & operator= (ENull) noexcept
 Assignment operator with right hand side set to ENull. More...
 
TObjectType * GetNonNullPointer (void)
 Get pointer value and throw a null pointer exception if pointer is null. More...
 
TObjectType * GetPointerOrNull (void) noexcept
 Get pointer value. More...
 
TObjectType * GetPointer (void) noexcept
 Get pointer,. More...
 
TObjectType & GetObject (void)
 Get object. More...
 
TObjectType & operator* (void)
 Dereference operator returning object. More...
 
TObjectType * operator-> (void)
 Reference operator. More...
 
const TObjectType * GetNonNullPointer (void) const
 Get pointer value and throw a null pointer exception if pointer is null – constant version. More...
 
const TObjectType * GetPointerOrNull (void) const noexcept
 Get pointer value – constant version. More...
 
const TObjectType * GetPointer (void) const noexcept
 Get pointer – constant version,. More...
 
const TObjectType & GetObject (void) const
 Get object – constant version. More...
 
const TObjectType & operator* (void) const
 Dereference operator returning object – constant version. More...
 
const TObjectType * operator-> (void) const
 Reference operator – constant version. More...
 
 operator TObjectType * (void) noexcept
 Dereference operator returning pointer. More...
 
 operator const TObjectType * (void) const noexcept
 Dereference operator returning pointer – constant version. More...
 
TObjectType * GetNonNullNCPointer (void) const
 Get pointer value and throw a null pointer exception if pointer is null. More...
 
TObjectType * GetNCPointerOrNull (void) const noexcept
 Get pointer value. More...
 
TObjectType * GetNCPointer (void) const noexcept
 Get pointer,. More...
 
TObjectType & GetNCObject (void) const
 Get object. More...
 

Static Public Member Functions

static void ThrowNullPointerException (void)
 

Private Member Functions

void x_LockFromPtr ()
 
void x_LockFromRef ()
 
void x_LockFromMoveConstructor (const Locker &src_locker) noexcept
 
void x_AssignFromRef (TObjectType *newPtr)
 
void x_MoveAssign (const Locker &src_locker, TObjectType *newPtr) noexcept
 
TObjectType * AtomicSwap (TObjectType *ptr)
 
void operator- (TObjectType *) const
 
void operator- (int) const
 
void operator+ (int) const
 

Private Attributes

pair_base_member< locker_type, TObjectType * > m_Data
 Pointer to object. More...
 

Friends

template<class TDerived , class TLocker >
class CRef
 
template<class TDerived , class TLocker >
class CConstRef
 

Detailed Description

template<class C, class Locker>
class CRef< C, Locker >

CRef –.

Define a template class that stores a pointer to an object and defines methods for referencing that object.

Definition at line 618 of file ncbiobj.hpp.


The documentation for this class was generated from the following file:
Modified on Sat Nov 07 14:11:26 2026 by modify_doxy.py rev. 717554