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
HttpsServer Class Reference

HttpsServer handles and manipulates the HTTPS server on devices. More...

Inheritance diagram for HttpsServer:
HttpServer Process

Public Member Functions

void setHttpsEnable (bool)
 Enables or disables the HTTPS service. More...
 
bool isHttpsEnabled ()
 Returns true if the HTTPS service is enabled, otherwise false. More...
 
- Public Member Functions inherited from HttpServer
void setPortNumber (short)
 Sets the port number of the HTTP service. More...
 
short getPortNumber ()
 Returns the port number of the HTTP service. More...
 
void setEnable (bool)
 Enables or disables the HTTP service. More...
 
bool isEnabled ()
 Returns true if the HTTP service is enabled, otherwise false. More...
 
string getPage (string)
 Returns the page contents at the specified URL. More...
 
void setPageContents (string, string)
 Sets the page contents at the specified URL. More...
 
string getUsername ()
 Returns the htaccess username for the HTTP server. More...
 
string getPassword ()
 Returns the htaccess password for the HTTP server. More...
 
void setUsername (string)
 Sets the htaccess username for the HTTP server. More...
 
void setPassword (string)
 Sets the htaccess password for the HTTP server. More...
 
void sendResponse (TcpConnection, string)
 send the HTTP response back to client with given content. More...
 
void sendTypedResponse (TcpConnection, string, string)
 send the HTTP response back to client with given content and content type. More...
 
void sendFileResponse (TcpConnection, string)
 send the HTTP response back to client with given file. More...
 
void sendNotFoundResponse (TcpConnection)
 send the 404 not found HTTP response back to client with given file. More...
 
bool onRequest (string, TcpConnection)
 This delegate pass the url and tcp connection on HTTP request and returns true if successful, otherwise false. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

HttpsServer handles and manipulates the HTTPS server on devices.

Member Function Documentation

◆ isHttpsEnabled()

bool HttpsServer::isHttpsEnabled ( )

Returns true if the HTTPS service is enabled, otherwise false.

Returns
bool, true if the HTTPS service is enabled, otherwise false.

◆ setHttpsEnable()

void HttpsServer::setHttpsEnable ( bool  )

Enables or disables the HTTPS service.

Parameters
bEnable,trueto enable the HTTPS service, false to disable it.

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