isc::dhcp::MySqlLeaseMgr Class Reference

MySQL Lease Manager. More...

#include <mysql_lease_mgr.h>

Inheritance diagram for isc::dhcp::MySqlLeaseMgr:

Public Types
enum	StatementIndex {   DELETE_LEASE4, DELETE_LEASE4_STATE_EXPIRED, DELETE_LEASE6, DELETE_LEASE6_STATE_EXPIRED,   GET_LEASE4, GET_LEASE4_ADDR, GET_LEASE4_CLIENTID, GET_LEASE4_CLIENTID_SUBID,   GET_LEASE4_HWADDR, GET_LEASE4_HWADDR_SUBID, GET_LEASE4_PAGE, GET_LEASE4_SUBID,   GET_LEASE4_EXPIRE, GET_LEASE6, GET_LEASE6_ADDR, GET_LEASE6_DUID_IAID,   GET_LEASE6_DUID_IAID_SUBID, GET_LEASE6_PAGE, GET_LEASE6_SUBID, GET_LEASE6_DUID,   GET_LEASE6_EXPIRE, INSERT_LEASE4, INSERT_LEASE6, UPDATE_LEASE4,   UPDATE_LEASE6, ALL_LEASE4_STATS, SUBNET_LEASE4_STATS, SUBNET_RANGE_LEASE4_STATS,   ALL_LEASE6_STATS, SUBNET_LEASE6_STATS, SUBNET_RANGE_LEASE6_STATS, NUM_STATEMENTS }
	Statement Tags. More...

Public Member Functions
	MySqlLeaseMgr (const db::DatabaseConnection::ParameterMap &parameters)
	Constructor. More...
virtual	~MySqlLeaseMgr ()
	Destructor (closes database) More...
virtual bool	addLease (const Lease4Ptr &lease)
	Adds an IPv4 lease. More...
virtual bool	addLease (const Lease6Ptr &lease)
	Adds an IPv6 lease. More...
virtual void	commit ()
	Commit Transactions. More...
virtual uint64_t	deleteExpiredReclaimedLeases4 (const uint32_t secs)
	Deletes all expired-reclaimed DHCPv4 leases. More...
virtual uint64_t	deleteExpiredReclaimedLeases6 (const uint32_t secs)
	Deletes all expired-reclaimed DHCPv6 leases. More...
virtual bool	deleteLease (const isc::asiolink::IOAddress &addr)
	Deletes a lease. More...
virtual std::string	getDescription () const
	Returns description of the backend. More...
virtual void	getExpiredLeases4 (Lease4Collection &expired_leases, const size_t max_leases) const
	Returns a collection of expired DHCPv4 leases. More...
virtual void	getExpiredLeases6 (Lease6Collection &expired_leases, const size_t max_leases) const
	Returns a collection of expired DHCPv6 leases. More...
virtual Lease4Ptr	getLease4 (const ClientId &client_id, const HWAddr &hwaddr, SubnetID subnet_id) const
	Returns IPv4 lease for the specified client identifier, HW address and subnet identifier. More...
virtual Lease4Collection	getLease4 (const ClientId &clientid) const
	Returns existing IPv4 lease for specified client-id. More...
virtual Lease4Ptr	getLease4 (const ClientId &clientid, SubnetID subnet_id) const
	Returns existing IPv4 lease for specified client-id. More...
virtual Lease4Ptr	getLease4 (const isc::asiolink::IOAddress &addr) const
	Returns an IPv4 lease for specified IPv4 address. More...
virtual Lease4Collection	getLease4 (const isc::dhcp::HWAddr &hwaddr) const
	Returns existing IPv4 leases for specified hardware address. More...
virtual Lease4Ptr	getLease4 (const isc::dhcp::HWAddr &hwaddr, SubnetID subnet_id) const
	Returns existing IPv4 leases for specified hardware address and a subnet. More...
virtual Lease6Ptr	getLease6 (Lease::Type type, const isc::asiolink::IOAddress &addr) const
	Returns existing IPv6 lease for a given IPv6 address. More...
virtual Lease4Collection	getLeases4 () const
	Returns all IPv4 leases. More...
virtual Lease4Collection	getLeases4 (const asiolink::IOAddress &lower_bound_address, const LeasePageSize &page_size) const
	Returns range of IPv4 leases using paging. More...
virtual Lease4Collection	getLeases4 (SubnetID subnet_id) const
	Returns all IPv4 leases for the particular subnet identifier. More...
virtual Lease6Collection	getLeases6 () const
	Returns all IPv6 leases. More...
virtual Lease6Collection	getLeases6 (const asiolink::IOAddress &lower_bound_address, const LeasePageSize &page_size) const
	Returns range of IPv6 leases using paging. More...
