Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
PppoeClient Class Reference

PppoeClient handles and manipulates the PPPoE client. More...

Inheritance diagram for PppoeClient:
Process

Public Member Functions

void setUsername (string)
 Sets the username. More...
 
void setConnectionStatus (PppoeConnectionStatus)
 Sets the status. More...
 
string getUsername ()
 Gets the username. More...
 
void setPassword (string)
 Sets the password. More...
 
string getPassword ()
 Gets the password. More...
 
void setServiceName (string)
 Sets the service name. More...
 
string getServiceName ()
 Gets the service name. More...
 
void connect (string, string)
 Makes a PPPoE connection with the specified username and password. More...
 
void connectFromPc (string, string)
 
void disconnectFromPc ()
 
void disconnect (int, PppoeConnectionStatus, bool)
 Disconnects the PPPoE connection. enum EPppoeConnectionStatus { eConnected = 0, eConnecting = 1, ePoolRejected = 2, eDisconnected = 3, eTimeout = 4, eNoKeepAlive = 5, eAuthentcationFailed = 6 };. More...
 
bool isConnected ()
 Checks if it is connected. More...
 
void setConnected (bool)
 Set if it is connected. More...
 
PppoeConnectionStatus getConnectionStatus ()
 Gets the connection status. More...
 
void updatePppoeInfo (QString, QString)
 This event is emitted when a PPPoE update info event occurs. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

PppoeClient handles and manipulates the PPPoE client.

Member Function Documentation

◆ connect()

void PppoeClient::connect ( string  ,
string   
)

Makes a PPPoE connection with the specified username and password.

Parameters
userName,theusername.
password,thepassword.

◆ connectFromPc()

void PppoeClient::connectFromPc ( string  ,
string   
)

◆ disconnect()

void PppoeClient::disconnect ( int  ,
PppoeConnectionStatus  ,
bool   
)

Disconnects the PPPoE connection. enum EPppoeConnectionStatus { eConnected = 0, eConnecting = 1, ePoolRejected = 2, eDisconnected = 3, eTimeout = 4, eNoKeepAlive = 5, eAuthentcationFailed = 6 };.

◆ disconnectFromPc()

void PppoeClient::disconnectFromPc ( )

◆ getConnectionStatus()

PppoeConnectionStatus PppoeClient::getConnectionStatus ( )

Gets the connection status.

Returns
enum<PppoeConnectionStatus> types: eConnected = 0, eConnecting = 1, ePoolRejected = 2, eDisconnected = 3, eTimeout = 4, eNoKeepAlive = 5, eAuthentcationFailed = 6

◆ getPassword()

string PppoeClient::getPassword ( )

Gets the password.

Returns
, the password.

◆ getServiceName()

string PppoeClient::getServiceName ( )

Gets the service name.

Returns
string, the service name to use.

◆ getUsername()

string PppoeClient::getUsername ( )

Gets the username.

Returns
string, the username.

◆ isConnected()

bool PppoeClient::isConnected ( )

Checks if it is connected.

Returns
bool, true if connected, false if not.

◆ setConnected()

void PppoeClient::setConnected ( bool  )

Set if it is connected.

Parameters
flag,trueif connected, false if not.

◆ setConnectionStatus()

void PppoeClient::setConnectionStatus ( PppoeConnectionStatus  )

Sets the status.

Parameters
status,thestatus types: eConnected = 0, eConnecting = 1, ePoolRejected = 2, eDisconnected = 3, eTimeout = 4, eNoKeepAlive = 5, eAuthentcationFailed = 6

◆ setPassword()

void PppoeClient::setPassword ( string  )

Sets the password.

Parameters
password,thepassword.

◆ setServiceName()

void PppoeClient::setServiceName ( string  )

Sets the service name.

Parameters
service,theservice name to use.

◆ setUsername()

void PppoeClient::setUsername ( string  )

Sets the username.

Parameters
userName,theusername.

◆ updatePppoeInfo()

void PppoeClient::updatePppoeInfo ( QString  ,
QString   
)

This event is emitted when a PPPoE update info event occurs.

  • deviceName, name of hte device this was from.
  • info, the PPPoE update info.

IPC event.


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