|
26 | 26 | #' |
27 | 27 | #' For Sockets: the default behaviour is non-blocking with \code{block = FALSE}. |
28 | 28 | #' This will return immediately with an error if the message could not be |
29 | | -#' queued for sending. |
| 29 | +#' queued for sending. Certain protocol / transport combinations may limit |
| 30 | +#' the number of messages that can be queued if they have yet to be received. |
30 | 31 | #' |
31 | 32 | #' For Contexts and Streams: the default behaviour is blocking with \code{block = TRUE}. |
32 | | -#' This will wait until the send has completed. For Contexts, certain protocol / |
33 | | -#' transport combinations may limit the number of messages that can be queued |
34 | | -#' if they have yet to be received. Set a timeout in this case to ensure that |
35 | | -#' the function returns under all scenarios. As the underlying implementation |
36 | | -#' differs to that for Sockets, it is recommended to set a positive integer |
37 | | -#' value for \code{block} rather than FALSE. |
| 33 | +#' This will wait until the send has completed. Set a timeout in this case |
| 34 | +#' to ensure that the function returns under all scenarios. As the underlying |
| 35 | +#' implementation differs to that for Sockets, it is recommended to set a |
| 36 | +#' positive integer value for \code{block} rather than FALSE. |
38 | 37 | #' |
39 | 38 | #' @examples |
40 | 39 | #' pub <- socket("pub", dial = "inproc://nanonext") |
@@ -168,16 +167,13 @@ send.nanoStream <- function(con, |
168 | 167 | #' @section Blocking: |
169 | 168 | #' |
170 | 169 | #' For Sockets: the default behaviour is non-blocking with \code{block = FALSE}. |
171 | | -#' This will return immediately with an error if the message could not be |
172 | | -#' queued for sending. |
| 170 | +#' This will return immediately with an error if no messages are available. |
173 | 171 | #' |
174 | 172 | #' For Contexts and Streams: the default behaviour is blocking with \code{block = TRUE}. |
175 | | -#' This will wait until the send has completed. For Contexts, certain protocol / |
176 | | -#' transport combinations may limit the number of messages that can be queued |
177 | | -#' if they have yet to be received. Set a timeout in this case to ensure that |
178 | | -#' the function returns under all scenarios. As the underlying implementation |
179 | | -#' differs to that for Sockets, it is recommended to set a positive integer |
180 | | -#' value for \code{block} rather than FALSE. |
| 173 | +#' This will wait until a message is received. Set a timeout in this case to |
| 174 | +#' ensure that the function returns under all scenarios. As the underlying |
| 175 | +#' implementation differs to that for Sockets, it is recommended to set a |
| 176 | +#' positive integer value for \code{block} rather than FALSE. |
181 | 177 | #' |
182 | 178 | #' @examples |
183 | 179 | #' s1 <- socket("bus", listen = "inproc://nanonext") |
|
0 commit comments