OSB_LIB::ResourceLists Class Reference

Collaboration diagram for OSB_LIB::ResourceLists:

[legend]List of all members.

---

Detailed Description

Container for resources.

Definition at line 327 of file resourcelists.h.

Access number resources:

• bool fetchAn (const OSB_DB::Session &session, bool availOnly=false, const Id< Network > &nwId=Id< Network >())

  Read access number resource into internal list.
  

• static bool fetchAn (const OSB_DB::Session &session, AnList &dest, bool availOnly=false, const Id< Network > &nwId=Id< Network >())

  Read access number resources from the database.
  

E.164 resources:

• bool fetchE164 (const OSB_DB::Session &session, Resource::Status status, const std::string &pattern, size_t maxAdd)

  Read E.164 resources from the database.
  

• static bool fetchE164 (const OSB_DB::Session &session, E164List &dest, Resource::Status status, const std::string &pattern, size_t maxAdd)

  Read E.164 resources from the database.
  

IP4 address resources:

• bool fetchIp4 (const OSB_DB::Session &session, bool availOnly=false, const Id< Network > &nwId=Id< Network >())

  Read IP4 address resource into internal list.
  

• void getAssignableIp4s (const OSB_DB::Session &session, AssignableIp4s &dest)

  Get assignable IP4 addresses that can be assigned to the IP group.
  

• static bool fetchIp4 (const OSB_DB::Session &session, Ip4List &dest, bool availOnly=false, const Id< Network > &nwId=Id< Network >())

  Read IP4 address resources from the database.
  

IP group resources:

• bool fetchIpg (const OSB_DB::Session &session, bool availOnly=false, const Id< Network > &nwId=Id< Network >())

  Read IP group resource into internal list.
  

• static bool fetchIpg (const OSB_DB::Session &session, IpGroupList &dest, bool availOnly=false, const Id< Network > &nwId=Id< Network >())

  Read IP group resources from the database.
  

Trunk resources:

• bool fetchTr (const OSB_DB::Session &session, bool availOnly=false, const Id< Network > &nwId=Id< Network >())

  Read trunk resource into internal list.
  

• static bool fetchTr (const OSB_DB::Session &session, TrList &dest, bool availOnly=false, const Id< Network > &nwId=Id< Network >())

  Read trunk resources from the database.
  

Public Types

Aliases for lists of concrete resources.

• typedef ResourceList< AccessNumber > AnList

  Short-cut for a access number resource list.
  

• typedef ResourceList< E164Resource > E164List

  Short-cut for an E.164 resource list.
  

• typedef ResourceList< Ip4Address > Ip4List

  Short-cut for an IP4 address resource list.
  

• typedef ResourceList< IpGroup > IpGroupList

  Short-cut for an IP group resource list.
  

• typedef ResourceList< TrunkResource > TrList

  Short-cut for a trunk resource list.
  

Public Member Functions

• ResourceLists (bool useLocks)

  Constructor with locking flag.
  

Public Attributes

• AnList accessNumbers_

  The access number resource list.
  

• E164List e164s_

  The E.164 resource list.
  

• Ip4List ip4s_

  The IP4 address resource list.
  

• IpGroupList ipGroups_

  The IP group resource list.
  

• TrList trunkResources_

  The trunk resource list.
  

---

Member Typedef Documentation

typedef ResourceList<AccessNumber> OSB_LIB::ResourceLists::AnList

Short-cut for a access number resource list.

Definition at line 332 of file resourcelists.h.

typedef ResourceList<E164Resource> OSB_LIB::ResourceLists::E164List

Short-cut for an E.164 resource list.

Definition at line 334 of file resourcelists.h.

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

Short-cut for an IP4 address resource list.

Definition at line 336 of file resourcelists.h.

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

Short-cut for an IP group resource list.

Definition at line 338 of file resourcelists.h.

typedef ResourceList<TrunkResource> OSB_LIB::ResourceLists::TrList

Short-cut for a trunk resource list.

Definition at line 340 of file resourcelists.h.

---

Constructor & Destructor Documentation

OSB_LIB::ResourceLists::ResourceLists

(

bool

useLocks

)

[explicit]

Constructor with locking flag.

Parameters:

useLocks

Flag if locking should be applied or not.

The constructor initalizes all resource list with the locking flag.

---

Member Function Documentation

bool OSB_LIB::ResourceLists::fetchAn	(	const OSB_DB::Session &	session,
		bool	availOnly = false,
		const Id< Network > &	nwId = Id< Network >()
	)

Read access number resource into internal list.

Parameters:

	session	Database session to use.
	availOnly	Flag if only available access number resources should be read.
	nwId	Optional network id of the access number resources to read.

Returns:

true if successful, false if locking fails.

The function just calls fetchAn with accessNumbers_ as argument.

static bool OSB_LIB::ResourceLists::fetchAn	(	const OSB_DB::Session &	session,
		AnList &	dest,
		bool	availOnly = false,
		const Id< Network > &	nwId = Id< Network >()
	)			[static]

Read access number resources from the database.

Parameters:

	session	Database session to use.
	dest	Access number resource list to populate.
	availOnly	Flag if only available access number resources should be read.
	nwId	Optional network id of the access number resources to read.

Returns:

true if successful, false if locking fails.

If availOnly is set, the function deletes existing resources from dest. The function uses OSB_DB::AccessNumberGw::fetch to read the matching access number resources from the database.

