patch-docs_man3_qbloop_h_3 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. --- libqb-0.16.0.orig/docs/man3/qbloop.h.3 2013-07-25 20:16:18.000000000 +0200
  2. +++ libqb-0.16.0/docs/man3/qbloop.h.3 2013-09-09 05:26:31.751807045 +0200
  3. @@ -1,4 +1,4 @@
  4. -.TH "qbloop.h" 3 "Thu Jul 25 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  5. +.TH "qbloop.h" 3 "Mon Sep 9 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  6. .ad l
  7. .nh
  8. .SH NAME
  9. @@ -47,7 +47,7 @@ Main loop manages timers, jobs and polli
  10. .in +1c
  11. .ti -1c
  12. -.RI "enum \fBqb_loop_priority\fP { \fBQB_LOOP_LOW\fP = 0, \fBQB_LOOP_MED\fP = 1, \fBQB_LOOP_HIGH\fP = 2 }"
  13. +.RI "enum \fBqb_loop_priority\fP { \fBQB_LOOP_LOW\fP = 0, \fBQB_LOOP_MED\fP = 1, \fBQB_LOOP_HIGH\fP = 2 }"
  14. .br
  15. .RI "\fIPriorites for jobs, timers & poll\&. \fP"
  16. .in -1c
  17. @@ -129,32 +129,23 @@ Main loop manages timers, jobs and polli
  18. .SH "Typedef Documentation"
  19. .PP
  20. -.SS "typedef void(* qb_loop_job_dispatch_fn)(void *data)"
  21. -
  22. -.SS "typedef int32_t(* qb_loop_poll_dispatch_fn)(int32_t fd, int32_t revents, void *data)"
  23. -
  24. -.SS "typedef void(* qb_loop_poll_low_fds_event_fn)(int32_t not_enough, int32_t fds_available)"
  25. -
  26. -.SS "typedef int32_t(* qb_loop_signal_dispatch_fn)(int32_t rsignal, void *data)"
  27. -
  28. +.SS "typedef void(* \fBqb_loop_job_dispatch_fn\fP)(void *data)"
  29. +.SS "typedef int32_t(* \fBqb_loop_poll_dispatch_fn\fP)(int32_t fd, int32_t revents, void *data)"
  30. +.SS "typedef void(* \fBqb_loop_poll_low_fds_event_fn\fP)(int32_t not_enough, int32_t fds_available)"
  31. +.SS "typedef int32_t(* \fBqb_loop_signal_dispatch_fn\fP)(int32_t rsignal, void *data)"
  32. .SS "typedef void* \fBqb_loop_signal_handle\fP"
  33. -
  34. .SS "typedef struct qb_loop \fBqb_loop_t\fP"
  35. -
  36. .PP
  37. An opaque data type representing the main loop\&.
  38. -.SS "typedef void(* qb_loop_timer_dispatch_fn)(void *data)"
  39. -
  40. +.SS "typedef void(* \fBqb_loop_timer_dispatch_fn\fP)(void *data)"
  41. .SS "typedef uint64_t \fBqb_loop_timer_handle\fP"
  42. -
  43. .SH "Enumeration Type Documentation"
  44. .PP
  45. .SS "enum \fBqb_loop_priority\fP"
  46. -
  47. .PP
  48. Priorites for jobs, timers & poll\&.
  49. .PP
  50. -\fBEnumerator\fP
  51. +\fBEnumerator: \fP
  52. .in +1c
  53. .TP
  54. \fB\fIQB_LOOP_LOW \fP\fP
  55. @@ -162,10 +153,10 @@ Priorites for jobs, timers & poll\&.
  56. \fB\fIQB_LOOP_MED \fP\fP
  57. .TP
  58. \fB\fIQB_LOOP_HIGH \fP\fP
  59. +
  60. .SH "Function Documentation"
  61. .PP
  62. -.SS "\fBqb_loop_t\fP* qb_loop_create (void)"
  63. -
  64. +.SS "\fBqb_loop_t\fP* \fBqb_loop_create\fP (void)"
  65. .PP
  66. Create a new main loop\&. \fBReturns:\fP
  67. .RS 4
  68. @@ -173,10 +164,8 @@ loop instance\&.
  69. .RE
  70. .PP
  71. -.SS "void qb_loop_destroy (struct qb_loop *l)"
  72. -
  73. -.SS "int32_t qb_loop_job_add (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, void *data, \fBqb_loop_job_dispatch_fn\fPdispatch_fn)"
  74. -
  75. +.SS "void \fBqb_loop_destroy\fP (struct qb_loop *l)"
  76. +.SS "int32_t \fBqb_loop_job_add\fP (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, void *data, \fBqb_loop_job_dispatch_fn\fPdispatch_fn)"
  77. .PP
  78. Add a job to the mainloop\&. This is run in the next cycle of the loop\&.
  79. .PP
  80. @@ -202,8 +191,7 @@ status (0 == ok, -errno == failure)
  81. .RE
  82. .PP
  83. -.SS "int32_t qb_loop_job_del (struct qb_loop *l, enum \fBqb_loop_priority\fPp, void *data, \fBqb_loop_job_dispatch_fn\fPdispatch_fn)"
  84. -
  85. +.SS "int32_t \fBqb_loop_job_del\fP (struct qb_loop *l, enum \fBqb_loop_priority\fPp, void *data, \fBqb_loop_job_dispatch_fn\fPdispatch_fn)"
  86. .PP
  87. Delete a job from the mainloop\&. This will try to delete the job if it hasn't run yet\&.
  88. .PP
  89. @@ -229,8 +217,7 @@ status (0 == ok, -errno == failure)
  90. .RE
  91. .PP
  92. -.SS "int32_t qb_loop_poll_add (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, int32_tfd, int32_tevents, void *data, \fBqb_loop_poll_dispatch_fn\fPdispatch_fn)"
  93. -
  94. +.SS "int32_t \fBqb_loop_poll_add\fP (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, int32_tfd, int32_tevents, void *data, \fBqb_loop_poll_dispatch_fn\fPdispatch_fn)"
  95. .PP
  96. Add a poll job to the mainloop\&. \fBNote:\fP
  97. .RS 4
  98. @@ -258,8 +245,7 @@ status (0 == ok, -errno == failure)
  99. .RE
  100. .PP
  101. -.SS "int32_t qb_loop_poll_del (\fBqb_loop_t\fP *l, int32_tfd)"
  102. -
  103. +.SS "int32_t \fBqb_loop_poll_del\fP (\fBqb_loop_t\fP *l, int32_tfd)"
  104. .PP
  105. Delete a poll job\&. \fBParameters:\fP
  106. .RS 4
  107. @@ -274,8 +260,7 @@ status (0 == ok, -errno == failure)
  108. .RE
  109. .PP
  110. -.SS "int32_t qb_loop_poll_low_fds_event_set (\fBqb_loop_t\fP *l, \fBqb_loop_poll_low_fds_event_fn\fPfn)"
  111. -
  112. +.SS "int32_t \fBqb_loop_poll_low_fds_event_set\fP (\fBqb_loop_t\fP *l, \fBqb_loop_poll_low_fds_event_fn\fPfn)"
  113. .PP
  114. Set a callback to receive events on file descriptors getting low\&. \fBParameters:\fP
  115. .RS 4
  116. @@ -290,8 +275,7 @@ status (0 == ok, -errno == failure)
  117. .RE
  118. .PP
  119. -.SS "int32_t qb_loop_poll_mod (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, int32_tfd, int32_tevents, void *data, \fBqb_loop_poll_dispatch_fn\fPdispatch_fn)"
  120. -
  121. +.SS "int32_t \fBqb_loop_poll_mod\fP (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, int32_tfd, int32_tevents, void *data, \fBqb_loop_poll_dispatch_fn\fPdispatch_fn)"
  122. .PP
  123. Modify a poll job\&. \fBParameters:\fP
  124. .RS 4
  125. @@ -314,8 +298,7 @@ status (0 == ok, -errno == failure)
  126. .RE
  127. .PP
  128. -.SS "void qb_loop_run (\fBqb_loop_t\fP *l)"
  129. -
  130. +.SS "void \fBqb_loop_run\fP (\fBqb_loop_t\fP *l)"
  131. .PP
  132. Run the main loop\&. \fBParameters:\fP
  133. .RS 4
  134. @@ -323,8 +306,7 @@ Run the main loop\&. \fBParameters:\fP
  135. .RE
  136. .PP
  137. -.SS "int32_t qb_loop_signal_add (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, int32_tsig, void *data, \fBqb_loop_signal_dispatch_fn\fPdispatch_fn, \fBqb_loop_signal_handle\fP *handle)"
  138. -
  139. +.SS "int32_t \fBqb_loop_signal_add\fP (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, int32_tsig, void *data, \fBqb_loop_signal_dispatch_fn\fPdispatch_fn, \fBqb_loop_signal_handle\fP *handle)"
  140. .PP
  141. Add a signal job\&. Get a callback on this signal (not in the context of the signal)\&.
  142. .PP
  143. @@ -349,8 +331,7 @@ status (0 == ok, -errno == failure)
  144. .RE
  145. .PP
  146. -.SS "int32_t qb_loop_signal_del (\fBqb_loop_t\fP *l, \fBqb_loop_signal_handle\fPhandle)"
  147. -
  148. +.SS "int32_t \fBqb_loop_signal_del\fP (\fBqb_loop_t\fP *l, \fBqb_loop_signal_handle\fPhandle)"
  149. .PP
  150. Delete the signal job\&. \fBParameters:\fP
  151. .RS 4
  152. @@ -365,8 +346,7 @@ status (0 == ok, -errno == failure)
  153. .RE
  154. .PP
  155. -.SS "int32_t qb_loop_signal_mod (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, int32_tsig, void *data, \fBqb_loop_signal_dispatch_fn\fPdispatch_fn, \fBqb_loop_signal_handle\fPhandle)"
  156. -
  157. +.SS "int32_t \fBqb_loop_signal_mod\fP (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, int32_tsig, void *data, \fBqb_loop_signal_dispatch_fn\fPdispatch_fn, \fBqb_loop_signal_handle\fPhandle)"
  158. .PP
  159. Modify the signal job\&. \fBParameters:\fP
  160. .RS 4
  161. @@ -389,8 +369,7 @@ status (0 == ok, -errno == failure)
  162. .RE
  163. .PP
  164. -.SS "void qb_loop_stop (\fBqb_loop_t\fP *l)"
  165. -
  166. +.SS "void \fBqb_loop_stop\fP (\fBqb_loop_t\fP *l)"
  167. .PP
  168. Stop the main loop\&. \fBParameters:\fP
  169. .RS 4
  170. @@ -398,8 +377,7 @@ Stop the main loop\&. \fBParameters:\fP
  171. .RE
  172. .PP
  173. -.SS "int32_t qb_loop_timer_add (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, uint64_tnsec_duration, void *data, \fBqb_loop_timer_dispatch_fn\fPdispatch_fn, \fBqb_loop_timer_handle\fP *timer_handle_out)"
  174. -
  175. +.SS "int32_t \fBqb_loop_timer_add\fP (\fBqb_loop_t\fP *l, enum \fBqb_loop_priority\fPp, uint64_tnsec_duration, void *data, \fBqb_loop_timer_dispatch_fn\fPdispatch_fn, \fBqb_loop_timer_handle\fP *timer_handle_out)"
  176. .PP
  177. Add a timer to the mainloop\&. \fBNote:\fP
  178. .RS 4
  179. @@ -427,8 +405,7 @@ status (0 == ok, -errno == failure)
  180. .RE
  181. .PP
  182. -.SS "int32_t qb_loop_timer_del (\fBqb_loop_t\fP *l, \fBqb_loop_timer_handle\fPth)"
  183. -
  184. +.SS "int32_t \fBqb_loop_timer_del\fP (\fBqb_loop_t\fP *l, \fBqb_loop_timer_handle\fPth)"
  185. .PP
  186. Delete a timer that is still outstanding\&. \fBParameters:\fP
  187. .RS 4
  188. @@ -443,8 +420,7 @@ status (0 == ok, -errno == failure)
  189. .RE
  190. .PP
  191. -.SS "uint64_t qb_loop_timer_expire_time_get (struct qb_loop *l, \fBqb_loop_timer_handle\fPth)"
  192. -
  193. +.SS "uint64_t \fBqb_loop_timer_expire_time_get\fP (struct qb_loop *l, \fBqb_loop_timer_handle\fPth)"
  194. .PP
  195. Get the time remaining before it expires\&. \fBNote:\fP
  196. .RS 4
  197. @@ -464,8 +440,7 @@ nano seconds left
  198. .RE
  199. .PP
  200. -.SS "int32_t qb_loop_timer_is_running (\fBqb_loop_t\fP *l, \fBqb_loop_timer_handle\fPth)"
  201. -
  202. +.SS "int32_t \fBqb_loop_timer_is_running\fP (\fBqb_loop_t\fP *l, \fBqb_loop_timer_handle\fPth)"
  203. .PP
  204. Check to see if a timer that is still outstanding\&. \fBParameters:\fP
  205. .RS 4