Skip to content

Commit ebacbc1

Browse files
shikokuchuoshikokuchuo
committed
complete and document warnings interface
1 parent e78fb8a commit ebacbc1

File tree

11 files changed

+45
-29
lines changed

11 files changed

+45
-29
lines changed

‎NEWS.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@
88

99
#### Updates
1010

11+
* Behavioural change: messages have been upgraded to warnings across the package to allow for enhanced reporting of the originating call e.g. via `warnings()`. Note that warnings are only printed when execution returns to the top level, e.g. at the end of a function or loop. If timely printing to stderr is required e.g. for logging, that should be written into your error handler within the function/loop etc.
1112
* 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.
1213
* Revised 'block' argument for `send()` and `recv()` now allows an integer value for setting a timeout.
1314
* `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.
14-
* Returned NNG error codes are now all classed 'errorValue' and messages have been upgraded to warnings across the package to allow enhanced reporting of the originating call e.g. via `warnings()`. Timestamps have been removed in a trade-off for better performance.
15-
* Logging is deprecated and in the process of being phased out. Logging can still be set via 'NANONEXT_LOG' prior to package load but `logging()` can no longer be used. Logging will be removed entirely in a future package version.
15+
* To allow for more flexible practices, logging is now deprecated and being phased out. Logging can still be set via 'NANONEXT_LOG' prior to package load but `logging()` can no longer be used. Logging will be removed entirely in a future package version.
16+
* Returned NNG error codes are now all classed as 'errorValue' across the package.
1617

1718
# nanonext 0.3.0
1819

‎R/aio.R‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ recv_aio.nanoStream <- function(con,
433433
#'
434434
#' @param aio An Aio (object of class 'sendAio' or 'recvAio').
435435
#'
436-
#' @return The passed Aio object (invisibly).
436+
#' @return The passed object (invisibly).
437437
#'
438438
#' @details For a 'recvAio', the received raw vector may be retrieved at \code{$raw}
439439
#' (unless 'keep.raw' was set to FALSE when receiving), and the converted R
@@ -452,6 +452,9 @@ recv_aio.nanoStream <- function(con,
452452
#' Once the value has been successfully retrieved, the Aio is deallocated
453453
#' and only the value is stored in the Aio object.
454454
#'
455+
#' Note this function operates silently and does not error even if 'aio' is
456+
#' not an active Aio, always returning invisibly the passed object.
457+
#'
455458
#' @section Alternatively:
456459
#'
457460
#' Aio values may be accessed directly at \code{$result} for a 'sendAio',
@@ -500,6 +503,9 @@ call_aio <- function(aio) {
500503
#' The Aio is then deallocated and no further operations may be performed on
501504
#' it.
502505
#'
506+
#' Note this function operates silently and does not error even if 'aio' is
507+
#' not an active Aio, always returning invisible NULL.
508+
#'
503509
#' @export
504510
#'
505511
stop_aio <- function(aio) {

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ aio
370370
#> < recvAio >
371371
#> - $data for message data
372372
aio$data |> str()
373-
#> num [1:100000000] -0.17 -0.573 1.068 0.363 -0.864 ...
373+
#> num [1:100000000] -0.526 1.488 1.712 0.296 -0.703 ...
374374
```
375375

376376
As `call_aio()` is blocking and will wait for completion, an alternative
@@ -407,7 +407,7 @@ sub |> recv(mode = "character", keep.raw = FALSE)
407407

408408
pub |> send(c("other", "this other topic will not be received"), mode = "raw", echo = FALSE)
409409
sub |> recv(mode = "character", keep.raw = FALSE)
410-
#> Warning in recv.nanoSocket(sub, mode = "character", keep.raw = FALSE): [ 8 ] Try
410+
#> Warning in recv.nanoSocket(sub, mode = "character", keep.raw = FALSE): 8 | Try
411411
#> again
412412