virtual Lease6Collection	getLeases6 (const DUID &duid) const
	Returns all IPv6 leases for the DUID. More...
virtual Lease6Collection	getLeases6 (Lease::Type type, const DUID &duid, uint32_t iaid) const
	Returns existing IPv6 leases for a given DUID+IA combination. More...
virtual Lease6Collection	getLeases6 (Lease::Type type, const DUID &duid, uint32_t iaid, SubnetID subnet_id) const
	Returns existing IPv6 lease for a given DUID+IA combination. More...
virtual Lease6Collection	getLeases6 (SubnetID subnet_id) const
	Returns all IPv6 leases for the particular subnet identifier. More...
virtual std::string	getName () const
	Returns backend name. More...
virtual std::string	getType () const
	Return backend type. More...
virtual std::pair< uint32_t, uint32_t >	getVersion () const
	Returns backend version. More...
virtual void	rollback ()
	Rollback Transactions. More...
virtual LeaseStatsQueryPtr	startLeaseStatsQuery4 ()
	Creates and runs the IPv4 lease stats query. More...
virtual LeaseStatsQueryPtr	startLeaseStatsQuery6 ()
	Creates and runs the IPv6 lease stats query. More...
virtual LeaseStatsQueryPtr	startSubnetLeaseStatsQuery4 (const SubnetID &subnet_id)
	Creates and runs the IPv4 lease stats query for a single subnet. More...
virtual LeaseStatsQueryPtr	startSubnetLeaseStatsQuery6 (const SubnetID &subnet_id)
	Creates and runs the IPv6 lease stats query for a single subnet. More...
virtual LeaseStatsQueryPtr	startSubnetRangeLeaseStatsQuery4 (const SubnetID &first_subnet_id, const SubnetID &last_subnet_id)
	Creates and runs the IPv4 lease stats query for a single subnet. More...
virtual LeaseStatsQueryPtr	startSubnetRangeLeaseStatsQuery6 (const SubnetID &first_subnet_id, const SubnetID &last_subnet_id)
	Creates and runs the IPv6 lease stats query for a single subnet. More...
virtual void	updateLease4 (const Lease4Ptr &lease4)
	Updates IPv4 lease. More...
virtual void	updateLease6 (const Lease6Ptr &lease6)
	Updates IPv6 lease. More...
virtual size_t	wipeLeases4 (const SubnetID &subnet_id)
	Removes specified IPv4 leases. More...
virtual size_t	wipeLeases6 (const SubnetID &subnet_id)
	Removed specified IPv6 leases. More...
Public Member Functions inherited from isc::dhcp::LeaseMgr
	LeaseMgr ()
	Constructor. More...
virtual	~LeaseMgr ()
	Destructor. More...
Lease6Ptr	getLease6 (Lease::Type type, const DUID &duid, uint32_t iaid, SubnetID subnet_id) const
	returns zero or one IPv6 lease for a given duid+iaid+subnet_id More...
void	recountLeaseStats4 ()
	Recalculates per-subnet and global stats for IPv4 leases. More...
void	recountLeaseStats6 ()
	Recalculates per-subnet and global stats for IPv6 leases. More...

Static Public Member Functions
static std::string	getDBVersion ()
	Local version of getDBVersion() class method. More...
Static Public Member Functions inherited from isc::dhcp::LeaseMgr
static std::string	getDBVersion ()
	Class method to return extended version info This class method must be redeclared and redefined in derived classes. More...

Detailed Description

MySQL Lease Manager.

This class provides the isc::dhcp::LeaseMgr interface to the MySQL database. Use of this backend presupposes that a MySQL database is available and that the Kea schema has been created within it.

Definition at line 35 of file mysql_lease_mgr.h.

Member Enumeration Documentation

StatementIndex

enum isc::dhcp::MySqlLeaseMgr::StatementIndex

Statement Tags.

The contents of the enum are indexes into the list of SQL statements

Enumerator
DELETE_LEASE4
DELETE_LEASE4_STATE_EXPIRED
DELETE_LEASE6
DELETE_LEASE6_STATE_EXPIRED
GET_LEASE4
GET_LEASE4_ADDR
GET_LEASE4_CLIENTID
GET_LEASE4_CLIENTID_SUBID
GET_LEASE4_HWADDR
GET_LEASE4_HWADDR_SUBID
GET_LEASE4_PAGE
GET_LEASE4_SUBID
GET_LEASE4_EXPIRE
GET_LEASE6
GET_LEASE6_ADDR
GET_LEASE6_DUID_IAID
GET_LEASE6_DUID_IAID_SUBID
GET_LEASE6_PAGE
GET_LEASE6_SUBID
GET_LEASE6_DUID
GET_LEASE6_EXPIRE
INSERT_LEASE4
INSERT_LEASE6
UPDATE_LEASE4
UPDATE_LEASE6
ALL_LEASE4_STATS
SUBNET_LEASE4_STATS
SUBNET_RANGE_LEASE4_STATS
ALL_LEASE6_STATS
SUBNET_LEASE6_STATS
SUBNET_RANGE_LEASE6_STATS
NUM_STATEMENTS

