Base class for marshalling leases to and from PostgreSQL. More...

Inheritance diagram for isc::dhcp::PgSqlLeaseExchange:

Public Member Functions
	PgSqlLeaseExchange ()

virtual	~PgSqlLeaseExchange ()

Public Member Functions inherited from isc::db::PgSqlExchange
	PgSqlExchange (const size_t num_columns=0)
	Constructor.

virtual	~PgSqlExchange ()
	Destructor.

Protected Attributes
std::string	addr_str_
	Common Instance members used for binding and conversion.

time_t	cltt_

time_t	expire_

std::string	expire_str_

bool	fqdn_fwd_

bool	fqdn_rev_

std::string	hostname_

std::string	state_str_

uint32_t	subnet_id_

std::string	subnet_id_str_

std::string	user_context_

uint32_t	valid_lifetime_

std::string	valid_lifetime_str_

Protected Attributes inherited from isc::db::PgSqlExchange
std::vector< std::string >	columns_
	Stores text labels for columns, currently only used for logging and errors.

Additional Inherited Members
Static Public Member Functions inherited from isc::db::PgSqlExchange
static void	convertFromBytea (const PgSqlResult &r, const int row, const size_t col, uint8_t *buffer, const size_t buffer_size, size_t &bytes_converted)
	Converts a column in a row in a result set to a binary bytes.

static time_t	convertFromDatabaseTime (const std::string &db_time_val)
	Converts time stamp from the database to a time_t.

static std::string	convertToDatabaseTime (const time_t cltt, const uint32_t valid_lifetime)
	Converts lease expiration time to a text representation in local time.

static std::string	convertToDatabaseTime (const time_t input_time)
	Converts time_t value to a text representation in local time.

static std::string	dumpRow (const PgSqlResult &r, int row)
	Diagnostic tool which dumps the Result row contents as a string.

static std::string	getColumnLabel (const PgSqlResult &r, const size_t col)
	Fetches the name of the column in a result set.

static void	getColumnValue (const PgSqlResult &r, const int row, const size_t col, bool &value)
	Fetches boolean text ('t' or 'f') as a bool.

static void	getColumnValue (const PgSqlResult &r, const int row, const size_t col, std::string &value)
	Fetches text column value as a string.

template<typename T >
static void	getColumnValue (const PgSqlResult &r, const int row, const size_t col, T &value)
	Fetches a text column as the given value type.

static void	getColumnValue (const PgSqlResult &r, const int row, const size_t col, uint8_t &value)
	Fetches an integer text column as a uint8_t.

static isc::asiolink::IOAddress	getIPv6Value (const PgSqlResult &r, const int row, const size_t col)
	Converts a column in a row in a result set into IPv6 address.

static const char *	getRawColumnValue (const PgSqlResult &r, const int row, const size_t col)
	Gets a pointer to the raw column value in a result set row.

static bool	isColumnNull (const PgSqlResult &r, const int row, const size_t col)
	Returns true if a column within a row is null.

Detailed Description

Base class for marshalling leases to and from PostgreSQL.

Provides the common functionality to set up binding information between lease objects in the program and their database representation in the database.

Definition at line 346 of file pgsql_lease_mgr.cc.

Constructor & Destructor Documentation

◆ PgSqlLeaseExchange()

isc::dhcp::PgSqlLeaseExchange::PgSqlLeaseExchange ( )

inline

Definition at line 348 of file pgsql_lease_mgr.cc.

◆ ~PgSqlLeaseExchange()

virtual isc::dhcp::PgSqlLeaseExchange::~PgSqlLeaseExchange ( )

inlinevirtual

Definition at line 355 of file pgsql_lease_mgr.cc.

Member Data Documentation

◆ addr_str_

std::string isc::dhcp::PgSqlLeaseExchange::addr_str_

protected

Common Instance members used for binding and conversion.

Definition at line 360 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::createBindForSend(), and isc::dhcp::PgSqlLease6Exchange::createBindForSend().

◆ cltt_

time_t isc::dhcp::PgSqlLeaseExchange::cltt_

protected

Definition at line 367 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::convertFromDatabase(), and isc::dhcp::PgSqlLease6Exchange::convertFromDatabase().

◆ expire_

time_t isc::dhcp::PgSqlLeaseExchange::expire_

protected

Definition at line 363 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::convertFromDatabase(), and isc::dhcp::PgSqlLease6Exchange::convertFromDatabase().

◆ expire_str_

std::string isc::dhcp::PgSqlLeaseExchange::expire_str_

protected

Definition at line 364 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::createBindForSend(), and isc::dhcp::PgSqlLease6Exchange::createBindForSend().

◆ fqdn_fwd_

bool isc::dhcp::PgSqlLeaseExchange::fqdn_fwd_

protected

Definition at line 368 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::convertFromDatabase(), and isc::dhcp::PgSqlLease6Exchange::convertFromDatabase().

◆ fqdn_rev_

bool isc::dhcp::PgSqlLeaseExchange::fqdn_rev_

protected

Definition at line 369 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::convertFromDatabase(), and isc::dhcp::PgSqlLease6Exchange::convertFromDatabase().

◆ hostname_

std::string isc::dhcp::PgSqlLeaseExchange::hostname_

protected

Definition at line 370 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::convertFromDatabase(), and isc::dhcp::PgSqlLease6Exchange::convertFromDatabase().

◆ state_str_

std::string isc::dhcp::PgSqlLeaseExchange::state_str_

protected

Definition at line 371 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::createBindForSend(), and isc::dhcp::PgSqlLease6Exchange::createBindForSend().

◆ subnet_id_

uint32_t isc::dhcp::PgSqlLeaseExchange::subnet_id_

protected

Definition at line 365 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::convertFromDatabase(), and isc::dhcp::PgSqlLease6Exchange::convertFromDatabase().

◆ subnet_id_str_

std::string isc::dhcp::PgSqlLeaseExchange::subnet_id_str_

protected

Definition at line 366 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::createBindForSend(), and isc::dhcp::PgSqlLease6Exchange::createBindForSend().

◆ user_context_

std::string isc::dhcp::PgSqlLeaseExchange::user_context_

protected

Definition at line 372 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::convertFromDatabase(), isc::dhcp::PgSqlLease6Exchange::convertFromDatabase(), isc::dhcp::PgSqlLease4Exchange::createBindForSend(), and isc::dhcp::PgSqlLease6Exchange::createBindForSend().

◆ valid_lifetime_

uint32_t isc::dhcp::PgSqlLeaseExchange::valid_lifetime_

protected

Definition at line 361 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::convertFromDatabase(), and isc::dhcp::PgSqlLease6Exchange::convertFromDatabase().

◆ valid_lifetime_str_

std::string isc::dhcp::PgSqlLeaseExchange::valid_lifetime_str_

protected

Definition at line 362 of file pgsql_lease_mgr.cc.

Referenced by isc::dhcp::PgSqlLease4Exchange::createBindForSend(), and isc::dhcp::PgSqlLease6Exchange::createBindForSend().

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

pgsql_lease_mgr.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PgSqlLeaseExchange()

◆ ~PgSqlLeaseExchange()

Member Data Documentation

◆ addr_str_

◆ cltt_

◆ expire_

◆ expire_str_

◆ fqdn_fwd_

◆ fqdn_rev_

◆ hostname_

◆ state_str_

◆ subnet_id_

◆ subnet_id_str_

◆ user_context_

◆ valid_lifetime_

◆ valid_lifetime_str_