RCON Client API Reference¶

This page covers classes used for generic BattlEye RCON, like Arma Reforger. For Arma 3 and DayZ-specific classes, see the berconpy.ext.arma API Reference.

Client Interface¶

This covers the most important classes for handling RCON.

`berconpy.RCONClient`	An implementation of the RCON client protocol using asyncio.
`berconpy.EventDispatcher`	Provides an event handler system for use with asyncio.

Client Connector¶

These classes are generally not necessary to know about, but may be desired if the default networking needs to be tweaked.

`berconpy.AsyncClientConnector`	An asyncio implementation of the `AsyncClientProtocol`.
`berconpy.AsyncClientProtocol`	Provides a bridge between `RCONClient` and the underlying I/O implementations.
`berconpy.AsyncCommander`	Handles sending commands and waiting for responses.
`berconpy.ConnectorConfig`	Specifies the configuration used for the `AsyncClientConnector`.

Exceptions¶

These exceptions are raised by RCONClient.

`berconpy.LoginFailure`	Raised when the client could not log into the RCON server.
`berconpy.LoginRefused`	Raised when the password given to the RCON server was incorrect.
`berconpy.LoginTimeout`	Raised when the RCON server could not respond to our login attempts.
`berconpy.RCONError`	The base class for RCON errors.
`berconpy.RCONCommandError`	Raised when an issue occurs during execution of an RCON command.