mcipc.query package
Subpackages
- mcipc.query.proto package
- Submodules
- mcipc.query.proto.basic_stats module
- mcipc.query.proto.common module
- mcipc.query.proto.full_stats module
- mcipc.query.proto.handshake module
- Module contents
Submodules
mcipc.query.client module
Query client library.
- class mcipc.query.client.Client(host: str, port: int, *, timeout: float | None = None)
Bases:
objectA basic client, common to Query and RCON.
- property basic_stats: BasicStats
Returns basic stats.
- connect() None
Contects the socket.
- disconnect() bool | None
Delegates to the underlying socket’s exit method.
- handshake() BigEndianSignedInt32
Performs a handshake.
- stats(full: bool = False) BasicStats | FullStats
Returns basic or full stats.
- property timeout: float
Returns the socket timeout.
mcipc.query.config module
Query server configuration.
mcipc.query.exceptions module
Common exceptions.
- exception mcipc.query.exceptions.InvalidConfig
Bases:
ValueErrorIndicates invalid credentials.
mcipc.query.queryclt module
Query client CLI.
- mcipc.query.queryclt.main()
Runs the RCON client.
Module contents
Query client library.
- class mcipc.query.Client(host: str, port: int, *, timeout: float | None = None)
Bases:
objectA basic client, common to Query and RCON.
- property basic_stats: BasicStats
Returns basic stats.
- connect() None
Contects the socket.
- disconnect() bool | None
Delegates to the underlying socket’s exit method.
- handshake() BigEndianSignedInt32
Performs a handshake.
- stats(full: bool = False) BasicStats | FullStats
Returns basic or full stats.
- property timeout: float
Returns the socket timeout.
- exception mcipc.query.InvalidConfig
Bases:
ValueErrorIndicates invalid credentials.