NethServer::TrackerClient

NAME

  NethServer::TrackerClient -- Task progress tracker client

DESCRIPTION

  This class keeps a connection to the ptrack server, that collects the
  progress status of a hierarchy of tasks.

  If you plan to execute a subprocess that represents a subtask, invoke the
  declare_task() method, to obtain a new task id, then set the environment
  variable PTRACK_TASKID for the subprocess.

Methods

  new
        parentId (integer) optional -- The default parent task id
        socket (IO::Socket) optional -- An already connected to the server

      Creates a class instance. It accepts two optional arguments.

      If parentId is undef, the value is read from the environment variable
      PTRACK_TASKID. If this is missing, a value int(0) is assumed,
      corresponding to the root task, declared by ptrack itself.

      If the socket is undef, a unix socket is opened from the filesystem
      path pointed by the environment variable PTRACK_SOCKETPATH.

      The socket is closed when the object is destroyed.

  declare_task
        title (string) optional
        weight (float) optional, defaults to 1.0
        parentId (integer) optional defaults to parentId set from constructor

      Returns the declared task identifier (integer).

  set_task_done
        taskId (integer)
        message (string)
        code (integer)

  set_task_progress
        taskId (integer)
        progress (float)
        message (string)
        code (integer)

  query
        subject (string) defaults to "progress"

  get_progress
      DEPRECATED use query

perldoc NethServer::Directory