Daemon Class Functions List

  1.2) Class : tux.daemon
      1.2.1)    Function : tux.daemon.auto_connect
      1.2.2)    Function : tux.daemon.connect
      1.2.3)    Function : tux.daemon.disconnect
      1.2.4)    Function : tux.daemon.disconnect_client
      1.2.5)    Function : tux.daemon.get_client_count
      1.2.6)    Function : tux.daemon.get_client_name
      1.2.7)    Function : tux.daemon.get_my_client_id
      1.2.8)    Function : tux.daemon.get_version
      1.2.9)    Function : tux.daemon.kill
      1.2.10)   Function : tux.daemon.print_clients_name
      1.2.11)   Function : tux.daemon.set_my_client_name

Daemon Class Functions Details

   
      1.2.1)    Function : tux.daemon.auto_connect
      
          Allow to connect the api to tuxdaemon automatically
      
              Parameters:
              "value" as boolean      : turn on/off the auto_connect mode
              "address" as string     : Tcp/IP Host address
                                        (default = 'localhost')
              "port" as integer       : Tcp/IP Port number
                                        (default = 5000)
      
              Examples:
              >>> tux.daemon.auto_connect(True)
              >>> tux.daemon.auto_connect(True,'192.168.0.1')
              >>> tux.daemon.auto_connect(True,'192.168.0.1',5000)
          
      1.2.2)    Function : tux.daemon.connect
      
          Connect tux object to tuxdaemon
      
              Parameters:
              "port" as integer       : Tcp/IP Port number
                                        (default = 5000)
              "address" as string     : Tcp/IP Host address
                                        (default = 'localhost')
      
              Examples:
              >>> tux.daemon.connect()
              >>> tux.daemon.connect('192.168.0.1')
              >>> tux.daemon.connect('192.168.0.1',5000)
      
              Comment:
              The variable "tux.daemon.connected" contains the result of
              this method
          
      1.2.3)    Function : tux.daemon.disconnect
      
          Disconnect tux object from tuxdaemon
      
              Example:
              >>> tux.daemon.disconnect()
          
      1.2.4)    Function : tux.daemon.disconnect_client
      
          Disconnect a client from tuxdaemon
      
              Parameters:
              "id_client" as integer  : id of the client to disconnect
      
              Example:
              >>> tux.daemon.disconnect_client(0)
          
      1.2.5)    Function : tux.daemon.get_client_count
      
          Get the number of clients connected to tuxdaemon
      
              Return an integer
      
              Example:
              >>> print tux.daemon.get_client_count()
          
      1.2.6)    Function : tux.daemon.get_client_name
      
          Get the name of a client of tuxdaemon
      
              Return a string
      
              Example:
              >>> print tux.daemon.get_client_name(0)
          
      1.2.7)    Function : tux.daemon.get_my_client_id
      
          Get the client id of my connection to tuxdaemon
      
              Return an integer
      
              Example:
              >>> print tux.daemon.get_my_client_id()
          
      1.2.8)    Function : tux.daemon.get_version
      
          Get the version of tuxdaemon
      
              Return a string
      
              Example:
              >>> print tux.daemon.get_version()
          
      1.2.9)    Function : tux.daemon.kill
      
          Kill tuxdaemon
      
              Example:
              >>> tux.daemon.kill()
          
      1.2.10)   Function : tux.daemon.print_clients_name
      
          Print the name of all the clients connected to tuxdaemon
      
              Example:
              >>> tux.daemon.print_clients_name()
          
      1.2.11)   Function : tux.daemon.set_my_client_name
      
          Set my client name on tuxdaemon
      
              Parameters:
              "name" as string    : name of this client (max 11 char)
      
              Example:
              >>> tux.daemon.set_my_client_name('Py client')
      
              Comment:
              The variable 'tux.my_name' is affected by this function