413413
# specify NULL to subscribe to ALL topics
@@ -419,7 +419,7 @@ sub |> recv("character", keep.raw = FALSE)
419419
sub |> unsubscribe(topic = NULL)
420420
pub |> send(c("newTopic", "this topic will now not be received"), mode = "raw", echo = FALSE)
421421
sub |> recv("character", keep.raw = FALSE)
422-
#> Warning in recv.nanoSocket(sub, "character", keep.raw = FALSE): [ 8 ] Try again
422+
#> Warning in recv.nanoSocket(sub, "character", keep.raw = FALSE): 8 | Try again
423423

424424
# however the topics explicitly subscribed to are still received
425425
pub |> send(c("examples", "this example will still be received"), mode = "raw", echo = FALSE)
@@ -475,7 +475,7 @@ aio2$data
475475
# after the survey expires, the second resolves into a timeout error
476476
Sys.sleep(0.5)
477477
aio2$data
478-
#> Warning in (function (x) : [ 5 ] Timed out
478+
#> Warning in (function (x) : 5 | Timed out
479479
#> 'errorValue' int 5
480480

481481
close(sur)
@@ -505,11 +505,11 @@ ncurl("http://httpbin.org/headers")
505505
#> [1] 7b 0a 20 20 22 68 65 61 64 65 72 73 22 3a 20 7b 0a 20 20 20 20 22 48 6f 73
506506
#> [26] 74 22 3a 20 22 68 74 74 70 62 69 6e 2e 6f 72 67 22 2c 20 0a 20 20 20 20 22
507507
#> [51] 58 2d 41 6d 7a 6e 2d 54 72 61 63 65 2d 49 64 22 3a 20 22 52 6f 6f 74 3d 31
508-
#> [76] 2d 36 32 34 63 62 66 66 38 2d 34 38 37 35 38 64 65 30 31 36 61 62 38 31 62
509-
#> [101] 34 36 38 39 31 32 66 37 61 22 0a 20 20 7d 0a 7d 0a
508+
#> [76] 2d 36 32 34 64 36 33 32 33 2d 35 65 30 62 33 30 34 66 37 38 65 39 35 38 35
509+
#> [101] 34 36 33 37 63 62 31 66 30 22 0a 20 20 7d 0a 7d 0a
510510
#>
511511
#> $data
512-
#> [1] "{\n \"headers\": {\n \"Host\": \"httpbin.org\", \n \"X-Amzn-Trace-Id\": \"Root=1-624cbff8-48758de016ab81b468912f7a\"\n }\n}\n"
512+
#> [1] "{\n \"headers\": {\n \"Host\": \"httpbin.org\", \n \"X-Amzn-Trace-Id\": \"Root=1-624d6323-5e0b304f78e95854637cb1f0\"\n }\n}\n"
513513
```
514514

515515
For advanced use, supports additional HTTP methods such as POST or PUT.
@@ -524,7 +524,7 @@ res
524524
#> - $raw for raw message
525525

526526
call_aio(res)$data
527-
#> [1] "{\n \"args\": {}, \n \"data\": \"{\\\"key\\\": \\\"value\\\"}\", \n \"files\": {}, \n \"form\": {}, \n \"headers\": {\n \"Authorization\": \"Bearer APIKEY\", \n \"Content-Length\": \"16\", \n \"Content-Type\": \"application/json\", \n \"Host\": \"httpbin.org\", \n \"X-Amzn-Trace-Id\": \"Root=1-624cbff8-6717d2692cf3ae776109d3c9\"\n }, \n \"json\": {\n \"key\": \"value\"\n }, \n \"origin\": \"79.173.189.204\", \n \"url\": \"http://httpbin.org/post\"\n}\n"
527+
#> [1] "{\n \"args\": {}, \n \"data\": \"{\\\"key\\\": \\\"value\\\"}\", \n \"files\": {}, \n \"form\": {}, \n \"headers\": {\n \"Authorization\": \"Bearer APIKEY\", \n \"Content-Length\": \"16\", \n \"Content-Type\": \"application/json\", \n \"Host\": \"httpbin.org\", \n \"X-Amzn-Trace-Id\": \"Root=1-624d6323-7d89bacc230330e3541fdb6a\"\n }, \n \"json\": {\n \"key\": \"value\"\n }, \n \"origin\": \"79.173.189.204\", \n \"url\": \"http://httpbin.org/post\"\n}\n"
528528
```
529529

