Skip to content

Commit 0266c16

Browse files
committed
further docs cleanups
1 parent a195723 commit 0266c16

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

NEWS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
#### Updates
99

10-
* Unified synchronous `send()` and `recv()` functions, and their asynchronous counterparts `send_aio()` and `recv_aio()`, are now S3 generics and can be used across Sockets, Contexts and Streams.
11-
* Revised 'block' argument for synchronous `send()` and `recv()` allows setting a timeout for all methods.
10+
* Unified `send()` and `recv()` functions, and their asynchronous counterparts `send_aio()` and `recv_aio()`, are now S3 generics and can be used across Sockets, Contexts and Streams.
11+
* Revised 'block' argument for `send()` and `recv()` now allows an integer value for setting a timeout.
1212
* `send_ctx()` and `recv_ctx()` are deprecated and will be removed in a future package version - the methods for `send()` and `recv()` should be used instead.
1313

1414
# nanonext 0.3.0

R/sendrecv.R

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,14 +136,18 @@ send.nanoStream <- function(con,
136136
#'
137137
#' Receive data over a connection (Socket, Context or Stream).
138138
#'
139-
#' @inheritParams send
139+
#' @param con a Socket, Context or Stream.
140140
#' @param mode <Sockets and Contexts> [default 'serial'] mode of vector to be
141141
#' received - one of 'serial', 'character', 'complex', 'double', 'integer',
142142
#' 'logical', 'numeric', or 'raw'. The default 'serial' means a serialised
143143
#' R object, for the other modes, the raw vector received will be converted
144144
#' into the respective mode.
145145
#' <Streams> [default 'character'] note that 'serial' is not an option for
146146
#' Streams.
147+
#' @param block logical TRUE to block until successful or FALSE to return
148+
#' immediately even if unsuccessful (e.g. if no messages are available),
149+
#' or else an integer value specifying the maximum time to block in
150+
#' milliseconds, after which the operation will time out.
147151
#' @param keep.raw [default TRUE] logical flag whether to keep the received raw
148152
#' vector (useful for verification e.g. via hashing). If FALSE, will return
149153
#' the converted data only.

man/recv.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)