rcon

v0.2.0

rcon v0.2.0 RCON.Client

Provides functionality to connect to a RCON server.

Link to this section Summary

Types

connection()
options()

Functions

authenticate(conn, password)

Authenticate a connection given a password

connect(address, port, options \\ [])

Connects to an RCON server

exec(conn, command)

Execute a command

recv(arg)

Receive a RCON packet

send(conn, kind, body)

Send a RCON packet

Link to this section Types

Link to this type connection() 
connection() :: {Socket.TCP.t(), RCON.Packet.id()}
Link to this type options() 
options() :: [{:timeout, timeout()}]

Link to this section Functions

Link to this function authenticate(conn, password) 
authenticate(connection(), binary()) :: {:ok, connection()} | {:error, binary()}

Authenticate a connection given a password.

Link to this function connect(address, port, options \\ []) 
connect(Socket.Address.t(), :inet.port_number(), options()) ::
  {:ok, connection()} | {:error, Socket.Error.t()}

Connects to an RCON server.

Link to this function exec(conn, command) 
exec(connection(), binary()) ::
  {:ok, connection(), binary()} | {:error, binary()}

Execute a command.

Link to this function recv(arg) 
recv(connection()) :: {:ok, RCON.Packet.t()} | {:error, binary()}

Receive a RCON packet.

Link to this function send(conn, kind, body) 
send(connection(), RCON.Packet.kind(), RCON.Packet.body()) ::
  {:ok, connection(), RCON.Packet.id()} | {:error, binary()}

Send a RCON packet.