530530
In this respect, it may be used as a performant and lightweight method

‎man/call_aio.Rd‎

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

‎man/stop_aio.Rd‎

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

‎src/aio.c‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ static SEXP mk_error(const int xc) {
3737

3838
SEXP err = PROTECT(Rf_ScalarInteger(xc));
3939
Rf_classgets(err, Rf_mkString("errorValue"));
40-
Rf_warning("[ %d ] %s", xc, nng_strerror(xc));
40+
Rf_warning("%d | %s", xc, nng_strerror(xc));
4141
UNPROTECT(1);
4242
return err;
4343

@@ -550,11 +550,11 @@ SEXP rnng_aio_call(SEXP aio) {
550550
SEXP rnng_aio_stop(SEXP aio) {
551551

552552
if (TYPEOF(aio) != ENVSXP)
553-
error_return("object is not an active Aio");
553+
return R_NilValue;
554554

555555
SEXP coreaio = Rf_findVarInFrame(aio, nano_AioSymbol);
556556
if (R_ExternalPtrTag(coreaio) != nano_AioSymbol || R_ExternalPtrAddr(coreaio) == NULL)
557-
error_return("object is not an active Aio");
557+
return R_NilValue;
558558

559559
nano_aio *aiop = (nano_aio *) R_ExternalPtrAddr(coreaio);
560560
nng_aio_stop(aiop->aio);
@@ -786,9 +786,9 @@ SEXP rnng_ncurl_aio(SEXP http, SEXP method, SEXP headers, SEXP data) {
786786
SEXP rnng_aio_http(SEXP aio) {
787787

788788
if (R_ExternalPtrTag(aio) != nano_AioSymbol)
789-
errorcall_return(R_NilValue, "object is not a valid Aio");
789+
error_return("object is not a valid Aio");
790790
if (R_ExternalPtrAddr(aio) == NULL)
791-
errorcall_return(R_NilValue, "object is not an active Aio");
791+
error_return("object is not an active Aio");
792792

793793
uint8_t resolv;
794794
nano_aio *haio = (nano_aio *) R_ExternalPtrAddr(aio);

‎src/core.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ static SEXP mk_error(const int xc) {
99

1010
SEXP err = PROTECT(Rf_ScalarInteger(xc));
1111
Rf_classgets(err, Rf_mkString("errorValue"));
12-
Rf_warning("[ %d ] %s", xc, nng_strerror(xc));
12+
Rf_warning("%d | %s", xc, nng_strerror(xc));
1313
UNPROTECT(1);
1414
return err;
1515

‎src/opts.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ static SEXP mk_error(const int xc) {
99

1010
SEXP err = PROTECT(Rf_ScalarInteger(xc));
1111
Rf_classgets(err, Rf_mkString("errorValue"));
12-
Rf_warning("[ %d ] %s", xc, nng_strerror(xc));
12+
Rf_warning("%d | %s", xc, nng_strerror(xc));
1313
UNPROTECT(1);
1414
return err;
1515

‎src/sockets.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ static SEXP mk_error(const int xc) {
2121

2222
SEXP err = PROTECT(Rf_ScalarInteger(xc));
2323
Rf_classgets(err, Rf_mkString("errorValue"));
24-
Rf_warning("[ %d ] %s", xc, nng_strerror(xc));
24+
Rf_warning("%d | %s", xc, nng_strerror(xc));
2525
UNPROTECT(1);
2626
return err;
2727

‎src/utils.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ static SEXP mk_error(const int xc) {
1111

1212
SEXP err = PROTECT(Rf_ScalarInteger(xc));
1313
Rf_classgets(err, Rf_mkString("errorValue"));
14-
Rf_warning("[ %d ] %s", xc, nng_strerror(xc));
14+
Rf_warning("%d | %s", xc, nng_strerror(xc));
1515
UNPROTECT(1);
1616
return err;
1717

0 commit comments

Comments
 (0)