gearman_actions_t.3 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. .TH "GEARMAN_ACTIONS_T" "3" "March 07, 2012" "0.29" "Gearmand"
  2. .SH NAME
  3. gearman_actions_t \- Gearmand Documentation, http://gearman.info/
  4. .
  5. .nr rst2man-indent-level 0
  6. .
  7. .de1 rstReportMargin
  8. \\$1 \\n[an-margin]
  9. level \\n[rst2man-indent-level]
  10. level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11. -
  12. \\n[rst2man-indent0]
  13. \\n[rst2man-indent1]
  14. \\n[rst2man-indent2]
  15. ..
  16. .de1 INDENT
  17. .\" .rstReportMargin pre:
  18. . RS \\$1
  19. . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20. . nr rst2man-indent-level +1
  21. .\" .rstReportMargin post:
  22. ..
  23. .de UNINDENT
  24. . RE
  25. .\" indent \\n[an-margin]
  26. .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27. .nr rst2man-indent-level -1
  28. .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29. .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30. ..
  31. .\" Man page generated from reStructeredText.
  32. .
  33. .SH SYNOPSIS
  34. .sp
  35. #include <libgearman/gearman.h>
  36. .INDENT 0.0
  37. .TP
  38. .B gearman_actions_t
  39. .UNINDENT
  40. .INDENT 0.0
  41. .TP
  42. .B void gearman_client_set_workload_fn(gearman_client_st\fI\ *client\fP, gearman_workload_fn\fI\ *function\fP)
  43. .UNINDENT
  44. .INDENT 0.0
  45. .TP
  46. .B void gearman_client_set_created_fn(gearman_client_st\fI\ *client\fP, gearman_created_fn\fI\ *function\fP)
  47. .UNINDENT
  48. .INDENT 0.0
  49. .TP
  50. .B void gearman_client_set_data_fn(gearman_client_st\fI\ *client\fP, gearman_data_fn\fI\ *function\fP)
  51. .UNINDENT
  52. .INDENT 0.0
  53. .TP
  54. .B void gearman_client_set_warning_fn(gearman_client_st\fI\ *client\fP, gearman_warning_fn\fI\ *function\fP)
  55. .UNINDENT
  56. .INDENT 0.0
  57. .TP
  58. .B void gearman_client_set_status_fn(gearman_client_st\fI\ *client\fP, gearman_universal_status_fn\fI\ *function\fP)
  59. .UNINDENT
  60. .INDENT 0.0
  61. .TP
  62. .B void gearman_client_set_complete_fn(gearman_client_st\fI\ *client\fP, gearman_complete_fn\fI\ *function\fP)
  63. .UNINDENT
  64. .INDENT 0.0
  65. .TP
  66. .B void gearman_client_set_exception_fn(gearman_client_st\fI\ *client\fP, gearman_exception_fn\fI\ *function\fP)
  67. .UNINDENT
  68. .INDENT 0.0
  69. .TP
  70. .B void gearman_client_set_fail_fn(gearman_client_st\fI\ *client\fP, gearman_fail_fn\fI\ *function\fP)
  71. .UNINDENT
  72. .INDENT 0.0
  73. .TP
  74. .B void gearman_client_clear_fn(gearman_client_st\fI\ *client\fP)
  75. .UNINDENT
  76. .sp
  77. Link to \-lgearman
  78. .SH DESCRIPTION
  79. .sp
  80. Callbacks for client execution task states.
  81. .sp
  82. \fBgearman_client_do_job_handle()\fP sets the callback function that will
  83. be called if server is to make a request to the client to provide more data.
  84. .sp
  85. \fI\%gearman_client_clear_fn()\fP can be called to remove all existing
  86. \fI\%gearman_actions_t\fP that have been set.
  87. .sp
  88. \fI\%gearman_client_set_created_fn()\fP,
  89. \fI\%gearman_client_set_data_fn()\fP,
  90. \fI\%gearman_client_set_warning_fn()\fP,
  91. \fI\%gearman_client_set_status_fn()\fP,
  92. \fI\%gearman_client_set_complete_fn()\fP,
  93. \fI\%gearman_client_set_exception_fn()\fP, and
  94. \fI\%gearman_client_set_fail_fn()\fP, set callback functions for the
  95. different states of execution for a client request. Each request, ie
  96. a creation of \fBgearman_task_st\fP, keeps a copy of callbacks when it
  97. is created.
  98. .SH RETURN VALUE
  99. .sp
  100. None
  101. .IP "See also"
  102. .RE
  103. .sp
  104. \fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_client_error(3)\fP or \fIgearman_worker_error(3)\fP
  105. .SH AUTHOR
  106. Data Differential http://datadifferential.com/
  107. .SH COPYRIGHT
  108. 2011, Data Differential, http://datadifferential.com/
  109. .\" Generated by docutils manpage writer.
  110. .\"
  111. .