patch-docs_man3_qbipcs_h_3 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
  1. --- libqb-0.16.0.orig/docs/man3/qbipcs.h.3 2013-07-25 20:16:18.000000000 +0200
  2. +++ libqb-0.16.0/docs/man3/qbipcs.h.3 2013-09-09 05:26:31.551809560 +0200
  3. @@ -1,4 +1,4 @@
  4. -.TH "qbipcs.h" 3 "Thu Jul 25 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  5. +.TH "qbipcs.h" 3 "Mon Sep 9 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  6. .ad l
  7. .nh
  8. .SH NAME
  9. @@ -206,8 +206,7 @@ Server IPC API\&.
  10. .SH "Typedef Documentation"
  11. .PP
  12. -.SS "typedef int32_t(* qb_ipcs_connection_accept_fn)(\fBqb_ipcs_connection_t\fP *c, uid_t uid, gid_t gid)"
  13. -
  14. +.SS "typedef int32_t(* \fBqb_ipcs_connection_accept_fn\fP)(\fBqb_ipcs_connection_t\fP *c, uid_t uid, gid_t gid)"
  15. .PP
  16. This callback is to check wether you want to accept a new connection\&. The type of checks you should do are authentication, service availabilty or process resource constraints\&.
  17. .PP
  18. @@ -222,8 +221,7 @@ you can call \fBqb_ipcs_connection_auth_
  19. .RE
  20. .PP
  21. -.SS "typedef int32_t(* qb_ipcs_connection_closed_fn)(\fBqb_ipcs_connection_t\fP *c)"
  22. -
  23. +.SS "typedef int32_t(* \fBqb_ipcs_connection_closed_fn\fP)(\fBqb_ipcs_connection_t\fP *c)"
  24. .PP
  25. This is called after a connection has been disconnected\&. \fBNote:\fP
  26. .RS 4
  27. @@ -231,38 +229,27 @@ if you return anything but 0 this functi
  28. .RE
  29. .PP
  30. -.SS "typedef void(* qb_ipcs_connection_created_fn)(\fBqb_ipcs_connection_t\fP *c)"
  31. -
  32. +.SS "typedef void(* \fBqb_ipcs_connection_created_fn\fP)(\fBqb_ipcs_connection_t\fP *c)"
  33. .PP
  34. This is called after a new connection has been created\&.
  35. -.SS "typedef void(* qb_ipcs_connection_destroyed_fn)(\fBqb_ipcs_connection_t\fP *c)"
  36. -
  37. +.SS "typedef void(* \fBqb_ipcs_connection_destroyed_fn\fP)(\fBqb_ipcs_connection_t\fP *c)"
  38. .PP
  39. This is called just before a connection is freed\&.
  40. .SS "typedef struct qb_ipcs_connection \fBqb_ipcs_connection_t\fP"
  41. -
  42. -.SS "typedef int32_t(* qb_ipcs_dispatch_add_fn)(enum \fBqb_loop_priority\fP p, int32_t fd, int32_t events, void *data, \fBqb_ipcs_dispatch_fn_t\fP fn)"
  43. -
  44. -.SS "typedef int32_t(* qb_ipcs_dispatch_del_fn)(int32_t fd)"
  45. -
  46. -.SS "typedef int32_t(* qb_ipcs_dispatch_fn_t)(int32_t fd, int32_t revents, void *data)"
  47. -
  48. -.SS "typedef int32_t(* qb_ipcs_dispatch_mod_fn)(enum \fBqb_loop_priority\fP p, int32_t fd, int32_t events, void *data, \fBqb_ipcs_dispatch_fn_t\fP fn)"
  49. -
  50. -.SS "typedef int32_t(* qb_ipcs_job_add_fn)(enum \fBqb_loop_priority\fP p, void *data, \fBqb_loop_job_dispatch_fn\fP dispatch_fn)"
  51. -
  52. -.SS "typedef int32_t(* qb_ipcs_msg_process_fn)(\fBqb_ipcs_connection_t\fP *c, void *data, size_t size)"
  53. -
  54. +.SS "typedef int32_t(* \fBqb_ipcs_dispatch_add_fn\fP)(enum \fBqb_loop_priority\fP p, int32_t fd, int32_t events, void *data, \fBqb_ipcs_dispatch_fn_t\fP fn)"
  55. +.SS "typedef int32_t(* \fBqb_ipcs_dispatch_del_fn\fP)(int32_t fd)"
  56. +.SS "typedef int32_t(* \fBqb_ipcs_dispatch_fn_t\fP)(int32_t fd, int32_t revents, void *data)"
  57. +.SS "typedef int32_t(* \fBqb_ipcs_dispatch_mod_fn\fP)(enum \fBqb_loop_priority\fP p, int32_t fd, int32_t events, void *data, \fBqb_ipcs_dispatch_fn_t\fP fn)"
  58. +.SS "typedef int32_t(* \fBqb_ipcs_job_add_fn\fP)(enum \fBqb_loop_priority\fP p, void *data, \fBqb_loop_job_dispatch_fn\fP dispatch_fn)"
  59. +.SS "typedef int32_t(* \fBqb_ipcs_msg_process_fn\fP)(\fBqb_ipcs_connection_t\fP *c, void *data, size_t size)"
  60. .PP
  61. This is the message processing calback\&. It is called with the message data\&.
  62. .SS "typedef struct qb_ipcs_service \fBqb_ipcs_service_t\fP"
  63. -
  64. .SH "Enumeration Type Documentation"
  65. .PP
  66. .SS "enum \fBqb_ipcs_rate_limit\fP"
  67. -
  68. .PP
  69. -\fBEnumerator\fP
  70. +\fBEnumerator: \fP
  71. .in +1c
  72. .TP
  73. \fB\fIQB_IPCS_RATE_FAST \fP\fP
  74. @@ -274,10 +261,10 @@ This is the message processing calback\&
  75. \fB\fIQB_IPCS_RATE_OFF \fP\fP
  76. .TP
  77. \fB\fIQB_IPCS_RATE_OFF_2 \fP\fP
  78. +
  79. .SH "Function Documentation"
  80. .PP
  81. -.SS "void qb_ipcs_connection_auth_set (\fBqb_ipcs_connection_t\fP *conn, uid_tuid, gid_tgid, mode_tmode)"
  82. -
  83. +.SS "void \fBqb_ipcs_connection_auth_set\fP (\fBqb_ipcs_connection_t\fP *conn, uid_tuid, gid_tgid, mode_tmode)"
  84. .PP
  85. Set the permissions on and shared memory files so that both processes can read and write to them\&. \fBParameters:\fP
  86. .RS 4
  87. @@ -290,7 +277,7 @@ Set the permissions on and shared memory
  88. \fImode\fP the mode to set\&.
  89. .RE
  90. .PP
  91. -\fBSee Also:\fP
  92. +\fBSee also:\fP
  93. .RS 4
  94. chmod() chown()
  95. .RE
  96. @@ -301,8 +288,7 @@ this must be called within the \fBqb_ipc
  97. .RE
  98. .PP
  99. -.SS "\fBqb_ipcs_connection_t\fP* qb_ipcs_connection_first_get (\fBqb_ipcs_service_t\fP *pt)"
  100. -
  101. +.SS "\fBqb_ipcs_connection_t\fP* \fBqb_ipcs_connection_first_get\fP (\fBqb_ipcs_service_t\fP *pt)"
  102. .PP
  103. Get the first connection\&. \fBNote:\fP
  104. .RS 4
  105. @@ -320,8 +306,7 @@ first connection
  106. .RE
  107. .PP
  108. -.SS "\fBqb_ipcs_connection_t\fP* qb_ipcs_connection_next_get (\fBqb_ipcs_service_t\fP *pt, \fBqb_ipcs_connection_t\fP *current)"
  109. -
  110. +.SS "\fBqb_ipcs_connection_t\fP* \fBqb_ipcs_connection_next_get\fP (\fBqb_ipcs_service_t\fP *pt, \fBqb_ipcs_connection_t\fP *current)"
  111. .PP
  112. Get the next connection\&. \fBNote:\fP
  113. .RS 4
  114. @@ -341,8 +326,7 @@ next connection
  115. .RE
  116. .PP
  117. -.SS "void qb_ipcs_connection_ref (\fBqb_ipcs_connection_t\fP *c)"
  118. -
  119. +.SS "void \fBqb_ipcs_connection_ref\fP (\fBqb_ipcs_connection_t\fP *c)"
  120. .PP
  121. Increment the connection's reference counter\&. \fBParameters:\fP
  122. .RS 4
  123. @@ -350,8 +334,7 @@ Increment the connection's reference cou
  124. .RE
  125. .PP
  126. -.SS "void* qb_ipcs_connection_service_context_get (\fBqb_ipcs_connection_t\fP *c)"
  127. -
  128. +.SS "void* \fBqb_ipcs_connection_service_context_get\fP (\fBqb_ipcs_connection_t\fP *c)"
  129. .PP
  130. Get the context previously set on the service backing this connection\&. \fBParameters:\fP
  131. .RS 4
  132. @@ -363,14 +346,13 @@ Get the context previously set on the se
  133. the context
  134. .RE
  135. .PP
  136. -\fBSee Also:\fP
  137. +\fBSee also:\fP
  138. .RS 4
  139. \fBqb_ipcs_service_context_set\fP
  140. .RE
  141. .PP
  142. -.SS "int32_t qb_ipcs_connection_stats_get (\fBqb_ipcs_connection_t\fP *c, struct \fBqb_ipcs_connection_stats\fP *stats, int32_tclear_after_read)"
  143. -
  144. +.SS "int32_t \fBqb_ipcs_connection_stats_get\fP (\fBqb_ipcs_connection_t\fP *c, struct \fBqb_ipcs_connection_stats\fP *stats, int32_tclear_after_read)"
  145. .PP
  146. Get the connection statistics\&. \fBDeprecated\fP
  147. .RS 4
  148. @@ -392,8 +374,7 @@ from v0\&.13\&.0 onwards, use qb_ipcs_co
  149. .RE
  150. .PP
  151. -.SS "struct \fBqb_ipcs_connection_stats_2\fP* qb_ipcs_connection_stats_get_2 (\fBqb_ipcs_connection_t\fP *c, int32_tclear_after_read)\fC [read]\fP"
  152. -
  153. +.SS "struct \fBqb_ipcs_connection_stats_2\fP* \fBqb_ipcs_connection_stats_get_2\fP (\fBqb_ipcs_connection_t\fP *c, int32_tclear_after_read)\fC [read]\fP"
  154. .PP
  155. Get (and allocate) the connection statistics\&. \fBParameters:\fP
  156. .RS 4
  157. @@ -410,8 +391,7 @@ Get (and allocate) the connection statis
  158. .RE
  159. .PP
  160. -.SS "void qb_ipcs_connection_unref (\fBqb_ipcs_connection_t\fP *c)"
  161. -
  162. +.SS "void \fBqb_ipcs_connection_unref\fP (\fBqb_ipcs_connection_t\fP *c)"
  163. .PP
  164. Decrement the connection's reference counter\&. \fBParameters:\fP
  165. .RS 4
  166. @@ -419,8 +399,7 @@ Decrement the connection's reference cou
  167. .RE
  168. .PP
  169. -.SS "void* qb_ipcs_context_get (\fBqb_ipcs_connection_t\fP *c)"
  170. -
  171. +.SS "void* \fBqb_ipcs_context_get\fP (\fBqb_ipcs_connection_t\fP *c)"
  172. .PP
  173. Get the context (set previously) \fBParameters:\fP
  174. .RS 4
  175. @@ -432,14 +411,13 @@ Get the context (set previously) \fBPara
  176. the context
  177. .RE
  178. .PP
  179. -\fBSee Also:\fP
  180. +\fBSee also:\fP
  181. .RS 4
  182. \fBqb_ipcs_context_set()\fP
  183. .RE
  184. .PP
  185. -.SS "void qb_ipcs_context_set (\fBqb_ipcs_connection_t\fP *c, void *context)"
  186. -
  187. +.SS "void \fBqb_ipcs_context_set\fP (\fBqb_ipcs_connection_t\fP *c, void *context)"
  188. .PP
  189. Associate a 'user' pointer with this connection\&. \fBParameters:\fP
  190. .RS 4
  191. @@ -448,14 +426,13 @@ Associate a 'user' pointer with this con
  192. \fIc\fP connection instance
  193. .RE
  194. .PP
  195. -\fBSee Also:\fP
  196. +\fBSee also:\fP
  197. .RS 4
  198. \fBqb_ipcs_context_get()\fP
  199. .RE
  200. .PP
  201. -.SS "\fBqb_ipcs_service_t\fP* qb_ipcs_create (const char *name, int32_tservice_id, enum \fBqb_ipc_type\fPtype, struct \fBqb_ipcs_service_handlers\fP *handlers)"
  202. -
  203. +.SS "\fBqb_ipcs_service_t\fP* \fBqb_ipcs_create\fP (const char *name, int32_tservice_id, enum \fBqb_ipc_type\fPtype, struct \fBqb_ipcs_service_handlers\fP *handlers)"
  204. .PP
  205. Create a new IPC server\&. \fBParameters:\fP
  206. .RS 4
  207. @@ -474,8 +451,7 @@ the new service instance\&.
  208. .RE
  209. .PP
  210. -.SS "void qb_ipcs_destroy (\fBqb_ipcs_service_t\fP *s)"
  211. -
  212. +.SS "void \fBqb_ipcs_destroy\fP (\fBqb_ipcs_service_t\fP *s)"
  213. .PP
  214. Destroy the IPC server\&. \fBParameters:\fP
  215. .RS 4
  216. @@ -483,8 +459,7 @@ Destroy the IPC server\&. \fBParameters:
  217. .RE
  218. .PP
  219. -.SS "void qb_ipcs_disconnect (\fBqb_ipcs_connection_t\fP *c)"
  220. -
  221. +.SS "void \fBqb_ipcs_disconnect\fP (\fBqb_ipcs_connection_t\fP *c)"
  222. .PP
  223. Disconnect from this client\&. \fBParameters:\fP
  224. .RS 4
  225. @@ -492,8 +467,7 @@ Disconnect from this client\&. \fBParame
  226. .RE
  227. .PP
  228. -.SS "ssize_t qb_ipcs_event_send (\fBqb_ipcs_connection_t\fP *c, const void *data, size_tsize)"
  229. -
  230. +.SS "ssize_t \fBqb_ipcs_event_send\fP (\fBqb_ipcs_connection_t\fP *c, const void *data, size_tsize)"
  231. .PP
  232. Send an asyncronous event message to the client\&. \fBParameters:\fP
  233. .RS 4
  234. @@ -515,8 +489,7 @@ the data must include a \fBqb_ipc_respon
  235. .RE
  236. .PP
  237. -.SS "ssize_t qb_ipcs_event_sendv (\fBqb_ipcs_connection_t\fP *c, const struct iovec *iov, size_tiov_len)"
  238. -
  239. +.SS "ssize_t \fBqb_ipcs_event_sendv\fP (\fBqb_ipcs_connection_t\fP *c, const struct iovec *iov, size_tiov_len)"
  240. .PP
  241. Send an asyncronous event message to the client\&. \fBParameters:\fP
  242. .RS 4
  243. @@ -538,8 +511,7 @@ the iov[0] must be a \fBqb_ipc_response_
  244. .RE
  245. .PP
  246. -.SS "void qb_ipcs_poll_handlers_set (\fBqb_ipcs_service_t\fP *s, struct \fBqb_ipcs_poll_handlers\fP *handlers)"
  247. -
  248. +.SS "void \fBqb_ipcs_poll_handlers_set\fP (\fBqb_ipcs_service_t\fP *s, struct \fBqb_ipcs_poll_handlers\fP *handlers)"
  249. .PP
  250. Set your poll callbacks\&. \fBParameters:\fP
  251. .RS 4
  252. @@ -549,8 +521,7 @@ Set your poll callbacks\&. \fBParameters
  253. .RE
  254. .PP
  255. -.SS "void qb_ipcs_ref (\fBqb_ipcs_service_t\fP *s)"
  256. -
  257. +.SS "void \fBqb_ipcs_ref\fP (\fBqb_ipcs_service_t\fP *s)"
  258. .PP
  259. Increase the reference counter on the service object\&. \fBParameters:\fP
  260. .RS 4
  261. @@ -558,8 +529,7 @@ Increase the reference counter on the se
  262. .RE
  263. .PP
  264. -.SS "void qb_ipcs_request_rate_limit (\fBqb_ipcs_service_t\fP *s, enum \fBqb_ipcs_rate_limit\fPrl)"
  265. -
  266. +.SS "void \fBqb_ipcs_request_rate_limit\fP (\fBqb_ipcs_service_t\fP *s, enum \fBqb_ipcs_rate_limit\fPrl)"
  267. .PP
  268. Limit the incomming request rate\&. \fBParameters:\fP
  269. .RS 4
  270. @@ -569,8 +539,7 @@ Limit the incomming request rate\&. \fBP
  271. .RE
  272. .PP
  273. -.SS "ssize_t qb_ipcs_response_send (\fBqb_ipcs_connection_t\fP *c, const void *data, size_tsize)"
  274. -
  275. +.SS "ssize_t \fBqb_ipcs_response_send\fP (\fBqb_ipcs_connection_t\fP *c, const void *data, size_tsize)"
  276. .PP
  277. Send a response to a incomming request\&. \fBParameters:\fP
  278. .RS 4
  279. @@ -592,8 +561,7 @@ the data must include a \fBqb_ipc_respon
  280. .RE
  281. .PP
  282. -.SS "ssize_t qb_ipcs_response_sendv (\fBqb_ipcs_connection_t\fP *c, const struct iovec *iov, size_tiov_len)"
  283. -
  284. +.SS "ssize_t \fBqb_ipcs_response_sendv\fP (\fBqb_ipcs_connection_t\fP *c, const struct iovec *iov, size_tiov_len)"
  285. .PP
  286. Send a response to a incomming request\&. \fBParameters:\fP
  287. .RS 4
  288. @@ -615,8 +583,7 @@ the iov[0] must be a \fBqb_ipc_response_
  289. .RE
  290. .PP
  291. -.SS "int32_t qb_ipcs_run (\fBqb_ipcs_service_t\fP *s)"
  292. -
  293. +.SS "int32_t \fBqb_ipcs_run\fP (\fBqb_ipcs_service_t\fP *s)"
  294. .PP
  295. run the new IPC server\&. \fBParameters:\fP
  296. .RS 4
  297. @@ -629,8 +596,7 @@ run the new IPC server\&. \fBParameters:
  298. .RE
  299. .PP
  300. -.SS "void* qb_ipcs_service_context_get (\fBqb_ipcs_service_t\fP *s)"
  301. -
  302. +.SS "void* \fBqb_ipcs_service_context_get\fP (\fBqb_ipcs_service_t\fP *s)"
  303. .PP
  304. Get the context (set previously) \fBParameters:\fP
  305. .RS 4
  306. @@ -642,14 +608,13 @@ Get the context (set previously) \fBPara
  307. the context
  308. .RE
  309. .PP
  310. -\fBSee Also:\fP
  311. +\fBSee also:\fP
  312. .RS 4
  313. \fBqb_ipcs_service_context_set()\fP
  314. .RE
  315. .PP
  316. -.SS "void qb_ipcs_service_context_set (\fBqb_ipcs_service_t\fP *s, void *context)"
  317. -
  318. +.SS "void \fBqb_ipcs_service_context_set\fP (\fBqb_ipcs_service_t\fP *s, void *context)"
  319. .PP
  320. Associate a 'user' pointer with this service\&. \fBParameters:\fP
  321. .RS 4
  322. @@ -658,14 +623,13 @@ Associate a 'user' pointer with this ser
  323. \fIcontext\fP the pointer to associate with this service\&.
  324. .RE
  325. .PP
  326. -\fBSee Also:\fP
  327. +\fBSee also:\fP
  328. .RS 4
  329. \fBqb_ipcs_service_context_get()\fP
  330. .RE
  331. .PP
  332. -.SS "int32_t qb_ipcs_service_id_get (\fBqb_ipcs_connection_t\fP *c)"
  333. -
  334. +.SS "int32_t \fBqb_ipcs_service_id_get\fP (\fBqb_ipcs_connection_t\fP *c)"
  335. .PP
  336. Get the service id related to this connection's service\&. (as passed into \fBqb_ipcs_create()\fP
  337. .PP
  338. @@ -675,8 +639,7 @@ service id\&.
  339. .RE
  340. .PP
  341. -.SS "int32_t qb_ipcs_stats_get (\fBqb_ipcs_service_t\fP *pt, struct \fBqb_ipcs_stats\fP *stats, int32_tclear_after_read)"
  342. -
  343. +.SS "int32_t \fBqb_ipcs_stats_get\fP (\fBqb_ipcs_service_t\fP *pt, struct \fBqb_ipcs_stats\fP *stats, int32_tclear_after_read)"
  344. .PP
  345. Get the service statistics\&. \fBParameters:\fP
  346. .RS 4
  347. @@ -693,8 +656,7 @@ Get the service statistics\&. \fBParamet
  348. .RE
  349. .PP
  350. -.SS "void qb_ipcs_unref (\fBqb_ipcs_service_t\fP *s)"
  351. -
  352. +.SS "void \fBqb_ipcs_unref\fP (\fBqb_ipcs_service_t\fP *s)"
  353. .PP
  354. Decrease the reference counter on the service object\&. \fBParameters:\fP
  355. .RS 4