Location of a persisted Persistable instance in a database. More...

#include <DbStorageLocation.h>

Inheritance diagram for lsst::daf::persistence::DbStorageLocation:

Public Types
typedef std::shared_ptr< DbStorageLocation >	Ptr

enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback) (const memId cid)
	A function used to register a callback. More...

typedef memId(*	memCallback) (const Citizen *ptr)

Public Member Functions
	DbStorageLocation (void)
	Default constructor. More...

	DbStorageLocation (std::string const &url)
	Constructor from CORAL-style URL. More...

virtual	~DbStorageLocation (void)
	Destructor. More...

virtual std::string	toString (void) const
	Produce a string (URL) representation of the DbStorageLocation. More...

virtual std::string	getConnString (void) const
	Produce a CORAL-style connection string representation of the DbStorageLocation. More...

virtual std::string const &	getDbType (void) const
	Accessor for database type. More...

virtual std::string const &	getHostname (void) const
	Accessor for database hostname. More...

virtual std::string const &	getPort (void) const
	Accessor for database port number. More...

virtual std::string const &	getUsername (void) const
	Accessor for username. More...

virtual std::string const &	getPassword (void) const
	Accessor for password. More...

virtual std::string const &	getDbName (void) const
	Accessor for database name. More...

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

Census
Provide a list of current Citizens
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector< const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

callbackIDs
Set callback Ids. The old Id is returned
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

Location of a persisted Persistable instance in a database.

Provides database connection information for DbStorage. Can be initialized with either an all-in-one URL containing username and password information or a CORAL-style connection string URL with separate username and password.

Definition at line 58 of file DbStorageLocation.h.

Member Typedef Documentation

◆ memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

◆ memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

◆ memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

◆ Ptr

typedef std::shared_ptr<DbStorageLocation> lsst::daf::persistence::DbStorageLocation::Ptr

Definition at line 60 of file DbStorageLocation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

88 { magicSentinel = 0xdeadbeef };

lsst::daf::base::Citizen::magicSentinel

Definition: Citizen.h:88

Constructor & Destructor Documentation

◆ DbStorageLocation() [1/2]

lsst::daf::persistence::DbStorageLocation::DbStorageLocation ( void )

Default constructor.

Definition at line 55 of file DbStorageLocation.cc.

                                          :
     lsst::daf::base::Citizen(typeid(*this)),
     _dbType(), _hostname(), _port(), _username(), _password(), _dbName() {
 }

◆ DbStorageLocation() [2/2]

lsst::daf::persistence::DbStorageLocation::DbStorageLocation ( std::string const & url )

Constructor from CORAL-style URL.

Parameters

[in] url CORAL-style connection string (database type, hostname, port, database name)

Definition at line 64 of file DbStorageLocation.cc.

                                                          :
     lsst::daf::base::Citizen(typeid(*this)) {
     boost::smatch what;
     boost::regex
         expression("(\\w+)://(\\S+):(\\d+)/(\\S+)");
     if (boost::regex_match(url, what, expression)) {
         _dbType = what[1];
         _hostname = what[2];
         _port = what[3];
         _dbName = what[4];
         _username = DbAuth::username(_hostname, _port);
         _password = DbAuth::password(_hostname, _port);
     }
     else {
         throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
             "Unparseable connection string passed to DbStorageLocation: " +
             url);
     }
 }

◆ ~DbStorageLocation()

lsst::daf::persistence::DbStorageLocation::~DbStorageLocation ( void )

virtual

Destructor.

Definition at line 86 of file DbStorageLocation.cc.

86 {

87 }

Member Function Documentation

◆ census() [1/3]

int lsst::daf::base::Citizen::census	(	int	,
		memId	startingMemId = `0`
	)

staticinherited

How many active Citizens are there?

Parameters

startingMemId Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

   {
     if (startingMemId == 0) {  // easy
         ReadGuard guard(citizenLock);
         return _activeCitizens.size();
     }
 
     int n = 0;
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_CitizenId >= startingMemId) {
             n++;
         }
     }
 
     return n;
 }

◆ census() [2/3]

void lsst::daf::base::Citizen::census	(	std::ostream &	stream,
		memId	startingMemId = `0`
	)

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

   {
     ReadGuard guard(citizenLock);
 
     std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());
 
     for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
          citizen != end; ++citizen) {
         if ((*citizen)->getId() >= startingMemId) {
             stream << (*citizen)->repr() << "\n";
         }
     }
 }

