index.rst 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. ==========
  2. Libgearman
  3. ==========
  4. `libgearman` is a small, thread-safe client library for the
  5. gearman protocol. The code has all been written with an eye to allow
  6. for both web and embedded usage. It handles the work behind routing
  7. particular keys to specific servers that you specify (and values are
  8. matched based on server order as supplied by you). It implements both
  9. the :term:`client` and :term:`worker` interfaces.
  10. ***************
  11. Getting Started
  12. ***************
  13. .. toctree::
  14. :titlesonly:
  15. workers
  16. ********
  17. Examples
  18. ********
  19. .. toctree::
  20. :titlesonly:
  21. examples
  22. ****************
  23. Client Functions
  24. ****************
  25. .. toctree::
  26. :titlesonly:
  27. gearman_client
  28. gearman_client_add_server
  29. gearman_client_options
  30. gearman_client_do
  31. gearman_client_do_background
  32. gearman_execute
  33. gearman_client_error
  34. gearman_client_set_log_fn
  35. gearman_client_job_status
  36. **************
  37. Creating Tasks
  38. **************
  39. .. toctree::
  40. :titlesonly:
  41. gearman_client_add_task
  42. gearman_client_run_tasks
  43. gearman_client_add_task_background
  44. gearman_client_add_task_status
  45. ****************
  46. Worker Functions
  47. ****************
  48. .. toctree::
  49. :titlesonly:
  50. gearman_worker_create
  51. gearman_worker_add_server
  52. gearman_worker_options
  53. gearman_worker_add_function
  54. gearman_worker_define_function
  55. gearman_worker_error
  56. gearman_worker_set_log_fn
  57. gearman_worker_set_identifier
  58. ****
  59. Misc
  60. ****
  61. .. toctree::
  62. :titlesonly:
  63. gearman_misc_functions
  64. namespace
  65. gearman_client_wait
  66. gearman_client_echo
  67. **********
  68. Structures
  69. **********
  70. .. toctree::
  71. :titlesonly:
  72. gearman_client_st
  73. gearman_job_st
  74. gearman_task_st
  75. gearman_worker_st
  76. gearman_job_handle_t
  77. gearman_argument_t
  78. gearman_string_t
  79. gearman_result_t
  80. gearman_task_attr_t
  81. *****
  82. Types
  83. *****
  84. .. toctree::
  85. :titlesonly:
  86. gearman_allocator_t
  87. gearman_return_t
  88. gearman_actions_t
  89. gearman_log_fn
  90. gearman_verbose_t
  91. *****
  92. Extra
  93. *****
  94. .. toctree::
  95. :titlesonly:
  96. error_descriptions
  97. types