OspfProcess is the process that handles the individual OSPF process. More...

Inheritance diagram for OspfProcess:

Public Member Functions
int	getProcessId ()
	Returns the OSPF process ID. More...

ip	getRouterId ()
	Returns the router-ID for this OSPF process. More...

int	getAreaCount ()
	Returns the number of OSPF areas. More...

OspfArea	getAreaAt (int)
	Returns the OSPF area at the specified index. More...

OspfArea	getArea (ip)
	Returns the OSPF area with the specified ID in IP address format. More...

void	removeArea (ip)
	Removes the OSPF area with the specified ID in IP address format. More...

bool	setAreaAuthentication (ip, OspfAuthType)

int	getAreaAuthenticationCount ()
	Returns the number of authenticated areas. More...

pair< ip, int >	getAreaAuthenticationAt (int)
	Returns the ID in IP address format and authentication type of the authenticated area at the specifed index. More...

OspfAuthType	getAreaAuthentication (ip)
	Returns the authentication type of the area with the specified ID in IP address format. More...

void	setDefaultInfoOrig (OspfDefaultInfoOrig)
	Sets the default information originate setting. More...

OspfDefaultInfoOrig	getDefaultInfoOrig ()
	Returns the default information originate setting. More...

void	setLogAdjacencyChanges (OspfLogChanges)
	Sets the log adjacadeny changes setting. More...

OspfLogChanges	getLogAdjacencyChanges ()
	Returns the log adjacadeny changes setting. More...

void	addConfiguredNetwork (ip, ip, ip)
	Enables OSPF routing in the specified OSPF area for the specified network. More...

void	removeConfigureNetwork (ip, ip, ip)
	Disables OSPF routing in the specified OSPF area for the specified network. More...

int	getConfNetworkCount ()
	Returns the number of configured networks. More...

OspfAreaNetwork	getConfNetworkAt (int)
	Returns the configured network at the specified index. More...

ip	getAreaId (ip, ip)
	Returns the area ID in IP address format of the specified network. More...

void	setDefaultPassiveInt (bool)
	Enables or disables default passive interface. More...

bool	getDefaultPassiveInt ()
	Returns true if default passive interface is enabled, otherwise false. More...

void	setPassiveInt (string, bool)
	Enables or disables passive interface for the specified port. More...

void	generateOspfRoutes (ip)
	Generates the OSPF routes for the OSPF area with the specified ID in IP address format. More...

Public Member Functions inherited from RoutingProtocol
void	setAdminDistance (int)
	Sets the administrative distance. More...

int	getAdminDistance ()
	Returns the administrative distance. More...

Public Member Functions inherited from Process
Device	getOwnerDevice ()
	Returns the device for this process. More...

Detailed Description

OspfProcess is the process that handles the individual OSPF process.

Member Function Documentation

◆ addConfiguredNetwork()

void OspfProcess::addConfiguredNetwork	(	ip	,
		ip	,
		ip
	)

Enables OSPF routing in the specified OSPF area for the specified network.

Parameters

ipAddressArea,the	ID in IP address format of the OSPF area.
ipAddress,the	network address.
mask,the	OSPF wild card bits.

◆ generateOspfRoutes()

void OspfProcess::generateOspfRoutes ( ip )

Generates the OSPF routes for the OSPF area with the specified ID in IP address format.

Parameters

ipAddressAreaID,the ID in IP address format of the OSPF area of interest.

◆ getArea()

OspfArea OspfProcess::getArea ( ip )

Returns the OSPF area with the specified ID in IP address format.

Parameters

ipAddressArea,the ID in IP address format of the OSPF area of interest.

Returns: OspfArea, the OspfArea object with the specified IP address.

◆ getAreaAt()

OspfArea OspfProcess::getAreaAt ( int )

Returns the OSPF area at the specified index.

Parameters

index,the index of the OSPF area of interest.

Returns: OspfArea, the OspfArea object at the specified index.

◆ getAreaAuthentication()

OspfAuthType OspfProcess::getAreaAuthentication ( ip )

Returns the authentication type of the area with the specified ID in IP address format.

Parameters

ipAddressArea,the ID in IP address format of the area of interest.

Returns: enum<OspfAuthType>, the authentication type. Authentication types: eNoAuth = 0, eAuth = 1, eMD5Auth = 2

◆ getAreaAuthenticationAt()

pair< ip, int > OspfProcess::getAreaAuthenticationAt ( int )

Returns the ID in IP address format and authentication type of the authenticated area at the specifed index.

Parameters

index,the index of the authenticated area of interest.

Returns: pair<ip, int>, the ID in IP address format and authentication type of the authenticated area at the specifed index.

◆ getAreaAuthenticationCount()

int OspfProcess::getAreaAuthenticationCount ( )

Returns the number of authenticated areas.

Returns: int, the number of authenticated areas.

◆ getAreaCount()

int OspfProcess::getAreaCount ( )

Returns the number of OSPF areas.

