backend.src.libs.server.Server Class Reference

Inheritance diagram for backend.src.libs.server.Server:

Collaboration diagram for backend.src.libs.server.Server:

Public Member Functions
None	__init__ (self, str host="0.0.0.0", int port=5000, int success=0, int error=84, str app_name="Asperguide", bool debug=False)
None	__del__ (self)
int	main (self)
bool	is_running (self)
None	stop_server (self)
Public Member Functions inherited from backend.src.libs.core.final_class.FinalClass

Data Fields
str	host = host
int	port = port
int	success = success
int	error = error
bool	debug = debug
str	app_name = app_name
RuntimeManager	runtime_manager = RI
ServerManagement	server_management_initialised
PathManager	paths_initialised
Crons	crons_initialised = self.runtime_manager.get(Crons)
BackgroundTasks	background_tasks_initialised
RuntimeControl	runtime_control
SQL	sql_connection = self.runtime_manager.get(SQL)

Static Public Attributes
Disp	disp = initialise_logger(__qualname__, False)

Detailed Description

_summary_

Definition at line 41 of file server.py.

Constructor & Destructor Documentation

__init__()

None backend.src.libs.server.Server.__init__	(		self,
		str	host = "0.0.0.0",
		int	port = 5000,
		int	success = 0,
		int	error = 84,
		str	app_name = "Asperguide",
		bool	debug = False )

_summary_
    This is the class Server, a class that contains the structures used to allow the uvicorn and fastapi combo to run successfully.
    host (str, optional): _description_. Defaults to "0.0.0.0".
    port (int, optional): _description_. Defaults to 5000.
    character_folder (str, optional): _description_. Defaults to "".
    usr_db_path (str, optional): _description_. Defaults to "".
    success (int, optional): _description_. Defaults to 0.
    error (int, optional): _description_. Defaults to 84.
    app_name (str, optional): _description_. Defaults to "Desktop Pets".
    debug (bool, optional): _description_. Defaults to False.

Reimplemented from backend.src.libs.core.final_class.FinalClass.

Definition at line 47 of file server.py.

__del__()

None backend.src.libs.server.Server.__del__

(

self

)

_summary_
    The destructor of the class.

Definition at line 172 of file server.py.

Member Function Documentation

is_running()

bool backend.src.libs.server.Server.is_running

(

self

)

_summary_
    The function in charge of checking if the server is running.

Returns:
    bool: _description_: Returns True if the server is running.

Definition at line 207 of file server.py.

main()

int backend.src.libs.server.Server.main

(

self

)

_summary_
    The main function of the server.
    This is the one in charge of starting the server.

Returns:
    int: _description_

Definition at line 179 of file server.py.

stop_server()

None backend.src.libs.server.Server.stop_server

(

self

)

_summary_
    The function in charge of stopping the server.

Definition at line 216 of file server.py.

Field Documentation

app_name

backend.src.libs.server.Server.app_name = app_name

Definition at line 68 of file server.py.

background_tasks_initialised

BackgroundTasks backend.src.libs.server.Server.background_tasks_initialised

Initial value:

=  self.runtime_manager.get(
            BackgroundTasks)

Definition at line 165 of file server.py.

crons_initialised

Crons backend.src.libs.server.Server.crons_initialised = self.runtime_manager.get(Crons)

Definition at line 164 of file server.py.

debug

backend.src.libs.server.Server.debug = debug

Definition at line 67 of file server.py.

disp

Disp backend.src.libs.server.Server.disp = initialise_logger(__qualname__, False)

static

Definition at line 45 of file server.py.

error

backend.src.libs.server.Server.error = error

Definition at line 66 of file server.py.

host

backend.src.libs.server.Server.host = host

Definition at line 63 of file server.py.

paths_initialised

PathManager backend.src.libs.server.Server.paths_initialised

Initial value:

=  self.runtime_manager.get(
            PathManager)

Definition at line 162 of file server.py.

port

backend.src.libs.server.Server.port = port

Definition at line 64 of file server.py.

runtime_control

RuntimeControl backend.src.libs.server.Server.runtime_control

Initial value:

=  self.runtime_manager.get(
            RuntimeControl)

Definition at line 167 of file server.py.

runtime_manager

RuntimeManager backend.src.libs.server.Server.runtime_manager = RI

Definition at line 70 of file server.py.

server_management_initialised

ServerManagement backend.src.libs.server.Server.server_management_initialised

Initial value:

=  self.runtime_manager.get(
            ServerManagement)

Definition at line 160 of file server.py.

sql_connection

SQL backend.src.libs.server.Server.sql_connection = self.runtime_manager.get(SQL)

Definition at line 169 of file server.py.

success

backend.src.libs.server.Server.success = success

Definition at line 65 of file server.py.

---

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

• backend/src/libs/server.py