text.rst 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. ======================
  2. Gearmand TEXT Protocol
  3. ======================
  4. Gearmand supports a very simple administrative protocol that is enabled on the same port used by GEAR. You can make use of it via the gearadmin tool.
  5. The following list represents the current list of commands supported. You can issue any of these by telneting to the port and typing them in.
  6. .. describe:: workers
  7. Return the status of all attached workers.
  8. .. describe:: status
  9. Return the status of all current jobs.
  10. .. describe:: cancel job
  11. Cancel a job that has been queued.
  12. .. describe:: show jobs
  13. Show all current job ids.
  14. .. describe:: show unique jobs
  15. List all of the unique job ids that the server currently is processesing or waiting to process.
  16. .. describe:: create
  17. Create a function (i.e. queue).
  18. .. describe:: drop
  19. Drop a function (i.e. queue).
  20. .. describe:: maxqueue
  21. Set maxqueue
  22. .. describe:: getpid
  23. Return the process id of the server.
  24. .. describe:: verbose
  25. Return the verbose level of the server.
  26. .. describe:: version
  27. Version number of server.
  28. .. describe:: prioritystatus
  29. Queued jobs status by priority.