Terarea  2
The automation project
Loading...
Searching...
No Matches
src.lib.components.server_management.ServerManagement Class Reference
Collaboration diagram for src.lib.components.server_management.ServerManagement:
Collaboration graph

Public Member Functions

None __init__ (self, RuntimeData runtime_data, int error=84, int success=0, bool debug=False)
 
None __del__ (self)
 
bool is_server_alive (self)
 
bool is_server_running (self)
 
Response shutdown (self)
 
None initialise_classes (self)
 

Data Fields

RuntimeData runtime_data_initialised = runtime_data
 
int error = error
 
int success = success
 
bool debug = debug
 
Disp disp
 

Detailed Description

_summary_

Definition at line 15 of file server_management.py.

Constructor & Destructor Documentation

◆ __init__()

None src.lib.components.server_management.ServerManagement.__init__ ( self,
RuntimeData runtime_data,
int error = 84,
int success = 0,
bool debug = False )
_summary_

Definition at line 19 of file server_management.py.

◆ __del__()

None src.lib.components.server_management.ServerManagement.__del__ ( self)
_summary_
    The destructor of the class

Definition at line 37 of file server_management.py.

Member Function Documentation

◆ initialise_classes()

None src.lib.components.server_management.ServerManagement.initialise_classes ( self)
    The function to initialise the server classes

Definition at line 98 of file server_management.py.

◆ is_server_alive()

bool src.lib.components.server_management.ServerManagement.is_server_alive ( self)
    Check if the server is still running.
Returns:
    bool: Returns True if it is running.

Definition at line 59 of file server_management.py.

◆ is_server_running()

bool src.lib.components.server_management.ServerManagement.is_server_running ( self)
    Check if the server is still running.
Returns:
    bool: Returns True if it is running.

Definition at line 67 of file server_management.py.

◆ shutdown()

Response src.lib.components.server_management.ServerManagement.shutdown ( self)
    The function to shutdown the server
Returns:
    Response: Return the shutdown server message

Definition at line 75 of file server_management.py.

Field Documentation

◆ debug

bool src.lib.components.server_management.ServerManagement.debug = debug

Definition at line 26 of file server_management.py.

◆ disp

Disp src.lib.components.server_management.ServerManagement.disp
Initial value:
= Disp(
TOML_CONF,
FILE_DESCRIPTOR,
SAVE_TO_FILE,
FILE_NAME,
debug=self.debug,
logger=self.__class__.__name__
)

Definition at line 28 of file server_management.py.

◆ error

int src.lib.components.server_management.ServerManagement.error = error

Definition at line 24 of file server_management.py.

◆ runtime_data_initialised

RuntimeData src.lib.components.server_management.ServerManagement.runtime_data_initialised = runtime_data

Definition at line 23 of file server_management.py.

◆ success

int src.lib.components.server_management.ServerManagement.success = success

Definition at line 25 of file server_management.py.


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