Get the status of a running server.

Parameters:¶

host : str¶

The hostname or IP address of the server to check.

port : int¶

The port number to use when attempting to connect to the server.

server_option : ServerOption¶

The gfserver option to use when attempting to connect to the server.

instance : bool, optional¶

If True, return a Status object instead of a dictionary. Defaults to False.

Returns:¶

A dictionary or Status object containing the status information for the server.

Return type:¶

Union[Status, Dict[str, str]]

Example

>>> status_server("localhost", 8080, ServerOption, instance=True)
Status(uptime='0', queries='0', sequences='0', bytes='0', memory='0', threads='0', connections='0')