Definition at line 571 of file mysql_lease_mgr.h.

Constructor & Destructor Documentation

MySqlLeaseMgr()

isc::dhcp::MySqlLeaseMgr::MySqlLeaseMgr

(

const db::DatabaseConnection::ParameterMap &

parameters

)

Constructor.

Uses the following keywords in the parameters passed to it to connect to the database:

• name - Name of the database to which to connect (mandatory)
• host - Host to which to connect (optional, defaults to "localhost")
• user - Username under which to connect (optional)
• password - Password for "user" on the database (optional)

If the database is successfully opened, the version number in the schema_version table will be checked against hard-coded value in the implementation file.

Finally, all the SQL commands are pre-compiled.

Parameters

parameters

A data structure relating keywords and values concerned with the database.

Exceptions

isc::dhcp::NoDatabaseName	Mandatory database name not given
isc::db::DbOpenError	Error opening the database or the schema version is incorrect.
isc::db::DbOperationError	An operation on the open database has failed.

Definition at line 1667 of file mysql_lease_mgr.cc.

References getVersion(), isc_throw, isc::db::MySqlConnection::mysql_, isc::db::MYSQL_SCHEMA_VERSION_MAJOR, isc::db::MYSQL_SCHEMA_VERSION_MINOR, isc::db::MySqlConnection::openDatabase(), isc::db::MySqlConnection::prepareStatements(), and isc::dhcp::tagged_statements.

Here is the call graph for this function:

~MySqlLeaseMgr()

isc::dhcp::MySqlLeaseMgr::~MySqlLeaseMgr ( )

virtual

Destructor (closes database)

Definition at line 1704 of file mysql_lease_mgr.cc.

Member Function Documentation

addLease() [1/2]

bool isc::dhcp::MySqlLeaseMgr::addLease ( const Lease4Ptr &  lease )

virtual

Adds an IPv4 lease.

Parameters

lease

lease to be added

Returns

true if the lease was added, false if not (because a lease with the same address was already there).

Exceptions

isc::db::DbOperationError

An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1748 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, INSERT_LEASE4, and LOG_DEBUG.

addLease() [2/2]

bool isc::dhcp::MySqlLeaseMgr::addLease ( const Lease6Ptr &  lease )

virtual

Adds an IPv6 lease.

Parameters

lease

lease to be added

Returns

true if the lease was added, false if not (because a lease with the same address was already there).

Exceptions

isc::db::DbOperationError

An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1760 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, INSERT_LEASE6, and LOG_DEBUG.

commit()

void isc::dhcp::MySqlLeaseMgr::commit ( )

virtual

Commit Transactions.

Commits all pending database operations. On databases that don't support transactions, this is a no-op.

Exceptions

DbOperationError

If the commit failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2762 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc_throw, LOG_DEBUG, and isc::db::MySqlConnection::mysql_.

deleteExpiredReclaimedLeases4()

uint64_t isc::dhcp::MySqlLeaseMgr::deleteExpiredReclaimedLeases4 ( const uint32_t  secs )

virtual

Deletes all expired-reclaimed DHCPv4 leases.

Parameters

secs	Number of seconds since expiration of leases before they can be removed. Leases which have expired later than this time will not be deleted.

Returns

Number of leases deleted.

Implements isc::dhcp::LeaseMgr.

Definition at line 2569 of file mysql_lease_mgr.cc.

References DELETE_LEASE4_STATE_EXPIRED, isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, and LOG_DEBUG.

deleteExpiredReclaimedLeases6()

uint64_t isc::dhcp::MySqlLeaseMgr::deleteExpiredReclaimedLeases6 ( const uint32_t  secs )

virtual

Deletes all expired-reclaimed DHCPv6 leases.

Parameters

secs	Number of seconds since expiration of leases before they can be removed. Leases which have expired later than this time will not be deleted.

Returns

Number of leases deleted.

Implements isc::dhcp::LeaseMgr.

Definition at line 2577 of file mysql_lease_mgr.cc.

References DELETE_LEASE6_STATE_EXPIRED, isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, and LOG_DEBUG.

deleteLease()

bool isc::dhcp::MySqlLeaseMgr::deleteLease ( const isc::asiolink::IOAddress &  addr )

virtual

Deletes a lease.

