FrameRelayProcess handles and manipulates the Frame Relay process. More...

Inheritance diagram for FrameRelayProcess:

Public Member Functions
void	setLmiType (LmiType)
	Sets the LMI type for this Frame Relay process. More...

void	setEncapType (FrameRelayEncapType)
	Sets the encapsulation type for this Frame Relay process. More...

FrameRelayEncapType	getEncapType ()
	Returns the encapsulation type of this Frame Relay process. More...

LmiType	getLmiType ()
	Returns the encapsulation type of this Frame Relay process. More...

bool	addMapEntry (ip, int, bool, FrameRelayEncapType, string)
	Adds a map entry to the specified port. More...

bool	addIntDlciEntry (string, int)
	Adds a interface-DLCI entry the specified port. More...

bool	deleteMapEntry (string, ip)
	Removes the map entry from the specified port. More...

bool	deleteIntDlciEntry (string, int)
	Removes the interface-DLCI entry from the specified port. More...

FrameRelayMapEntry	getMapEntryAt (int, string)
	Returns the map entry at the specified index on the specified port. More...

short	getIntDlciEntryAt (int, string)
	Returns the interface-DLCI number at the specified index on the specified port. More...

short	getLmiDlciEntryAt (int)
	Returns LMI DLCI at the specified index. More...

bool	getLmiDlciStatusEntryAt (int)
	Returns true if the LMI DLCI at the specified index is active, otherwise false. More...

int	getMapEntryCount (string)
	Returns the number of map entries. More...

int	getIntDlciEntryCount (string)
	Returns the number of interface-DLCI entries. More...

int	getLmiDlciEntryCount ()
	Returns the number of LMI DLCI entries. More...

Port	getIntDlciToPort (int)
	Returns the port of the specified interface-DLCI. More...

void	clearInvArpEntries ()
	Clears the inverse ARP entries. More...

DlciTable	getDlciTable ()
	Returns the DLCI table. More...

Public Member Functions inherited from PortKeepAliveProcess
void	setKeepAliveOn (bool)

bool	isKeepAliveOn ()
	Returns true if keepalive is enabled, otherwise false. More...

void	setKeepAliveInterval (int)
	Sets the keepalive interval. More...

int	getKeepAliveInterval ()
	Returns the keepalive interval. More...

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

Detailed Description

FrameRelayProcess handles and manipulates the Frame Relay process.

Member Function Documentation

◆ addIntDlciEntry()

bool FrameRelayProcess::addIntDlciEntry	(	string	,
		int
	)

Adds a interface-DLCI entry 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
dlci,the	DLCI number.

Returns: bool, true if successful, otherwise false.

◆ addMapEntry()

bool FrameRelayProcess::addMapEntry	(	ip	,
		int	,
		bool	,
		FrameRelayEncapType	,
		string
	)

Adds a map entry to the specified port.

Parameters

ipAddress,the	IP address to map.
dlci,the	DLCI number.
bBroadcast,true	forwards broadcasts to this address, false does not forward broadcasts.
encapType,the	encapsulation type of this Frame Relay process. Encapsulation types: eFrameRelayEncapCisco = 0, eFrameRelayEncapIetf = 1, eFrameRelayEncapDefault = 2
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

Returns: bool, true if successful, otherwise false.

◆ clearInvArpEntries()

void FrameRelayProcess::clearInvArpEntries ( )

Clears the inverse ARP entries.

◆ deleteIntDlciEntry()

bool FrameRelayProcess::deleteIntDlciEntry	(	string	,
		int
	)

Removes the interface-DLCI entry from 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
dlci,the	DLCI number.

Returns: bool, true if successful, otherwise false.

◆ deleteMapEntry()

bool FrameRelayProcess::deleteMapEntry	(	string	,
		ip
	)

Removes the map entry from 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
ipAddress,the	IP address of the map.

Returns: bool, true if successful, otherwise false.

◆ getDlciTable()

DlciTable FrameRelayProcess::getDlciTable ( )

Returns the DLCI table.

Returns: DlciTable, the DlciTable object.

◆ getEncapType()

