VlanManager Class Reference

VlanManager holds and manipulates VLANs on routers and switches. More...

Inheritance diagram for VlanManager:

Public Member Functions
Vlan	getVlan (int)
	Returns the VLAN with the specified VLAN number. More...
Vlan	getVlanAt (int)
	Returns the VLAN at the specified index. More...
bool	addVlan (int, string)
	Adds a VLAN. More...
bool	removeVlan (int)
	Removes the VLAN with the specified VLAN number. More...
int	getVlanCount ()
	Returns the number of VLANs. More...
int	getMaxVlans ()
	Returns the maximum number of VLANs. More...
Vlan	getVlanByName (string)
	Returns the VLAN with the specified VLAN name. More...
bool	changeVlanName (int, string)
	Changes the VLAN name. More...
bool	addVlanInt (int)
	Adds a VLAN interface with the specified VLAN number. More...
bool	removeVlanInt (int)
	Removes the VLAN interface with the specified VLAN number. More...
RouterPort	getVlanInt (int)
	Returns the VLAN interface with the specified VLAN number. More...
RouterPort	getVlanIntAt (int)
	Returns the VLAN interface at the specified index. More...
int	getVlanIntCount ()
	Returns the number of VLAN interfaces. More...
void	updateTableEvent ()
	This event is emitted when the vlan table is updated. More...
Public Member Functions inherited from Process
Device	getOwnerDevice ()
	Returns the device for this process. More...

Detailed Description

VlanManager holds and manipulates VLANs on routers and switches.

Member Function Documentation

addVlan()

bool VlanManager::addVlan	(	int	,
		string
	)

Adds a VLAN.

Parameters

vlandID,the	number for the VLAN.
vlanName,the	name for the VLAN.

Returns

bool, true if successful, otherwise false.

addVlanInt()

bool VlanManager::addVlanInt

(

int

)

Adds a VLAN interface with the specified VLAN number.

Parameters

vlanID,the

VLAN number for the VLAN interface.

Returns

bool, true if successful, otherwise false.

changeVlanName()

bool VlanManager::changeVlanName	(	int	,
		string
	)

Changes the VLAN name.

Parameters

vlanID,the	VLAN number of interest.
name,the	name for the VLAN.

Returns

bool, true if successful, otherwise false.

getMaxVlans()

int VlanManager::getMaxVlans

(

)

Returns the maximum number of VLANs.

Returns

int, the maximum number of VLANs.

getVlan()

Vlan VlanManager::getVlan

(

int

)

Returns the VLAN with the specified VLAN number.

Parameters

vlanID,the

number of the VLAN of interest.

Returns

Vlan, the Vlan object with the specified VLAN number.

getVlanAt()

Vlan VlanManager::getVlanAt

(

int

)

Returns the VLAN at the specified index.

Parameters

index,the

index of the VLAN of interest.

Returns

Vlan, the Vlan object at the specified index.

getVlanByName()

Vlan VlanManager::getVlanByName

(

string

)

Returns the VLAN with the specified VLAN name.

Parameters

name,the

name of the VLAN of interest.

Returns

Vlan, the Vlan object with the specified VLAN name.

getVlanCount()

int VlanManager::getVlanCount

(

)

Returns the number of VLANs.

Returns

int, the number of VLANs.

getVlanInt()

RouterPort VlanManager::getVlanInt

(

int

)

Returns the VLAN interface with the specified VLAN number.

Parameters

vlanID,the

VLAN number of interest.

Returns

RouterPort, the RouterPort object of the VLAN interface with the specified VLAN number.

getVlanIntAt()

RouterPort VlanManager::getVlanIntAt

(

int

)

Returns the VLAN interface at the specified index.

Parameters

index,the

index of the VLAN interface of interest.

Returns

RouterPort, the RouterPort object of the VLAN interface at the specified index.

getVlanIntCount()

int VlanManager::getVlanIntCount

(

)

Returns the number of VLAN interfaces.

Returns

int, the number of VLAN interfaces.

removeVlan()

bool VlanManager::removeVlan

(

int

)

Removes the VLAN with the specified VLAN number.

Parameters

vlandID,the

VLAN number of interest.

Returns

bool, true if successful, otherwise false.

removeVlanInt()

bool VlanManager::removeVlanInt

(

int

)

Removes the VLAN interface with the specified VLAN number.

Parameters

vlanID,the

VLAN number of interest.

Returns

bool, true if successful, otherwise false.

updateTableEvent()

void VlanManager::updateTableEvent

(

)

This event is emitted when the vlan table is updated.

IPC event.

---

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

• CVLANManager.pki