Parameters

addr	Address of the lease to be deleted. This can be an IPv4 address or an IPv6 address.

Returns

true if deletion was successful, false if no such lease exists

Exceptions

isc::db::DbOperationError

An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2536 of file mysql_lease_mgr.cc.

References DELETE_LEASE4, DELETE_LEASE6, isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc::asiolink::IOAddress::isV4(), LOG_DEBUG, isc::db::MLM_TRUE, isc::asiolink::IOAddress::toText(), and isc::asiolink::IOAddress::toUint32().

Here is the call graph for this function:

getDBVersion()

std::string isc::dhcp::MySqlLeaseMgr::getDBVersion ( )

static

Local version of getDBVersion() class method.

Definition at line 1710 of file mysql_lease_mgr.cc.

References isc::db::MYSQL_SCHEMA_VERSION_MAJOR, and isc::db::MYSQL_SCHEMA_VERSION_MINOR.

Referenced by isc::dhcp::Dhcpv6Srv::getVersion(), and isc::dhcp::Dhcpv4Srv::getVersion().

getDescription()

std::string isc::dhcp::MySqlLeaseMgr::getDescription ( ) const

virtual

Returns description of the backend.

This description may be multiline text that describes the backend.

Returns

Description of the backend.

Implements isc::dhcp::LeaseMgr.

Definition at line 2697 of file mysql_lease_mgr.cc.

getExpiredLeases4()

void isc::dhcp::MySqlLeaseMgr::getExpiredLeases4 ( Lease4Collection &  expired_leases, const size_t  max_leases  ) const

virtual

Returns a collection of expired DHCPv4 leases.

This method returns at most max_leases expired leases. The leases returned haven't been reclaimed, i.e. the database query must exclude reclaimed leases from the results returned.

Parameters

[out]	expired_leases	A container to which expired leases returned by the database backend are added.
	max_leases	A maximum number of leases to be returned. If this value is set to 0, all expired (but not reclaimed) leases are returned.

Implements isc::dhcp::LeaseMgr.

Definition at line 2380 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4_EXPIRE, and LOG_DEBUG.

getExpiredLeases6()

void isc::dhcp::MySqlLeaseMgr::getExpiredLeases6 ( Lease6Collection &  expired_leases, const size_t  max_leases  ) const

virtual

Returns a collection of expired DHCPv6 leases.

This method returns at most max_leases expired leases. The leases returned haven't been reclaimed, i.e. the database query must exclude reclaimed leases from the results returned.

Parameters

[out]	expired_leases	A container to which expired leases returned by the database backend are added.
	max_leases	A maximum number of leases to be returned. If this value is set to 0, all expired (but not reclaimed) leases are returned.

Implements isc::dhcp::LeaseMgr.

Definition at line 2388 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE6_EXPIRE, and LOG_DEBUG.

getLease4() [1/6]

Lease4Ptr isc::dhcp::MySqlLeaseMgr::getLease4 ( const ClientId &  client_id, const HWAddr &  hwaddr, SubnetID  subnet_id  ) const

virtual

Returns IPv4 lease for the specified client identifier, HW address and subnet identifier.

Parameters

client_id	A client identifier.
hwaddr	Hardware address.
subnet_id	A subnet identifier.

Returns

A pointer to the lease or NULL if the lease is not found.

Exceptions

isc::NotImplemented

On every call as this function is currently not implemented for the MySQL backend.

This function is currently not implemented because allocation engine searches for the lease using HW address or client identifier. It never uses both parameters in the same time. We need to consider if this function is needed at all.

Implements isc::dhcp::LeaseMgr.

Definition at line 2030 of file mysql_lease_mgr.cc.

References isc_throw.

getLease4() [2/6]

Lease4Collection isc::dhcp::MySqlLeaseMgr::getLease4 ( const ClientId &  clientid ) const

virtual

Returns existing IPv4 lease for specified client-id.

Although in the usual case there will be only one lease, for mobile clients or clients with multiple static/fixed/reserved leases there can be more than one. Thus return type is a container, not a single pointer.

Parameters

clientid

client identifier

Returns

lease collection

Exceptions

isc::dhcp::DataTruncation	Data was truncated on retrieval to fit into the space allocated for the result. This indicates a programming error.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1999 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4_CLIENTID, isc::dhcp::ClientId::getClientId(), LOG_DEBUG, and isc::dhcp::ClientId::toText().

Here is the call graph for this function:

getLease4() [3/6]

Lease4Ptr isc::dhcp::MySqlLeaseMgr::getLease4 ( const ClientId &  clientid, SubnetID  subnet_id  ) const

virtual

Returns existing IPv4 lease for specified client-id.

