OSB_LIB::NetworkManager Class Reference

Collaboration diagram for OSB_LIB::NetworkManager:

[legend]List of all members.

Detailed Description

Manager of all networks.

Definition at line 1091 of file network.h.

Public Types

Guard types

typedef ReadGuard< Network * > NetworkRg
Read guard for one network.
typedef ReadGuard< Networks * > NetworksRg
Read guard for the network list.
typedef WriteGuard< Network * > NetworkWg
Write guard for one network.
typedef RwGuard NetworksWg
Write guard for the network list.

Public Member Functions

NetworkManager ()
Default Constructor.
const TrunkGroup & getTrkGroup (const Id< TrunkGroup > &tgId) const
Find a trunk group by its id.

Read access to data members

const Networks & networks () const

Network maintenace

long readNetworks (const OSB_DB::Session &session)
Get all networks.
bool addNetwork (OSB_DB::Session &session, Network &net)
Creates a new network in the database.
bool updNetwork (OSB_DB::Session &session, Network &net)
Update a network to the database.
bool delNetwork (OSB_DB::Session &session, const Network::Oid &oid)
Deletes a network from the database.
const Network * findNetwork (const Network::Oid &oid) const
Find the network based on the given oid.
Network * network (const Network::Oid &oid)
Get the writable network based on the given oid.
const Network & getNetwork (const Network::Oid &oid) const
Get the network based on the given oid.
void sortNetworkByName (bool desc=false)
Sort networks by name.

Lock maintenace

NetworkRg readLock (const Network::Oid &oid)
Read-lock a network by its object id.
NetworksRg readLockList ()
Read-lock all networks.
NetworkWg writeLock (const Network::Oid &oid)
Write-lock a network by its object id.

Timezone operations.

long readTimeZones (const OSB_DB::Session &session)
Read all timezone.
const TimeZone & getTimeZone (const TimeZone::Oid &oid) const
Return the timezone for the given object id.
const TimeZones & getTimeZones () const
Return the timezones.

Private Member Functions

NetworksWg writeLockList ()
Write-lock the list of all networks.

Private Attributes

Networks networks_
Master list of networks.
RwMutex mutex_
Mutex for network and networks.
TimeZones timezones_
list of all timezone.

Member Typedef Documentation

typedef ReadGuard<Network*> OSB_LIB::NetworkManager::NetworkRg

Read guard for one network.

Definition at line 1096 of file network.h.

typedef ReadGuard<Networks*> OSB_LIB::NetworkManager::NetworksRg

Read guard for the network list.

Definition at line 1098 of file network.h.

typedef RwGuard OSB_LIB::NetworkManager::NetworksWg

Write guard for the network list.

Remarks:: Because only the network manager may get a write guard for all networks, there is no need to provide the pointer to the list within the guard.

Definition at line 1109 of file network.h.

typedef WriteGuard<Network*> OSB_LIB::NetworkManager::NetworkWg

Write guard for one network.

Definition at line 1100 of file network.h.

Constructor & Destructor Documentation

OSB_LIB::NetworkManager::NetworkManager ( )

Default Constructor.

Member Function Documentation

bool OSB_LIB::NetworkManager::addNetwork	(	OSB_DB::Session &	session,
		Network &	net
	)

Creates a new network in the database.

This method will write lock the whole list of network.
Add a network entry to the database. Also add it to the network list. The object id and object version will be set if insertion success.
Session will be committed if successful.

Parameters:

	session	The database session.
	net	The new network (oid not set).

Returns:: True if the network was created to the database.

Exceptions:

OsbException

can not lock the mutex
as specified by the gateway class (see there).

bool OSB_LIB::NetworkManager::delNetwork	(	OSB_DB::Session &	session,
		const Network::Oid &	oid
	)

Deletes a network from the database.

This method will write lock the whole list of network.
This will delete an entry from the database, also delete it from the network list. Session will be committed if successful.

Parameters:

	session	The database session.
	oid	Network to delete.

Returns:: True if the network was deleted from the database.

Exceptions:

OsbException

can not lock the mutex
network is not found in the list
as specified by the gateway class (see there).

const Network* OSB_LIB::NetworkManager::findNetwork ( const Network::Oid & oid ) const

Find the network based on the given oid.

Parameters:

oid

Object id of the network.

Returns:: Pointer to the found network,
NULL pointer if network can not be found.

const Network& OSB_LIB::NetworkManager::getNetwork ( const Network::Oid & oid ) const

Get the network based on the given oid.

Parameters:

oid

Object id of the network.

Returns:: Reference to the found network.

Exceptions:

ObjectNotFound

const TimeZone& OSB_LIB::NetworkManager::getTimeZone ( const TimeZone::Oid & oid ) const

Return the timezone for the given object id.

This will compare the given timezone id with the ids in the timezone container. If the given id is matched then it will return the reference to the timezone object else throw the exception.

Parameters:

oid

Unique identifier of the timezone.

Exceptions:

ObjectNotFound

Returns:: TimeZone reference for the given timezone id.

const TimeZones& OSB_LIB::NetworkManager::getTimeZones ( ) const

Return the timezones.

Returns:: Reference to the list of TimeZone

const TrunkGroup& OSB_LIB::NetworkManager::getTrkGroup ( const Id< TrunkGroup > & tgId ) const

Find a trunk group by its id.

Parameters:

tgId

Id of the trunk group to find.

Exceptions:

ObjectNotFound

Returns:: Reference to the found trunk group.

Network* OSB_LIB::NetworkManager::network ( const Network::Oid & oid )

Get the writable network based on the given oid.

Parameters:

oid

Object id of network.

Returns:: Pointer to network if found,
else 0.

const Networks& OSB_LIB::NetworkManager::networks ( ) const [inline]

Definition at line 1117 of file network.h.

References networks_.

NetworkRg OSB_LIB::NetworkManager::readLock ( const Network::Oid & oid )

Read-lock a network by its object id.

Parameters:

oid

Object id of the network.

Returns:: Read guard for this locked network.

Exceptions:

OsbException

can not lock the mutex
can not find this network.

NetworksRg OSB_LIB::NetworkManager::readLockList ( )

Read-lock all networks.

Returns:: Read guard for all locked networks.

Exceptions:

OsbException

Can not lock the mutex.

long OSB_LIB::NetworkManager::readNetworks ( const OSB_DB::Session & session )

Get all networks.

Load all networks from database and store them to the list.

Parameters:

session

Database session to use.

Returns:: Number of objects loaded.

Exceptions:

OsbException

as specified by the gateway class (see there).

long OSB_LIB::NetworkManager::readTimeZones ( const OSB_DB::Session & session )

Read all timezone.

Load all the timezone from the database.

Parameters:

session

Database session to use.

void OSB_LIB::NetworkManager::sortNetworkByName ( bool desc = false )

Sort networks by name.

Parameters:

desc

Flag to sort in descending (true) or ascending (false) order.

bool OSB_LIB::NetworkManager::updNetwork	(	OSB_DB::Session &	session,
		Network &	net
	)

Update a network to the database.

This method will write lock the network object.
Update network to the database. Also update it to the network list. The object version will be update if success.
Session will be committed if successful.

Parameters: