OSB_DB::IpGroupGw Class Reference

List of all members.

---

Detailed Description

Interface to table IP_GROUP.

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

Public Member Functions

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

  Read IP group resources from database.
  

Private Types

• typedef OSB_LIB::ResourceList<
  OSB_LIB::IpGroup > IpGroupList

  Short-cut for a list of IP group 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::IpGroup &ipg) const

  Read an IP group resource by its id.
  

• bool insert (const Session &session, const OSB_LIB::IpGroup &ipg) const

  Insert an IP group resource into the database.
  

• bool update (const Session &session, const OSB_LIB::IpGroup &ipg) const

  Update an IP group resource in the database.
  

• bool remove (const Session &session, const OSB_LIB::IpGroup &ipg) const

  Delete an IP group resource from the database.
  

• std::pair< bool, bool > getCurIp4Assignments (const Session &session, const OSB_LIB::Ip4Address::Oid &ip4Id) const

  Determine if an IP4 address is currently assigned.
  

• bool insIp4 (const Session &session, const OSB_LIB::IpGroup::Oid &ipgId, const OSB_LIB::IpGroup::AssignedIp4 &assignedIp4) const

  Assign an IP4 to an IP group.
  

• bool updIp4 (const Session &session, const OSB_LIB::IpGroup::Oid &ipgId, const OSB_LIB::Ip4Address::Oid &ip4Id, OSB_LIB::IpGroup::Direction dir) const

  Set the deassign date of an IP4 to an IP group.
  

Friends

• class OSB_LIB::IpGroup

  Allow IP group resource to calls its supporting functions.
  

---

Member Typedef Documentation

typedef OSB_LIB::ResourceList<OSB_LIB::IpGroup> OSB_DB::IpGroupGw::IpGroupList [private]

Short-cut for a list of IP group resources.

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

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

Short-cut for a network id.

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

---

Member Function Documentation

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

Read IP group resources from database.

Parameters:

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

Exceptions:

OsbException

in case of database error.

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

std::pair<bool, bool> OSB_DB::IpGroupGw::getCurIp4Assignments	(	const Session &	session,
		const OSB_LIB::Ip4Address::Oid &	ip4Id
	)			const [private]

Determine if an IP4 address is currently assigned.

Parameters:

	session	Database session to use.
	ip4Id	IP4 address to check.

Returns:

A pair of boolean:

• the 1st part is true if the in-direction of the IP4 address is currently assigned,
• the 2nd part is true if the out-direction of the IP4 address is currently assigned.

bool OSB_DB::IpGroupGw::insert	(	const Session &	session,
		const OSB_LIB::IpGroup &	ipg
	)			const [private]

Insert an IP group resource into the database.

bool OSB_DB::IpGroupGw::insIp4	(	const Session &	session,
		const OSB_LIB::IpGroup::Oid &	ipgId,
		const OSB_LIB::IpGroup::AssignedIp4 &	assignedIp4
	)			const [private]

Assign an IP4 to an IP group.

Parameters:

	session	Database session to use.
	ipgId	IP group id.
	assignedIp4	IP4 to be assigned.

Exceptions:

OsbException

if the IP4 is already been assigned to an IP group.

bool OSB_DB::IpGroupGw::read	(	const Session &	session,
		OSB_LIB::IpGroup &	ipg
	)			const [private]

Read an IP group resource by its id.

bool OSB_DB::IpGroupGw::remove	(	const Session &	session,
		const OSB_LIB::IpGroup &	ipg
	)			const [private]

Delete an IP group resource from the database.

bool OSB_DB::IpGroupGw::update	(	const Session &	session,
		const OSB_LIB::IpGroup &	ipg
	)			const [private]

Update an IP group resource in the database.

bool OSB_DB::IpGroupGw::updIp4	(	const Session &	session,
		const OSB_LIB::IpGroup::Oid &	ipgId,
		const OSB_LIB::Ip4Address::Oid &	ip4Id,
		OSB_LIB::IpGroup::Direction	dir
	)			const [private]

Set the deassign date of an IP4 to an IP group.

Parameters:

	session	Database session to use.
	ipgId	IP group id.
	ip4Id	IP4 id.
	dir	Direction of the assignment.

Exceptions:

OsbException

if the IP4 is not assigned to the IP group.

---

Friends And Related Function Documentation

friend class OSB_LIB::IpGroup [friend]

Allow IP group resource to calls its supporting functions.

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

---

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

• ipaddress-gw.h

---