There can be at most one lease for a given HW address in a single pool, so this method with either return a single lease or NULL.

Parameters

clientid	client identifier
subnet_id	identifier of the subnet that lease must belong to

Returns

a pointer to the lease (or NULL if a lease is not found)

Exceptions

isc::dhcp::DataTruncation	Data was truncated on retrieval to fit into the space allocated for the result. This indicates a programming error.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2040 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4_CLIENTID_SUBID, isc::dhcp::ClientId::getClientId(), LOG_DEBUG, isc::db::MLM_TRUE, and isc::dhcp::ClientId::toText().

Here is the call graph for this function:

getLease4() [4/6]

Lease4Ptr isc::dhcp::MySqlLeaseMgr::getLease4 ( const isc::asiolink::IOAddress &  addr ) const

virtual

Returns an IPv4 lease for specified IPv4 address.

This method return a lease that is associated with a given address. For other query types (by hardware addr, by Client ID) there can be several leases in different subnets (e.g. for mobile clients that got address in different subnets). However, for a single address there can be only one lease, so this method returns a pointer to a single lease, not a container of leases.

Parameters

addr	address of the searched lease

Returns

smart pointer to the lease (or NULL if a lease is not found)

Exceptions

isc::dhcp::DataTruncation	Data was truncated on retrieval to fit into the space allocated for the result. This indicates a programming error.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1901 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4_ADDR, LOG_DEBUG, isc::db::MLM_TRUE, isc::asiolink::IOAddress::toText(), and isc::asiolink::IOAddress::toUint32().

Here is the call graph for this function:

getLease4() [5/6]

Lease4Collection isc::dhcp::MySqlLeaseMgr::getLease4 ( const isc::dhcp::HWAddr &  hwaddr ) const

virtual

Returns existing IPv4 leases for specified hardware address.

Although in the usual case there will be only one lease, for mobile clients or clients with multiple static/fixed/reserved leases there can be more than one. Thus return type is a container, not a single pointer.

Parameters

hwaddr

hardware address of the client

Returns

lease collection

Exceptions

isc::dhcp::DataTruncation	Data was truncated on retrieval to fit into the space allocated for the result. This indicates a programming error.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1922 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4_HWADDR, isc::dhcp::HWAddr::hwaddr_, LOG_DEBUG, and isc::dhcp::HWAddr::toText().

Here is the call graph for this function:

getLease4() [6/6]

Lease4Ptr isc::dhcp::MySqlLeaseMgr::getLease4 ( const isc::dhcp::HWAddr &  hwaddr, SubnetID  subnet_id  ) const

virtual

Returns existing IPv4 leases for specified hardware address and a subnet.

There can be at most one lease for a given HW address in a single pool, so this method with either return a single lease or NULL.

Parameters

hwaddr	hardware address of the client
subnet_id	identifier of the subnet that lease must belong to

Returns

a pointer to the lease (or NULL if a lease is not found)

Exceptions

isc::dhcp::DataTruncation	Data was truncated on retrieval to fit into the space allocated for the result. This indicates a programming error.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 1958 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4_HWADDR_SUBID, isc::dhcp::HWAddr::hwaddr_, LOG_DEBUG, isc::db::MLM_TRUE, and isc::dhcp::HWAddr::toText().

Here is the call graph for this function:

getLease6()

Lease6Ptr isc::dhcp::MySqlLeaseMgr::getLease6 ( Lease::Type  type, const isc::asiolink::IOAddress &  addr  ) const

virtual

Returns existing IPv6 lease for a given IPv6 address.

For a given address, we assume that there will be only one lease. The assumption here is that there will not be site or link-local addresses used, so there is no way of having address duplication.

Parameters

type	specifies lease type: (NA, TA or PD)
addr	address of the searched lease

Returns

smart pointer to the lease (or NULL if a lease is not found)

Exceptions

isc::BadValue	record retrieved from database had an invalid lease type field.
isc::dhcp::DataTruncation	Data was truncated on retrieval to fit into the space allocated for the result. This indicates a programming error.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2144 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE6_ADDR, LOG_DEBUG, isc::db::MLM_TRUE, and isc::asiolink::IOAddress::toText().

Here is the call graph for this function:

getLeases4() [1/3]

Lease4Collection isc::dhcp::MySqlLeaseMgr::getLeases4 ( ) const

virtual

Returns all IPv4 leases.

Returns