bool OSB_LIB::ResourceLists::fetchE164	(	const OSB_DB::Session &	session,
		Resource::Status	status,
		const std::string &	pattern,
		size_t	maxAdd
	)

Read E.164 resources from the database.

Parameters:

	session	Database session to use.
	status	Status of the number, ignored if set to Resource::rsUnknown.
	pattern	Pattern for which to search, ignored if empty: '?' matches one digit, '*' matches a sequence of digits.
	maxAdd	Maximum number of entries added to dest.

Returns:

true if successful, false if locking fails.

The function just calls fetchE164() with e164s_ as argument.

static bool OSB_LIB::ResourceLists::fetchE164	(	const OSB_DB::Session &	session,
		E164List &	dest,
		Resource::Status	status,
		const std::string &	pattern,
		size_t	maxAdd
	)			[static]

Read E.164 resources from the database.

Parameters:

	session	Database session to use.
	dest	Resource list to populate.
	status	Status of the number, ignored if set to Resource::rsUnknown.
	pattern	Pattern for which to search, ignored if empty: '?' matches one digit, '*' matches a sequence of digits.
	maxAdd	Maximum number of entries added to dest.

Returns:

true if successful, false if locking fails.

bool OSB_LIB::ResourceLists::fetchIp4	(	const OSB_DB::Session &	session,
		bool	availOnly = false,
		const Id< Network > &	nwId = Id< Network >()
	)

Read IP4 address resource into internal list.

Parameters:

	session	Database session to use.
	availOnly	Flag if only available IP4 address resources should be read.
	nwId	Optional network id of the IP4 address resources to read.

Returns:

true if successful, false if locking fails.

The function just calls fetchIp4 with ip4s_ as argument.

static bool OSB_LIB::ResourceLists::fetchIp4	(	const OSB_DB::Session &	session,
		Ip4List &	dest,
		bool	availOnly = false,
		const Id< Network > &	nwId = Id< Network >()
	)			[static]

Read IP4 address resources from the database.

Parameters:

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

Returns:

true if successful, false if locking fails.

If availOnly is set, the function deletes existing resources from dest. The function uses OSB_DB::Ip4AddressGw::fetch to read the matching IP4 address resources from the database.

bool OSB_LIB::ResourceLists::fetchIpg	(	const OSB_DB::Session &	session,
		bool	availOnly = false,
		const Id< Network > &	nwId = Id< Network >()
	)

Read IP group resource into internal list.

Parameters:

	session	Database session to use.
	availOnly	Flag if only available IP group resources should be read.
	nwId	Optional network id of the IP group resources to read.

Returns:

true if successful, false if locking fails.

The function just calls fetchIpg with ipGroups_ as argument.

static bool OSB_LIB::ResourceLists::fetchIpg	(	const OSB_DB::Session &	session,
		IpGroupList &	dest,
		bool	availOnly = false,
		const Id< Network > &	nwId = Id< Network >()
	)			[static]

Read IP group resources from the database.

Parameters:

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

Returns:

true if successful, false if locking fails.

If availOnly is set, the function deletes existing resources from dest. The function uses OSB_DB::IpGroupGw::fetch to read the matching IP group resources from the database.

bool OSB_LIB::ResourceLists::fetchTr	(	const OSB_DB::Session &	session,
		bool	availOnly = false,
		const Id< Network > &	nwId = Id< Network >()
	)

Read trunk resource into internal list.

Parameters:

	session	Database session to use.
	availOnly	Flag if only available trunk resources should be read.
	nwId	Optional network id of the trunk resources to read.

Returns:

true if successful, false if locking fails.

The function just calls fetchTr with trunkResources_ as argument.

static bool OSB_LIB::ResourceLists::fetchTr	(	const OSB_DB::Session &	session,
		TrList &	dest,
		bool	availOnly = false,
		const Id< Network > &	nwId = Id< Network >()
	)			[static]

Read trunk resources from the database.

Parameters:

	session	Database session to use.
	dest	Trunk resource list to populate.
	availOnly	Flag if only available trunk resources should be read.
	nwId	Optional network id of the trunk resources to read.

Returns:

true if successful, false if locking fails.

If availOnly is set, the function deletes existing resources from dest. The function uses OSB_DB::TrunkResourceGw::fetch to read the matching trunk resources from the database.

void OSB_LIB::ResourceLists::getAssignableIp4s	(	const OSB_DB::Session &	session,
		AssignableIp4s &	dest
	)

Get assignable IP4 addresses that can be assigned to the IP group.

Parameters:

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

---

Member Data Documentation

AnList OSB_LIB::ResourceLists::accessNumbers_

The access number resource list.

Definition at line 356 of file resourcelists.h.

E164List OSB_LIB::ResourceLists::e164s_

The E.164 resource list.

Definition at line 358 of file resourcelists.h.

Ip4List OSB_LIB::ResourceLists::ip4s_

The IP4 address resource list.

Definition at line 360 of file resourcelists.h.

IpGroupList OSB_LIB::ResourceLists::ipGroups_

The IP group resource list.

Definition at line 362 of file resourcelists.h.

TrList OSB_LIB::ResourceLists::trunkResources_

The trunk resource list.

Definition at line 364 of file resourcelists.h.

---

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

• resourcelists.h

---