nanonext (version 0.5.1)

send: Send

Description

Send data over a connection (Socket, Context or Stream).

Usage

send(con, data, mode = c("serial", "raw"), block, echo = TRUE)
# S3 method for nanoSocket
send(con, data, mode = c("serial", "raw"), block = FALSE, echo = TRUE)
# S3 method for nanoContext
send(con, data, mode = c("serial", "raw"), block = TRUE, echo = TRUE)
# S3 method for nanoStream
send(con, data, mode = "raw", block = TRUE, echo = TRUE)

Arguments

con

a Socket, Context or Stream.

data

an object (a vector, if mode = 'raw').

mode

[default 'serial'] for sending serialised R objects, or 'raw' for sending vectors of any type (converted to a raw byte vector for sending). For Streams, 'raw' is the only option and any other value is ignored. Use 'serial' for perfect reproducibility within R, although 'raw' must be used when interfacing with external applications that do not understand R serialisation.

block

logical TRUE to block until successful or FALSE to return immediately even if unsuccessful (e.g. if no connection is available), or else an integer value specifying the maximum time to block in milliseconds, after which the operation will time out.

echo

[default TRUE] logical TRUE to return the raw vector of sent data, or FALSE to return an integer exit code (invisibly).

Value

Raw vector of sent data, or (invisibly) an integer exit code (zero on success) if 'echo' is set to FALSE.

Blocking

For Sockets: the default behaviour is non-blocking with block = FALSE. This will return immediately with an error if the message could not be queued for sending. Certain protocol / transport combinations may limit the number of messages that can be queued if they have yet to be received.

For Contexts and Streams: the default behaviour is blocking with block = TRUE. This will wait until the send has completed. Set a timeout in this case to ensure that the function returns under all scenarios. As the underlying implementation uses an asynchronous send with a wait, it is recommended to set a positive integer value for block rather than FALSE.

Examples

# NOT RUN {
pub <- socket("pub", dial = "inproc://nanonext")

send(pub, data.frame(a = 1, b = 2))
send(pub, c(10.1, 20.2, 30.3), mode = "raw", block = 100)

close(pub)

req <- socket("req", listen = "inproc://nanonext")
rep <- socket("rep", dial = "inproc://nanonext")

ctx <- context(req)
send(ctx, data.frame(a = 1, b = 2), block = 100)

msg <- recv_aio(rep, timeout = 100)
send(ctx, c(1.1, 2.2, 3.3), mode = "raw", block = 100)

close(req)
close(rep)

# }