Lease collection (may be empty if no IPv4 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 2097 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4, and LOG_DEBUG.

getLeases4() [2/3]

Lease4Collection isc::dhcp::MySqlLeaseMgr::getLeases4 ( const asiolink::IOAddress &  lower_bound_address, const LeasePageSize &  page_size  ) const

virtual

Returns range of IPv4 leases using paging.

This method implements paged browsing of the lease database. The first parameter specifies a page size. The second parameter is optional and specifies the starting address of the range. This address is excluded from the returned range. The IPv4 zero address (default) denotes that the first page should be returned. There is no guarantee about the order of returned leases.

The typical usage of this method is as follows:

• Get the first page of leases by specifying IPv4 zero address as the beginning of the range.
• Last address of the returned range should be used as a starting address for the next page in the subsequent call.
• If the number of leases returned is lower than the page size, it indicates that the last page has been retrieved.
• If there are no leases returned it indicates that the previous page was the last page.

Parameters

lower_bound_address	IPv4 address used as lower bound for the returned range.
page_size	maximum size of the page returned.

Returns

Lease collection (may be empty if no IPv4 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 2107 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4_PAGE, isc_throw, isc::asiolink::IOAddress::isV4(), LOG_DEBUG, isc::db::MLM_TRUE, isc::dhcp::LeasePageSize::page_size_, isc::asiolink::IOAddress::toText(), and isc::asiolink::IOAddress::toUint32().

Here is the call graph for this function:

getLeases4() [3/3]

Lease4Collection isc::dhcp::MySqlLeaseMgr::getLeases4 ( SubnetID  subnet_id ) const

virtual

Returns all IPv4 leases for the particular subnet identifier.

Parameters

subnet_id

subnet identifier.

Returns

Lease collection (may be empty if no IPv4 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 2076 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE4_SUBID, LOG_DEBUG, and isc::db::MLM_TRUE.

getLeases6() [1/6]

Lease6Collection isc::dhcp::MySqlLeaseMgr::getLeases6 ( ) const

virtual

Returns all IPv6 leases.

Returns

Lease collection (may be empty if no IPv6 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 2299 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE6, and LOG_DEBUG.

getLeases6() [2/6]

Lease6Collection isc::dhcp::MySqlLeaseMgr::getLeases6 ( const asiolink::IOAddress &  lower_bound_address, const LeasePageSize &  page_size  ) const

virtual

Returns range of IPv6 leases using paging.

This method implements paged browsing of the lease database. The first parameter specifies a page size. The second parameter is optional and specifies the starting address of the range. This address is excluded from the returned range. The IPv6 zero address (default) denotes that the first page should be returned. There is no guarantee about the order of returned leases.

The typical usage of this method is as follows:

• Get the first page of leases by specifying IPv6 zero address as the beginning of the range.
• Last address of the returned range should be used as a starting address for the next page in the subsequent call.
• If the number of leases returned is lower than the page size, it indicates that the last page has been retrieved.
• If there are no leases returned it indicates that the previous page was the last page.

Parameters

lower_bound_address	IPv6 address used as lower bound for the returned range.
page_size	maximum size of the page returned.

Returns

Lease collection (may be empty if no IPv6 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 2334 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE6_PAGE, isc_throw, isc::asiolink::IOAddress::isV6(), isc::asiolink::IOAddress::isV6Zero(), LOG_DEBUG, isc::db::MLM_TRUE, isc::dhcp::LeasePageSize::page_size_, and isc::asiolink::IOAddress::toText().

Here is the call graph for this function:

getLeases6() [3/6]

Lease6Collection isc::dhcp::MySqlLeaseMgr::getLeases6 ( const DUID &  duid ) const

virtual

Returns all IPv6 leases for the DUID.

Todo:

: implement an optimised of the query using index.

Returns

Lease collection (may be empty if no IPv6 lease found) for the DUID.

Implements isc::dhcp::LeaseMgr.

Definition at line 2309 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE6_DUID, isc::dhcp::DUID::getDuid(), LOG_DEBUG, and isc::dhcp::DUID::toText().

Here is the call graph for this function:

getLeases6() [4/6]

Lease6Collection isc::dhcp::MySqlLeaseMgr::getLeases6 ( Lease::Type  type, const DUID &  duid, uint32_t  iaid  ) const

virtual

Returns existing IPv6 leases for a given DUID+IA combination.

Although in the usual case there will be only one lease, for mobile clients or clients with multiple static/fixed/reserved leases there can be more than one. Thus return type is a container, not a single pointer.

Parameters

type	specifies lease type: (NA, TA or PD)
duid	client DUID
iaid	IA identifier

Returns

smart pointer to the lease (or NULL if a lease is not found)

Exceptions

isc::BadValue	record retrieved from database had an invalid lease type field.
isc::dhcp::DataTruncation	Data was truncated on retrieval to fit into the space allocated for the result. This indicates a programming error.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2176 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE6_DUID_IAID, isc::dhcp::DUID::getDuid(), LOG_DEBUG, isc::db::MLM_TRUE, and isc::dhcp::DUID::toText().

Here is the call graph for this function:

getLeases6() [5/6]

Lease6Collection isc::dhcp::MySqlLeaseMgr::getLeases6 ( Lease::Type  type, const DUID &  duid, uint32_t  iaid, SubnetID  subnet_id  ) const

virtual

Returns existing IPv6 lease for a given DUID+IA combination.

Parameters

type	specifies lease type: (NA, TA or PD)
duid	client DUID
iaid	IA identifier
subnet_id	subnet id of the subnet the lease belongs to

Returns

lease collection (may be empty if no lease is found)

Exceptions

isc::BadValue	record retrieved from database had an invalid lease type field.
isc::dhcp::DataTruncation	Data was truncated on retrieval to fit into the space allocated for the result. This indicates a programming error.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2233 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE6_DUID_IAID_SUBID, isc::dhcp::DUID::getDuid(), LOG_DEBUG, isc::db::MLM_TRUE, and isc::dhcp::DUID::toText().

Here is the call graph for this function:

getLeases6() [6/6]

Lease6Collection isc::dhcp::MySqlLeaseMgr::getLeases6 ( SubnetID  subnet_id ) const

virtual

Returns all IPv6 leases for the particular subnet identifier.

Parameters

subnet_id

subnet identifier.

Returns

Lease collection (may be empty if no IPv6 lease found).

Implements isc::dhcp::LeaseMgr.

Definition at line 2278 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, GET_LEASE6_SUBID, LOG_DEBUG, and isc::db::MLM_TRUE.

getName()

std::string isc::dhcp::MySqlLeaseMgr::getName ( ) const

virtual

Returns backend name.

Each backend have specific name, e.g. "mysql" or "sqlite".

Returns

Name of the backend.

Implements isc::dhcp::LeaseMgr.

Definition at line 2686 of file mysql_lease_mgr.cc.

References isc::db::DatabaseConnection::getParameter().

Here is the call graph for this function:

getType()

virtual std::string isc::dhcp::MySqlLeaseMgr::getType ( ) const

inlinevirtual

Return backend type.

Returns the type of the backend (e.g. "mysql", "memfile" etc.)

Returns

Type of the backend.

Implements isc::dhcp::LeaseMgr.

Definition at line 520 of file mysql_lease_mgr.h.

getVersion()

std::pair< uint32_t, uint32_t > isc::dhcp::MySqlLeaseMgr::getVersion ( ) const

virtual

Returns backend version.

The method is called by the constructor after opening the database but prior to preparing SQL statements, to verify that the schema version is correct. Thus it must not rely on a pre-prepared statement or formal statement execution error checking.

Returns

Version number as a pair of unsigned integers. "first" is the major version number, "second" the minor number.

Exceptions

isc::db::DbOperationError

An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2702 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc_throw, LOG_DEBUG, and isc::db::MySqlConnection::mysql_.

Referenced by MySqlLeaseMgr().

rollback()

void isc::dhcp::MySqlLeaseMgr::rollback ( )

virtual

Rollback Transactions.

Rolls back all pending database operations. On databases that don't support transactions, this is a no-op.

Exceptions

DbOperationError

If the rollback failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2770 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, isc_throw, LOG_DEBUG, and isc::db::MySqlConnection::mysql_.

startLeaseStatsQuery4()

LeaseStatsQueryPtr isc::dhcp::MySqlLeaseMgr::startLeaseStatsQuery4 ( )

virtual

Creates and runs the IPv4 lease stats query.

It creates an instance of a MySqlLeaseStatsQuery4 and then invokes its start method, which fetches its statistical data result set by executing the ALL_LEASE_STATS4 query. The query object is then returned.

Returns

The populated query as a pointer to an LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2614 of file mysql_lease_mgr.cc.

References ALL_LEASE4_STATS.

startLeaseStatsQuery6()

LeaseStatsQueryPtr isc::dhcp::MySqlLeaseMgr::startLeaseStatsQuery6 ( )

virtual

Creates and runs the IPv6 lease stats query.

It creates an instance of a MySqlLeaseStatsQuery6 and then invokes its start method, which fetches its statistical data result set by executing the ALL_LEASE_STATS6 query. The query object is then returned.

Returns

The populated query as a pointer to an LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2644 of file mysql_lease_mgr.cc.

References ALL_LEASE6_STATS.

startSubnetLeaseStatsQuery4()

LeaseStatsQueryPtr isc::dhcp::MySqlLeaseMgr::startSubnetLeaseStatsQuery4 ( const SubnetID &  subnet_id )

virtual

Creates and runs the IPv4 lease stats query for a single subnet.

It creates an instance of a MySqlLeaseStatsQuery4 for a single subnet query and then invokes its start method in which the query constructs its statistical data result set. The query object is then returned.

Parameters

subnet_id

id of the subnet for which stats are desired

Returns

A populated LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2623 of file mysql_lease_mgr.cc.

References SUBNET_LEASE4_STATS.

startSubnetLeaseStatsQuery6()

LeaseStatsQueryPtr isc::dhcp::MySqlLeaseMgr::startSubnetLeaseStatsQuery6 ( const SubnetID &  subnet_id )

virtual

Creates and runs the IPv6 lease stats query for a single subnet.

It creates an instance of a MySqlLeaseStatsQuery6 for a single subnet query and then invokes its start method in which the query constructs its statistical data result set. The query object is then returned.

Parameters

subnet_id

id of the subnet for which stats are desired

Returns

A populated LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2653 of file mysql_lease_mgr.cc.

References SUBNET_LEASE6_STATS.

startSubnetRangeLeaseStatsQuery4()

LeaseStatsQueryPtr isc::dhcp::MySqlLeaseMgr::startSubnetRangeLeaseStatsQuery4 ( const SubnetID &  first_subnet_id, const SubnetID &  last_subnet_id  )

virtual

Creates and runs the IPv4 lease stats query for a single subnet.

It creates an instance of a MySqlLeaseStatsQuery4 for a subnet range query and then invokes its start method in which the query constructs its statistical data result set. The query object is then returned.

Parameters

first_subnet_id	first subnet in the range of subnets
last_subnet_id	last subnet in the range of subnets

Returns

A populated LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2633 of file mysql_lease_mgr.cc.

References SUBNET_RANGE_LEASE4_STATS.

startSubnetRangeLeaseStatsQuery6()

LeaseStatsQueryPtr isc::dhcp::MySqlLeaseMgr::startSubnetRangeLeaseStatsQuery6 ( const SubnetID &  first_subnet_id, const SubnetID &  last_subnet_id  )

virtual

Creates and runs the IPv6 lease stats query for a single subnet.

It creates an instance of a MySqlLeaseStatsQuery6 for a subnet range query and then invokes its start method in which the query constructs its statistical data result set. The query object is then returned.

Parameters

first_subnet_id	first subnet in the range of subnets
last_subnet_id	last subnet in the range of subnets

Returns

A populated LeaseStatsQuery

Reimplemented from isc::dhcp::LeaseMgr.

Definition at line 2663 of file mysql_lease_mgr.cc.

References SUBNET_RANGE_LEASE6_STATS.

updateLease4()

void isc::dhcp::MySqlLeaseMgr::updateLease4 ( const Lease4Ptr &  lease4 )

virtual

Updates IPv4 lease.

Updates the record of the lease in the database (as identified by the address) with the data in the passed lease object.

Parameters

lease4

The lease to be updated.

Exceptions

isc::dhcp::NoSuchLease	Attempt to update a lease that did not exist.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2461 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, LOG_DEBUG, isc::db::MLM_TRUE, and UPDATE_LEASE4.

updateLease6()

void isc::dhcp::MySqlLeaseMgr::updateLease6 ( const Lease6Ptr &  lease6 )

virtual

Updates IPv6 lease.

Updates the record of the lease in the database (as identified by the address) with the data in the passed lease object.

Parameters

lease6

The lease to be updated.

Exceptions

isc::dhcp::NoSuchLease	Attempt to update a lease that did not exist.
isc::db::DbOperationError	An operation on the open database has failed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2485 of file mysql_lease_mgr.cc.

References isc::dhcp::DHCPSRV_DBG_TRACE_DETAIL, isc::dhcp::dhcpsrv_logger, LOG_DEBUG, and UPDATE_LEASE6.

wipeLeases4()

size_t isc::dhcp::MySqlLeaseMgr::wipeLeases4 ( const SubnetID &  subnet_id )

virtual

Removes specified IPv4 leases.

This rather dangerous method is able to remove all leases from specified subnet.

Todo:

: Not implemented yet.

Parameters

subnet_id

identifier of the subnet

Returns

number of leases removed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2674 of file mysql_lease_mgr.cc.

References isc_throw.

wipeLeases6()

size_t isc::dhcp::MySqlLeaseMgr::wipeLeases6 ( const SubnetID &  subnet_id )

virtual

Removed specified IPv6 leases.

This rather dangerous method is able to remove all leases from specified subnet.

Todo:

: Not implemented yet.

Parameters

subnet_id

identifier of the subnet

Returns

number of leases removed.

Implements isc::dhcp::LeaseMgr.

Definition at line 2679 of file mysql_lease_mgr.cc.

References isc_throw.

---

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

• mysql_lease_mgr.h
• mysql_lease_mgr.cc