◆ census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                                {
     std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
     ReadGuard guard(citizenLock);
     vec->reserve(_activeCitizens.size());
 
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         vec->push_back(dynamic_cast<Citizen const*>(cur->first));
     }
 
     std::sort(vec->begin(), vec->end(), cmpId);
 
     return vec;
 }

◆ getConnString()

std::string lsst::daf::persistence::DbStorageLocation::getConnString ( void ) const

virtual

Produce a CORAL-style connection string representation of the DbStorageLocation.

Returns: String suitable for passing to CORAL functions

Definition at line 101 of file DbStorageLocation.cc.

                                                      {
     return _dbType + "://" + _hostname + ":" + _port + "/" + _dbName;
 }

◆ getDbName()

std::string const & lsst::daf::persistence::DbStorageLocation::getDbName ( void ) const

virtual

Accessor for database name.

Returns: Reference to database name string.

Definition at line 143 of file DbStorageLocation.cc.

                                                         {
     return _dbName;
 }

◆ getDbType()

std::string const & lsst::daf::persistence::DbStorageLocation::getDbType ( void ) const

virtual

Accessor for database type.

Returns: Reference to database type string.

Definition at line 108 of file DbStorageLocation.cc.

                                                         {
     return _dbType;
 }

◆ getHostname()

std::string const & lsst::daf::persistence::DbStorageLocation::getHostname ( void ) const

virtual

Accessor for database hostname.

Returns: Reference to database hostname string.

Definition at line 115 of file DbStorageLocation.cc.

                                                           {
     return _hostname;
 }

◆ getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

206 { return _CitizenId; }

◆ getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

209 { return _nextMemId(); }

◆ getPassword()

std::string const & lsst::daf::persistence::DbStorageLocation::getPassword ( void ) const

virtual

Accessor for password.

Returns: Reference to password string.

Definition at line 136 of file DbStorageLocation.cc.

                                                           {
     return _password;
 }

◆ getPort()

std::string const & lsst::daf::persistence::DbStorageLocation::getPort ( void ) const

virtual

Accessor for database port number.

Returns: Reference to database port number string.

Definition at line 122 of file DbStorageLocation.cc.

                                                       {
     return _port;
 }

◆ getUsername()

std::string const & lsst::daf::persistence::DbStorageLocation::getUsername ( void ) const

virtual

Accessor for username.

Returns: Reference to username string.

Definition at line 129 of file DbStorageLocation.cc.

                                                           {
     return _username;
 }

◆ hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                       {
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
     for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
 
     return false;
 }

◆ init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                          {
     volatile int dummy = 1;
     return dummy;
 }

◆ markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                         {
     WriteGuard guard(citizenLock);
     _persistentCitizens[this] = _activeCitizens[this];
     _activeCitizens.erase(this);
 }

◆ repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                      {
     return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                       lsst::utils::demangleType(_typeName));
 }

◆ setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

   {
     Citizen::memCallback old = _corruptionCallback;
     _corruptionCallback = func;
 
     return old;
 }

◆ setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

   {
     Citizen::memCallback old = _deleteCallback;
     _deleteCallback = func;
 
     return old;
 }

◆ setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _deleteId;
     _deleteId = id;
 
     return oldId;
 }

◆ setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

   {
     Citizen::memNewCallback old = _newCallback;
     _newCallback = func;
 
     return old;
 }

◆ setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _newId;
     _newId = id;
 
     return oldId;
 }

◆ toString()

std::string lsst::daf::persistence::DbStorageLocation::toString ( void ) const

virtual

Produce a string (URL) representation of the DbStorageLocation.

Returns: String suitable for constructing another DbStorageLocation

Definition at line 92 of file DbStorageLocation.cc.

                                                 {
     return _dbType + "://" + _username + ":" + _password + "@" +
         _hostname + ":" + _port + "/" + _dbName;
 }

The documentation for this class was generated from the following files:

/j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/16.0-8-gfd407c0+5/include/lsst/daf/persistence/DbStorageLocation.h
/j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/16.0-8-gfd407c0+5/src/DbStorageLocation.cc

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ memCallback

◆ memId

◆ memNewCallback

◆ Ptr

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ DbStorageLocation() [1/2]

◆ DbStorageLocation() [2/2]

◆ ~DbStorageLocation()

Member Function Documentation

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ getConnString()

◆ getDbName()

◆ getDbType()

◆ getHostname()

◆ getId()

◆ getNextMemId()

◆ getPassword()

◆ getPort()

◆ getUsername()

◆ hasBeenCorrupted()

◆ init()

◆ markPersistent()

◆ repr()

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setNewCallback()

◆ setNewCallbackId()

◆ toString()