Returns: int, the number of OSPF areas.

◆ getAreaId()

ip OspfProcess::getAreaId	(	ip	,
		ip
	)

Returns the area ID in IP address format of the specified network.

Parameters

ipAddress,the	network address.
mask,the	OSPF wild card bits.

Returns: ip, the ID in IP address format of the specified network.

◆ getConfNetworkAt()

OspfAreaNetwork OspfProcess::getConfNetworkAt ( int )

Returns the configured network at the specified index.

Parameters

index,the index of the network of interest.

Returns: OspfAreaNetwork, the OspfAreaNetwork object.

◆ getConfNetworkCount()

int OspfProcess::getConfNetworkCount ( )

Returns the number of configured networks.

Returns: int, the number of configured networks.

◆ getDefaultInfoOrig()

OspfDefaultInfoOrig OspfProcess::getDefaultInfoOrig ( )

Returns the default information originate setting.

Returns: enum<OspfDefaultInfoOrig>, the default information originate setting. Default information originate settings: eNoDefaultInfoOrig = 0, eDefaultInfoOrig = 1, eDefaultInfoOrigAlways = 2

◆ getDefaultPassiveInt()

bool OspfProcess::getDefaultPassiveInt ( )

Returns true if default passive interface is enabled, otherwise false.

Returns: bool, true if default passive interface is enabled, otherwise false.

◆ getLogAdjacencyChanges()

OspfLogChanges OspfProcess::getLogAdjacencyChanges ( )

Returns the log adjacadeny changes setting.

Returns: enum<OspfLogChanges>, the log adjacadeny changes setting. Log adjacadeny changes settings: eNoLogChange = 0, eLogChange = 1, eLogChangeDetail = 2

◆ getProcessId()

int OspfProcess::getProcessId ( )

Returns the OSPF process ID.

Returns: int, the OSPF process ID.

◆ getRouterId()

ip OspfProcess::getRouterId ( )

Returns the router-ID for this OSPF process.

Returns: ip, the router-ID for this OSPF process.

◆ removeArea()

void OspfProcess::removeArea ( ip )

Removes the OSPF area with the specified ID in IP address format.

Parameters

ipAddressArea,the ID in IP address format of the OSPF area of interest.

◆ removeConfigureNetwork()

void OspfProcess::removeConfigureNetwork	(	ip	,
		ip	,
		ip
	)

Disables OSPF routing in the specified OSPF area for the specified network.

Parameters

ipAddressArea,the	ID in IP address format of the OSPF area.
ipAddress,the	network address.
mask,the	OSPF wild card bits.

◆ setAreaAuthentication()

bool OspfProcess::setAreaAuthentication	(	ip	,
		OspfAuthType
	)

\Sets the authentication type for the OSPF area with the specified ID in IP address format.

Parameters

ipAddressArea,the	ID in IP address format of the OSPF area of interest.
type,the	authentication type. Authentication types: eNoAuth = 0, eAuth = 1, eMD5Auth = 2

Returns: bool, true if successful, otherwise false.

◆ setDefaultInfoOrig()

void OspfProcess::setDefaultInfoOrig ( OspfDefaultInfoOrig )

Sets the default information originate setting.

Parameters

type,the default information originate setting. Default information originate settings: eNoDefaultInfoOrig = 0, eDefaultInfoOrig = 1, eDefaultInfoOrigAlways = 2

◆ setDefaultPassiveInt()

void OspfProcess::setDefaultPassiveInt ( bool )

Enables or disables default passive interface.

Parameters

b,true to enable default passive interface, false to disable it.

◆ setLogAdjacencyChanges()

void OspfProcess::setLogAdjacencyChanges ( OspfLogChanges )

Sets the log adjacadeny changes setting.

Parameters

type,the log adjacadeny changes setting. Log adjacadeny changes settings: eNoLogChange = 0, eLogChange = 1, eLogChangeDetail = 2

◆ setPassiveInt()

void OspfProcess::setPassiveInt	(	string	,
		bool
	)

Enables or disables passive interface for the specified port.

Parameters

portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
bPassive,true	to enable passive interface, false to disable it.

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

COspfProcess.pki

Public Member Functions

Detailed Description

Member Function Documentation

◆ addConfiguredNetwork()

◆ generateOspfRoutes()

◆ getArea()

◆ getAreaAt()

◆ getAreaAuthentication()

◆ getAreaAuthenticationAt()

◆ getAreaAuthenticationCount()

◆ getAreaCount()

◆ getAreaId()

◆ getConfNetworkAt()

◆ getConfNetworkCount()

◆ getDefaultInfoOrig()

◆ getDefaultPassiveInt()

◆ getLogAdjacencyChanges()

◆ getProcessId()

◆ getRouterId()

◆ removeArea()

◆ removeConfigureNetwork()

◆ setAreaAuthentication()

◆ setDefaultInfoOrig()

◆ setDefaultPassiveInt()

◆ setLogAdjacencyChanges()

◆ setPassiveInt()