Skip to content

Commit a195723

Browse files
committed
docs corrections
1 parent d0bcc2c commit a195723

File tree

3 files changed

+22
-30
lines changed

3 files changed

+22
-30
lines changed

R/sendrecv.R

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,14 @@
2626
#'
2727
#' For Sockets: the default behaviour is non-blocking with \code{block = FALSE}.
2828
#' 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.
3031
#'
3132
#' 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.
3837
#'
3938
#' @examples
4039
#' pub <- socket("pub", dial = "inproc://nanonext")
@@ -168,16 +167,13 @@ send.nanoStream <- function(con,
168167
#' @section Blocking:
169168
#'
170169
#' 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.
173171
#'
174172
#' 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.
181177
#'
182178
#' @examples
183179
#' s1 <- socket("bus", listen = "inproc://nanonext")

man/recv.Rd

Lines changed: 5 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/send.Rd

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)