pxblat.Server.status(*, instance=False) → dict[str, str] | Status[source]

Retrieves the status of the gfServer instance.

Parameters:
instance : bool, optional

If True, returns a Status object. If False, returns a dictionary with status information. Defaults to False.

Returns:

The status of the gfServer instance, either as a dictionary or a Status object.

Return type:

t.Union[t.Dict[str, str], Status]

See also

status_server() is a free function to query server status.