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

teamspeakbf::ServerQuery Class Reference

Inheritance diagram for teamspeakbf::ServerQuery:
teamspeakbf::ServerNotification

List of all members.

Public Member Functions

def __init__
def connect
def disconnect
def escaping2string
def string2escaping
def command

Public Attributes

 IP
 Query
 Timeout
 lock
 telnet

Static Public Attributes

tuple TSRegex = re.compile(r"(\w+)=(.*?)(\s|$|\|)")

Constructor & Destructor Documentation

def teamspeakbf::ServerQuery::__init__ (   self,
  ip = '127.0.0.1',
  query = 10011 
)
This class contains functions to connecting a TS3 Query Port and send
command.
@param ip: IP adress of the TS3 Server
@type ip: str
@param query: Query Port of the TS3 Server. Default 10011
@type query: int

Reimplemented in teamspeakbf::ServerNotification.


Member Function Documentation

def teamspeakbf::ServerQuery::command (   self,
  cmd,
  parameter = {},
  option = [] 
)
Send a command with paramters and options to the TS3 Query.
@param cmd: The command who wants to send.
@type cmd: str
@param parameter: A dict with paramters and value.
Example: sid=2 --> {'sid':'2'}
@type cmd: dict
@param option: A list with options. Example: ´┐Żuid --> ['uid']
@type option: list
@return: The answer of the server as tulpe with error code and message.
def teamspeakbf::ServerQuery::connect (   self)
Open a link to the Teamspeak 3 query port
@return: A tulpe with a error code. Example: ('error', 0, 'ok')
def teamspeakbf::ServerQuery::disconnect (   self)
Close the link to the Teamspeak 3 query port
@return: ('error', 0, 'ok')
def teamspeakbf::ServerQuery::escaping2string (   self,
  string 
)
Convert the escaping string form the TS3 Query to a human string.
@param string: A string form the TS3 Query with ecaping.
@type string: str
@return: A human string with out escaping.
def teamspeakbf::ServerQuery::string2escaping (   self,
  string 
)
Convert a human string to a TS3 Query Escaping String.
@param string: A normal/human string.
@type string: str
@return: A string with escaping of TS3 Query.

Member Data Documentation

tuple teamspeakbf::ServerQuery::TSRegex = re.compile(r"(\w+)=(.*?)(\s|$|\|)") [static]

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