patch-docs_man3_qbipcc_h_3 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. --- libqb-0.16.0.orig/docs/man3/qbipcc.h.3 2013-07-25 20:16:18.000000000 +0200
  2. +++ libqb-0.16.0/docs/man3/qbipcc.h.3 2013-09-09 05:26:31.487810365 +0200
  3. @@ -1,4 +1,4 @@
  4. -.TH "qbipcc.h" 3 "Thu Jul 25 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  5. +.TH "qbipcc.h" 3 "Mon Sep 9 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  6. .ad l
  7. .nh
  8. .SH NAME
  9. @@ -113,11 +113,9 @@ The \fBqb_ipcc_event_recv()\fP function
  10. .SH "Typedef Documentation"
  11. .PP
  12. .SS "typedef struct qb_ipcc_connection \fBqb_ipcc_connection_t\fP"
  13. -
  14. .SH "Function Documentation"
  15. .PP
  16. -.SS "\fBqb_ipcc_connection_t\fP* qb_ipcc_connect (const char *name, size_tmax_msg_size)"
  17. -
  18. +.SS "\fBqb_ipcc_connection_t\fP* \fBqb_ipcc_connect\fP (const char *name, size_tmax_msg_size)"
  19. .PP
  20. Create a connection to an IPC service\&. \fBParameters:\fP
  21. .RS 4
  22. @@ -133,12 +131,11 @@ NULL (error: see errno) or a connection
  23. .PP
  24. \fBNote:\fP
  25. .RS 4
  26. -It is recommended to do a one time check on the max_msg_size value using qb_ipcc_verify_dgram_max_msg_size \fIBEFORE\fP calling the connect function when IPC_SOCKET is in use\&. Some distributions while allow large message buffers to be set on the socket, but not actually honor them because of kernel state values\&. The qb_ipcc_verify_dgram_max_msg_size function both sets the socket buffer size and verifies it by doing a send/recv\&.
  27. +It is recommended to do a one time check on the max_msg_size value using qb_ipcc_verify_dgram_max_msg_size _BEFORE_ calling the connect function when IPC_SOCKET is in use\&. Some distributions while allow large message buffers to be set on the socket, but not actually honor them because of kernel state values\&. The qb_ipcc_verify_dgram_max_msg_size function both sets the socket buffer size and verifies it by doing a send/recv\&.
  28. .RE
  29. .PP
  30. -.SS "void* qb_ipcc_context_get (\fBqb_ipcc_connection_t\fP *c)"
  31. -
  32. +.SS "void* \fBqb_ipcc_context_get\fP (\fBqb_ipcc_connection_t\fP *c)"
  33. .PP
  34. Get the context (set previously) \fBParameters:\fP
  35. .RS 4
  36. @@ -150,14 +147,13 @@ Get the context (set previously) \fBPara
  37. the context
  38. .RE
  39. .PP
  40. -\fBSee Also:\fP
  41. +\fBSee also:\fP
  42. .RS 4
  43. \fBqb_ipcc_context_set()\fP
  44. .RE
  45. .PP
  46. -.SS "void qb_ipcc_context_set (\fBqb_ipcc_connection_t\fP *c, void *context)"
  47. -
  48. +.SS "void \fBqb_ipcc_context_set\fP (\fBqb_ipcc_connection_t\fP *c, void *context)"
  49. .PP
  50. Associate a 'user' pointer with this connection\&. \fBParameters:\fP
  51. .RS 4
  52. @@ -166,14 +162,13 @@ Associate a 'user' pointer with this con
  53. \fIc\fP connection instance
  54. .RE
  55. .PP
  56. -\fBSee Also:\fP
  57. +\fBSee also:\fP
  58. .RS 4
  59. \fBqb_ipcc_context_get()\fP
  60. .RE
  61. .PP
  62. -.SS "void qb_ipcc_disconnect (\fBqb_ipcc_connection_t\fP *c)"
  63. -
  64. +.SS "void \fBqb_ipcc_disconnect\fP (\fBqb_ipcc_connection_t\fP *c)"
  65. .PP
  66. Disconnect an IPC connection\&. \fBParameters:\fP
  67. .RS 4
  68. @@ -181,8 +176,7 @@ Disconnect an IPC connection\&. \fBParam
  69. .RE
  70. .PP
  71. -.SS "ssize_t qb_ipcc_event_recv (\fBqb_ipcc_connection_t\fP *c, void *msg_ptr, size_tmsg_len, int32_tms_timeout)"
  72. -
  73. +.SS "ssize_t \fBqb_ipcc_event_recv\fP (\fBqb_ipcc_connection_t\fP *c, void *msg_ptr, size_tmsg_len, int32_tms_timeout)"
  74. .PP
  75. Receive an event\&. \fBParameters:\fP
  76. .RS 4
  77. @@ -208,8 +202,7 @@ that msg_ptr will include a \fBqb_ipc_re
  78. .RE
  79. .PP
  80. -.SS "int32_t qb_ipcc_fc_enable_max_set (\fBqb_ipcc_connection_t\fP *c, uint32_tmax)"
  81. -
  82. +.SS "int32_t \fBqb_ipcc_fc_enable_max_set\fP (\fBqb_ipcc_connection_t\fP *c, uint32_tmax)"
  83. .PP
  84. Set the maximum allowable flowcontrol value\&. \fBNote:\fP
  85. .RS 4
  86. @@ -224,8 +217,7 @@ the default is 1
  87. .RE
  88. .PP
  89. -.SS "int32_t qb_ipcc_fd_get (\fBqb_ipcc_connection_t\fP *c, int32_t *fd)"
  90. -
  91. +.SS "int32_t \fBqb_ipcc_fd_get\fP (\fBqb_ipcc_connection_t\fP *c, int32_t *fd)"
  92. .PP
  93. Get the file descriptor to poll\&. \fBParameters:\fP
  94. .RS 4
  95. @@ -235,8 +227,7 @@ Get the file descriptor to poll\&. \fBPa
  96. .RE
  97. .PP
  98. -.SS "int32_t qb_ipcc_is_connected (\fBqb_ipcc_connection_t\fP *c)"
  99. -
  100. +.SS "int32_t \fBqb_ipcc_is_connected\fP (\fBqb_ipcc_connection_t\fP *c)"
  101. .PP
  102. Is the connection connected? \fBParameters:\fP
  103. .RS 4
  104. @@ -251,8 +242,7 @@ Is the connection connected? \fBParamete
  105. .RE
  106. .PP
  107. -.SS "ssize_t qb_ipcc_recv (\fBqb_ipcc_connection_t\fP *c, void *msg_ptr, size_tmsg_len, int32_tms_timeout)"
  108. -
  109. +.SS "ssize_t \fBqb_ipcc_recv\fP (\fBqb_ipcc_connection_t\fP *c, void *msg_ptr, size_tmsg_len, int32_tms_timeout)"
  110. .PP
  111. Receive a response\&. \fBParameters:\fP
  112. .RS 4
  113. @@ -276,8 +266,7 @@ that msg_ptr will include a \fBqb_ipc_re
  114. .RE
  115. .PP
  116. -.SS "ssize_t qb_ipcc_send (\fBqb_ipcc_connection_t\fP *c, const void *msg_ptr, size_tmsg_len)"
  117. -
  118. +.SS "ssize_t \fBqb_ipcc_send\fP (\fBqb_ipcc_connection_t\fP *c, const void *msg_ptr, size_tmsg_len)"
  119. .PP
  120. Send a message\&. \fBParameters:\fP
  121. .RS 4
  122. @@ -299,8 +288,7 @@ the msg_ptr must include a \fBqb_ipc_req
  123. .RE
  124. .PP
  125. -.SS "ssize_t qb_ipcc_sendv (\fBqb_ipcc_connection_t\fP *c, const struct iovec *iov, size_tiov_len)"
  126. -
  127. +.SS "ssize_t \fBqb_ipcc_sendv\fP (\fBqb_ipcc_connection_t\fP *c, const struct iovec *iov, size_tiov_len)"
  128. .PP
  129. Send a message (iovec)\&. \fBParameters:\fP
  130. .RS 4
  131. @@ -322,8 +310,7 @@ the iov[0] must be a \fBqb_ipc_request_h
  132. .RE
  133. .PP
  134. -.SS "ssize_t qb_ipcc_sendv_recv (\fBqb_ipcc_connection_t\fP *c, const struct iovec *iov, uint32_tiov_len, void *msg_ptr, size_tmsg_len, int32_tms_timeout)"
  135. -
  136. +.SS "ssize_t \fBqb_ipcc_sendv_recv\fP (\fBqb_ipcc_connection_t\fP *c, const struct iovec *iov, uint32_tiov_len, void *msg_ptr, size_tmsg_len, int32_tms_timeout)"
  137. .PP
  138. This is a convenience function that simply sends and then recvs\&. \fBParameters:\fP
  139. .RS 4
  140. @@ -347,14 +334,13 @@ the iov[0] must include a \fBqb_ipc_requ
  141. that msg_ptr will include a \fBqb_ipc_response_header\fP at the top of the message\&.
  142. .RE
  143. .PP
  144. -\fBSee Also:\fP
  145. +\fBSee also:\fP
  146. .RS 4
  147. \fBqb_ipcc_sendv()\fP \fBqb_ipcc_recv()\fP
  148. .RE
  149. .PP
  150. -.SS "int32_t qb_ipcc_verify_dgram_max_msg_size (size_tmax_msg_size)"
  151. -
  152. +.SS "int32_t \fBqb_ipcc_verify_dgram_max_msg_size\fP (size_tmax_msg_size)"
  153. .PP
  154. Test kernel dgram socket buffers to verify the largest size up to the max_msg_size value a single msg can be\&. Rounds down to the nearest 1k\&.
  155. .PP