BigBrotherBot v1.9.0
System Development Information for the BigBrotherBot project.

b3::parsers::frontline::protocol::Client Class Reference

List of all members.

Public Member Functions

def __init__
def handle_connect
def handle_close
def handle_read
def add_listener
def remove_listener
def login
def ping
def command
def __init__
def handle_connect
def handle_close
def handle_read
def add_listener
def remove_listener
def login
def ping
def command

Public Attributes

 console
 keepalive
 authed
 lastResponseTime

Private Member Functions

def _readPacket
def _inspect_packet
def _readPacket
def _inspect_packet

Private Attributes

 _host
 _port
 _username
 _password
 _buffer_in
 _handlers
 _auth_failures

Constructor & Destructor Documentation

def b3::parsers::frontline::protocol::Client::__init__ (   self,
  console,
  host,
  port,
  username,
  password,
  keepalive = False 
)
def b3::parsers::frontline::protocol::Client::__init__ (   self,
  console,
  host,
  port,
  username,
  password,
  keepalive = False 
)

Member Function Documentation

def b3::parsers::frontline::protocol::Client::_inspect_packet (   self,
  p 
) [private]
def b3::parsers::frontline::protocol::Client::_inspect_packet (   self,
  p 
) [private]
def b3::parsers::frontline::protocol::Client::_readPacket (   self) [private]
def b3::parsers::frontline::protocol::Client::_readPacket (   self) [private]
def b3::parsers::frontline::protocol::Client::add_listener (   self,
  handler_func 
)
def b3::parsers::frontline::protocol::Client::add_listener (   self,
  handler_func 
)
def b3::parsers::frontline::protocol::Client::command (   self,
  text 
)
send command to server
def b3::parsers::frontline::protocol::Client::command (   self,
  text 
)
send command to server
def b3::parsers::frontline::protocol::Client::handle_close (   self)
def b3::parsers::frontline::protocol::Client::handle_close (   self)
def b3::parsers::frontline::protocol::Client::handle_connect (   self)
def b3::parsers::frontline::protocol::Client::handle_connect (   self)
def b3::parsers::frontline::protocol::Client::handle_read (   self)
def b3::parsers::frontline::protocol::Client::handle_read (   self)
def b3::parsers::frontline::protocol::Client::login (   self,
  challenge 
)
authenticate to the server
from Frontline documentation : 

    Open a TCP/IP streaming socket to the remote console port of the server
    
    All commands sent and received are separated with new line characters '\n' or 0x04
    
    The server will send back a string (without the quotes):
    "WELCOME! Frontlines: Fuel of War (RCON) VER=2 CHALLENGE=38D384D07C"
    
    Note: Challenge string length is not fixed and will vary
    
    To generate a response use the MD5 algorithm to hash an ansi string:
    ResponseString = MD5Hash( ChallengeStringFromServer + Password );
    
    The client will send this string to the server to login:
    "RESPONSE UserNameHere ResponseString"
    
    If the login was successful the client will receive:
    "Login Success!"
    
    If the login failed, the client will be disconnected immediately
    
    Once the client is logged in commands can be sent to be run and responses can come back

def b3::parsers::frontline::protocol::Client::login (   self,
  challenge 
)
authenticate to the server
from Frontline documentation : 

    Open a TCP/IP streaming socket to the remote console port of the server
    
    All commands sent and received are separated with new line characters '\n' or 0x04
    
    The server will send back a string (without the quotes):
    "WELCOME! Frontlines: Fuel of War (RCON) VER=2 CHALLENGE=38D384D07C"
    
    Note: Challenge string length is not fixed and will vary
    
    To generate a response use the MD5 algorithm to hash an ansi string:
    ResponseString = MD5Hash( ChallengeStringFromServer + Password );
    
    The client will send this string to the server to login:
    "RESPONSE UserNameHere ResponseString"
    
    If the login was successful the client will receive:
    "Login Success!"
    
    If the login failed, the client will be disconnected immediately
    
    Once the client is logged in commands can be sent to be run and responses can come back

def b3::parsers::frontline::protocol::Client::ping (   self)
used to keep the connection alive. After 10 seconds of inactivity
the server will drop the connection
def b3::parsers::frontline::protocol::Client::ping (   self)
used to keep the connection alive. After 10 seconds of inactivity
the server will drop the connection
def b3::parsers::frontline::protocol::Client::remove_listener (   self,
  handler_func 
)
def b3::parsers::frontline::protocol::Client::remove_listener (   self,
  handler_func 
)

Member Data Documentation


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Properties