Skip to content

Commit

Permalink
update description
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Oct 27, 2023
1 parent 36ba21a commit 7b95101
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Package: nanonext
Type: Package
Title: NNG (Nanomsg Next Gen) Lightweight Messaging Library
Version: 0.10.2.9014
Version: 0.10.2.9015
Description: R binding for NNG (Nanomsg Next Gen), a successor to ZeroMQ. NNG is
a high-performance socket library implementing scalability protocols, a
cross-platform standard for common communications patterns such as
publish/subscribe, request/reply or service discovery. Serves as a
concurrency framework for distributed computing, utilising 'aio' objects
which resolve automatically upon completion of asynchronous operations, and
synchronisation primitives allowing R to wait upon concurrent messaging
threads. Intrinsically supports intra and inter-process communications, TCP,
WebSocket and secure TLS transports.
threads. Intrinsically supports in-process and inter-process communications,
TCP, WebSocket and secure TLS transports.
Authors@R:
c(person(given = "Charlie",
family = "Gao",
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# nanonext 0.10.2.9014 (development)
# nanonext 0.10.2.9015 (development)

#### New Features

Expand Down
2 changes: 1 addition & 1 deletion R/nanonext-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
#' concurrency framework for distributed computing, utilising 'aio' objects
#' which resolve automatically upon completion of asynchronous operations,
#' and synchronisation primitives allowing R to wait upon concurrent
#' messaging threads. Intrinsically supports intra and inter-process
#' messaging threads. Intrinsically supports in-process and inter-process
#' communications, TCP, WebSocket and secure TLS transports.
#'
#' @section Usage notes:
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ R binding for NNG (Nanomsg Next Gen), a successor to ZeroMQ. NNG is a high-perfo

Serves as a concurrency framework for distributed computing, utilising 'aio' objects which resolve automatically upon completion of asynchronous operations, and synchronisation primitives allowing R to wait upon concurrent messaging threads.

Intrinsically supports intra and inter-process communications, TCP, WebSocket and secure TLS transports.
Intrinsically supports in-process and inter-process communications, TCP, WebSocket and secure TLS transports.

Designed for performance and reliability, the NNG library is written in C and [`nanonext`](https://doi.org/10.5281/zenodo.7903429) is a lightweight zero-dependency wrapper.

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Serves as a concurrency framework for distributed computing, utilising
asynchronous operations, and synchronisation primitives allowing R to
wait upon concurrent messaging threads.

Intrinsically supports intra and inter-process communications, TCP,
Intrinsically supports in-process and inter-process communications, TCP,
WebSocket and secure TLS transports.

Designed for performance and reliability, the NNG library is written in
Expand Down Expand Up @@ -370,7 +370,7 @@ aio
#> < recvAio >
#> - $data for message data
aio$data |> str()
#> num [1:100000000] 1.069 -1.224 -1.464 0.558 -1.972 ...
#> num [1:100000000] -0.427 1.253 0.112 -1.945 0.404 ...
```

As `call_aio()` is blocking and will wait for completion, an alternative
Expand Down Expand Up @@ -537,7 +537,7 @@ throughout, or alternatively ‘localhost’, but not a mixture of the two.
cert <- write_cert(cn = "127.0.0.1")
str(cert)
#> List of 2
#> $ server: chr [1:2] "-----BEGIN CERTIFICATE-----\nMIIFOTCCAyGgAwIBAgIBATANBgkqhkiG9w0BAQsFADA0MRIwEAYDVQQDDAkxMjcu\nMC4wLjExETAPBgNV"| __truncated__ "-----BEGIN RSA PRIVATE KEY-----\nMIIJKAIBAAKCAgEAp7NzgGPugwYmaKfSMP3FWDTLmkdkVdnubB+yAXncDzvYcIcf\n7tHtvzdWfdeg"| __truncated__
#> $ server: chr [1:2] "-----BEGIN CERTIFICATE-----\nMIIFOTCCAyGgAwIBAgIBATANBgkqhkiG9w0BAQsFADA0MRIwEAYDVQQDDAkxMjcu\nMC4wLjExETAPBgNV"| __truncated__ "-----BEGIN RSA PRIVATE KEY-----\nMIIJJwIBAAKCAgEArRJb+8SkY/KW/Dje12uRgL+ZGqV8j5jWjxMSyxmStX4xbwCO\nQd0ACE9RdDrT"| __truncated__
#> $ client: chr [1:2] "-----BEGIN CERTIFICATE-----\nMIIFOTCCAyGgAwIBAgIBATANBgkqhkiG9w0BAQsFADA0MRIwEAYDVQQDDAkxMjcu\nMC4wLjExETAPBgNV"| __truncated__ ""

ser <- tls_config(server = cert$server)
Expand Down Expand Up @@ -706,7 +706,7 @@ ncurl("https://postman-echo.com/get")
#> NULL
#>
#> $data
#> [1] "{\n \"args\": {},\n \"headers\": {\n \"x-forwarded-proto\": \"https\",\n \"x-forwarded-port\": \"443\",\n \"host\": \"postman-echo.com\",\n \"x-amzn-trace-id\": \"Root=1-653b02eb-40631957312330027b6026a5\"\n },\n \"url\": \"https://postman-echo.com/get\"\n}"
#> [1] "{\n \"args\": {},\n \"headers\": {\n \"x-forwarded-proto\": \"https\",\n \"x-forwarded-port\": \"443\",\n \"host\": \"postman-echo.com\",\n \"x-amzn-trace-id\": \"Root=1-653b8580-0f276c010557157e4590277b\"\n },\n \"url\": \"https://postman-echo.com/get\"\n}"
```

For advanced use, supports additional HTTP methods such as POST or PUT.
Expand All @@ -725,10 +725,10 @@ res

call_aio(res)$headers
#> $date
#> [1] "Fri, 27 Oct 2023 00:23:08 GMT"
#> [1] "Fri, 27 Oct 2023 09:40:16 GMT"

res$data
#> [1] "{\n \"args\": {},\n \"data\": {\n \"key\": \"value\"\n },\n \"files\": {},\n \"form\": {},\n \"headers\": {\n \"x-forwarded-proto\": \"https\",\n \"x-forwarded-port\": \"443\",\n \"host\": \"postman-echo.com\",\n \"x-amzn-trace-id\": \"Root=1-653b02ec-422ffe33571b0d5249ff1195\",\n \"content-length\": \"16\",\n \"content-type\": \"application/json\",\n \"authorization\": \"Bearer APIKEY\"\n },\n \"json\": {\n \"key\": \"value\"\n },\n \"url\": \"https://postman-echo.com/post\"\n}"
#> [1] "{\n \"args\": {},\n \"data\": {\n \"key\": \"value\"\n },\n \"files\": {},\n \"form\": {},\n \"headers\": {\n \"x-forwarded-proto\": \"https\",\n \"x-forwarded-port\": \"443\",\n \"host\": \"postman-echo.com\",\n \"x-amzn-trace-id\": \"Root=1-653b8580-126f7b90664352a077113507\",\n \"content-length\": \"16\",\n \"content-type\": \"application/json\",\n \"authorization\": \"Bearer APIKEY\"\n },\n \"json\": {\n \"key\": \"value\"\n },\n \"url\": \"https://postman-echo.com/post\"\n}"
```

In this respect, it may be used as a performant and lightweight method
Expand Down Expand Up @@ -759,7 +759,7 @@ transact(sess)
#>
#> $headers
#> $headers$Date
#> [1] "Fri, 27 Oct 2023 00:23:08 GMT"
#> [1] "Fri, 27 Oct 2023 09:40:17 GMT"
#>
#> $headers$`Content-Type`
#> [1] "application/json; charset=utf-8"
Expand All @@ -772,8 +772,8 @@ transact(sess)
#> [76] 77 61 72 64 65 64 2d 70 6f 72 74 22 3a 20 22 34 34 33 22 2c 0a 20 20 20 20
#> [101] 22 68 6f 73 74 22 3a 20 22 70 6f 73 74 6d 61 6e 2d 65 63 68 6f 2e 63 6f 6d
#> [126] 22 2c 0a 20 20 20 20 22 78 2d 61 6d 7a 6e 2d 74 72 61 63 65 2d 69 64 22 3a
#> [151] 20 22 52 6f 6f 74 3d 31 2d 36 35 33 62 30 32 65 63 2d 37 38 33 39 61 33 66
#> [176] 33 37 37 37 36 36 64 33 35 32 64 63 39 38 35 65 38 22 2c 0a 20 20 20 20 22
#> [151] 20 22 52 6f 6f 74 3d 31 2d 36 35 33 62 38 35 38 31 2d 36 63 33 62 39 34 32
#> [176] 64 37 33 33 36 30 30 65 37 33 35 35 38 64 36 32 32 22 2c 0a 20 20 20 20 22
#> [201] 63 6f 6e 74 65 6e 74 2d 74 79 70 65 22 3a 20 22 61 70 70 6c 69 63 61 74 69
#> [226] 6f 6e 2f 6a 73 6f 6e 22 2c 0a 20 20 20 20 22 61 75 74 68 6f 72 69 7a 61 74
#> [251] 69 6f 6e 22 3a 20 22 42 65 61 72 65 72 20 41 50 49 4b 45 59 22 0a 20 20 7d
Expand Down
2 changes: 1 addition & 1 deletion man/nanonext-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7b95101

Please sign in to comment.