FrameRelayEncapType FrameRelayProcess::getEncapType ( )

Returns the encapsulation type of this Frame Relay process.

Returns: enum<FrameRelayEncapType>, the encapsulation type of this Frame Relay process. Encapsulation types: eFrameRelayEncapCisco = 0, eFrameRelayEncapIetf = 1, eFrameRelayEncapDefault = 2

◆ getIntDlciEntryAt()

short FrameRelayProcess::getIntDlciEntryAt	(	int	,
		string
	)

Returns the interface-DLCI number at the specified index on the specified port.

Parameters

index,the	index of the interface-DLCI of interest.
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

Returns: short, the interface-DLCI number at the specified index on the specified port.

◆ getIntDlciEntryCount()

int FrameRelayProcess::getIntDlciEntryCount ( string )

Returns the number of interface-DLCI entries.

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

Returns: int, the number of interface-DLCI entries.

◆ getIntDlciToPort()

Port FrameRelayProcess::getIntDlciToPort ( int )

Returns the port of the specified interface-DLCI.

Parameters

dlci,the interface-DLCI of interest.

Returns: Port, the Port object of the specified interface-DLCI.

◆ getLmiDlciEntryAt()

short FrameRelayProcess::getLmiDlciEntryAt ( int )

Returns LMI DLCI at the specified index.

Parameters

index,the index of the LMI DLCI of interest.

Returns: short, the LMI DLCI at the specified index.

◆ getLmiDlciEntryCount()

int FrameRelayProcess::getLmiDlciEntryCount ( )

Returns the number of LMI DLCI entries.

Returns: int, the number of LMI DLCI entries.

◆ getLmiDlciStatusEntryAt()

bool FrameRelayProcess::getLmiDlciStatusEntryAt ( int )

Returns true if the LMI DLCI at the specified index is active, otherwise false.

Parameters

index,the index of the LMI DLCI of interest.

Returns: bool, true if the LMI DLCI at the specified index is active, otherwise false.

◆ getLmiType()

LmiType FrameRelayProcess::getLmiType ( )

Returns the encapsulation type of this Frame Relay process.

Returns: enum<LmiType>, the LMI type of this Frame Relay process. LMI types: eLmiAnsi = 0, eLmiCisco = 1, eLmiQ933a = 2

◆ getMapEntryAt()

FrameRelayMapEntry FrameRelayProcess::getMapEntryAt	(	int	,
		string
	)

Returns the map entry at the specified index on the specified port.

Parameters

index,the	index of the map entry of interest.
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

Returns: FrameRelayMapEntry, the FrameRelayMapEntry object at the specified index on the specified port.

◆ getMapEntryCount()

int FrameRelayProcess::getMapEntryCount ( string )

Returns the number of map entries.

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

Returns: int, the number of map entries.

◆ setEncapType()

void FrameRelayProcess::setEncapType ( FrameRelayEncapType )

Sets the encapsulation type for this Frame Relay process.

Parameters

encapType,the encapsulation type. Encapsulation types: eFrameRelayEncapCisco = 0, eFrameRelayEncapIetf = 1, eFrameRelayEncapDefault = 2

◆ setLmiType()

void FrameRelayProcess::setLmiType ( LmiType )

Sets the LMI type for this Frame Relay process.

Parameters

lmiType,the LMI type. LMI types: eLmiAnsi = 0, eLmiCisco = 1, eLmiQ933a = 2

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

CFrameRelayProcess.pki

Public Member Functions

Detailed Description

Member Function Documentation

◆ addIntDlciEntry()

◆ addMapEntry()

◆ clearInvArpEntries()

◆ deleteIntDlciEntry()

◆ deleteMapEntry()

◆ getDlciTable()

◆ getEncapType()

◆ getIntDlciEntryAt()

◆ getIntDlciEntryCount()

◆ getIntDlciToPort()

◆ getLmiDlciEntryAt()

◆ getLmiDlciEntryCount()

◆ getLmiDlciStatusEntryAt()

◆ getLmiType()

◆ getMapEntryAt()

◆ getMapEntryCount()

◆ setEncapType()

◆ setLmiType()