OSB_DB::Ip4AddressGw Class Reference

List of all members.

---

Detailed Description

Interface to table IP4_ADDRESS.

Definition at line 69 of file ipaddress-gw.h.

Public Member Functions

• void fetch (const Session &session, Ip4List &dest, const NwOid &nwId, bool availOnly)

  Read IP4 address resources from database.
  

• void fetch (const Session &session, OSB_LIB::AssignableIp4s &dest)

  Read assignable IP4 from the database.
  

Private Types

• typedef OSB_LIB::ResourceList<
  OSB_LIB::Ip4Address > Ip4List

  Short-cut for a list of IP4 address resources.
  

• typedef OSB_LIB::Id< OSB_LIB::Network > NwOid

  Short-cut for a network id.
  

Private Member Functions

• bool read (const Session &session, OSB_LIB::Ip4Address &ip4) const

  Read an Ip4 address resource by its id.
  

• bool insert (const Session &session, const OSB_LIB::Ip4Address &ip4) const

  Insert an Ip4 address resource into the database.
  

• bool update (const Session &session, const OSB_LIB::Ip4Address &ip4) const

  Update an Ip4 address resource in the database.
  

• bool remove (const Session &session, const OSB_LIB::Ip4Address &ip4) const

  Delete an Ip4 address resource from the database.
  

Friends

• class OSB_LIB::Ip4Address

  Allow Ip4Address to calls its supporting functions.
  

• class OSB_DB::IpGroupGw

  Allow IpGroupGw to fetch(...).
  

---

Member Typedef Documentation

typedef OSB_LIB::ResourceList<OSB_LIB::Ip4Address> OSB_DB::Ip4AddressGw::Ip4List [private]

Short-cut for a list of IP4 address resources.

Definition at line 75 of file ipaddress-gw.h.

typedef OSB_LIB::Id<OSB_LIB::Network> OSB_DB::Ip4AddressGw::NwOid [private]

Short-cut for a network id.

Definition at line 77 of file ipaddress-gw.h.

---

Member Function Documentation

void OSB_DB::Ip4AddressGw::fetch	(	const Session &	session,
		OSB_LIB::AssignableIp4s &	dest
	)

Read assignable IP4 from the database.

Parameters:

	session	Database session to use.
	dest	Assignable IP4 list to populate.

Exceptions:

OsbException

in case of database error.

Reads the assignable IP4s from the view ASSIGNBABLE_IP4 and populate the list accordingly.

void OSB_DB::Ip4AddressGw::fetch	(	const Session &	session,
		Ip4List &	dest,
		const NwOid &	nwId,
		bool	availOnly
	)

Read IP4 address resources from database.

Parameters:

	session	Database session to use.
	dest	IP4 address resource list to populate.
	nwId	Id of the network id for which to read the IP4 address resources.
	availOnly	Flag if only available IP4 address resources should be read.

Exceptions:

OsbException

in case of database error.

Reads the id's of the matching IP4 address resources, creates an IP4 address resource object, lets this object read itself from the database and finally calls dest.replace that adds or replaces the IP4 address resource in the destination list.

bool OSB_DB::Ip4AddressGw::insert	(	const Session &	session,
		const OSB_LIB::Ip4Address &	ip4
	)			const [private]

Insert an Ip4 address resource into the database.

bool OSB_DB::Ip4AddressGw::read	(	const Session &	session,
		OSB_LIB::Ip4Address &	ip4
	)			const [private]

Read an Ip4 address resource by its id.

bool OSB_DB::Ip4AddressGw::remove	(	const Session &	session,
		const OSB_LIB::Ip4Address &	ip4
	)			const [private]

Delete an Ip4 address resource from the database.

bool OSB_DB::Ip4AddressGw::update	(	const Session &	session,
		const OSB_LIB::Ip4Address &	ip4
	)			const [private]

Update an Ip4 address resource in the database.

---

Friends And Related Function Documentation

friend class OSB_DB::IpGroupGw [friend]

Allow IpGroupGw to fetch(...).

Definition at line 73 of file ipaddress-gw.h.

friend class OSB_LIB::Ip4Address [friend]

Allow Ip4Address to calls its supporting functions.

Definition at line 71 of file ipaddress-gw.h.

---

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

• ipaddress-gw.h

---