Rで解析:Rのセッションどうしでデータフレームをそのまま送り合う「nanonext」パッケージ
「nanonext」パッケージは、Rのセッションどうし、あるいはRとほかのプログラムの間で、データフレームやベクトルをそのまま送り合えるパッケージです。渡すのはRのオブジェクトそのもので、送る側と受ける側で同じ宛先のURLを指定すれば、同じパソコンの中でもネットワーク越しでも届きます。届くのを待たずに次の処理へ進み、後から結果を受け取る書き方もできます。通信の土台になるNNGというライブラリはパッケージに入っているので、インストールすればすぐに使えます。並列処理や、Rとほかの仕組みとの連携を自前で組みたいときに役立てることができるのではないかと考えます。
パッケージバージョンは1.10.4。Windows 11 x64 (build 26200)のR version 4.6.1で確認しています。
<おすすめのRに関する書籍です>
パッケージのインストール
下記コマンドを実行してください。
# パッケージのインストール
install.packages("nanonext")
# パッケージの読み込み
library("nanonext")
Warning message:
package 'nanonext' was built under R version 4.6.2コマンド例
詳細はコメント、パッケージのヘルプを確認してください。
ソケットは通信の出入り口です。宛先のURLの「inproc://」は同じRセッションの中での通信を表し、「tcp://127.0.0.1:5555」のように書けば別のRセッションやほかのパソコンとつながります。aioは非同期入出力(Asynchronous I/O)の略で、送受信の完了を待たずに次の処理へ進む仕組みです。
ここでは、伏見区の倉庫と左京区の店舗の間で、京野菜の在庫表を送り合う場面を例にします。
# 京野菜の在庫表を作成
yasai <- data.frame(
品目 = c("九条ねぎ", "賀茂なす", "万願寺とうがらし", "聖護院かぶ"),
産地 = c("伏見区", "左京区", "舞鶴市", "左京区"),
在庫kg = c(120L, 45L, 80L, 60L)
)通信の出入り口を作る:socketコマンド
ソケットを作り、同時に待ち受け(listen)や接続(dial)の宛先を決めます。「pair」は1対1でやり取りする方式です。
| オプション | 意味 | 初期値 |
|---|---|---|
| protocol | 通信の方式。”bus”、”pair”、”poly”、”push”、”pull”、”pub”、”sub”、”req”、”rep”、”surveyor”、”respondent”から選択。既定は”bus” | c(“bus”, “pair”, “poly”, “push”, “pull”, “pub”, “sub”, “req”, “rep”, “surveyor”, “respondent”) |
| dial | 接続先のURL。’inproc://任意の名前’や’tcp://127.0.0.1:5555’のように文字列で指定 | NULL |
| listen | 待ち受けるURL。指定の形はdialと同じ | NULL |
| tls | tls+tcp://やwss://で暗号化して通信するときの設定。tls_configコマンドで作成したものを指定 | NULL |
| autostart | ダイヤラー・リスナーをすぐに開始するか。設定を変えてから開始するときはFALSE。ダイヤラーではNAで接続の完了を待ってから戻る | TRUE |
| raw | rawモードのソケットにするか。特別な用途がない限りFALSEのまま | FALSE |
# 伏見区の倉庫側:待ち受けるソケットを作成
souko <- socket("pair", listen = "inproc://kyoto_yasai")
# 左京区の店舗側:倉庫へ接続するソケットを作成
tenpo <- socket("pair", dial = "inproc://kyoto_yasai")
# 倉庫側のソケットの状態を確認
souko
< nanoSocket >
- id: 1
- state: opened
- protocol: pair
- listener:
inproc://kyoto_yasaiデータを送る:sendコマンド
Rのオブジェクトをそのまま送ります。戻り値の0は送信に成功したことを表します。
| オプション | 意味 | 初期値 |
|---|---|---|
| con | 送信に使うソケット、コンテキスト、ストリーム | なし |
| data | 送るオブジェクト。mode = “raw”のときはベクトル | なし |
| mode | 送り方。”serial”はRのオブジェクトをシリアライズして送り、”raw”はベクトルをバイト列にして送る。ストリームでは”raw”のみ | c(“serial”, “raw”) |
| block | 送れるまで待つか。TRUEで成功するまで待ち、FALSEですぐに戻る。整数で待つ時間の上限をミリ秒で指定。NULLは接続の既定に従う | NULL |
| pipe | “poly”方式のソケットで、送り先のパイプIDを指定 | 0L |
# 倉庫から店舗へ在庫表を送信(最大100ミリ秒待つ)
send(souko, yasai, block = 100)
[1] 0
# 店舗から倉庫へ追加の注文を文字列のまま送信
send(tenpo, "九条ねぎを30kg追加でお願いします", mode = "raw", block = 100)
[1] 0データを受け取る:recvコマンド
届いたデータを受け取ります。送る側の送り方に合わせてmodeを指定します。
| オプション | 意味 | 初期値 |
|---|---|---|
| con | 受信に使うソケット、コンテキスト、ストリーム | なし |
| mode | 受け取ったバイト列の変換先。”serial”はRのオブジェクトとして戻し、ほかは指定した型に変換する。”string”は長さ1の文字列を速く受け取る。ストリームでは”serial”が”character”になる | c(“serial”, “character”, “complex”, “double”, “integer”, “logical”, “numeric”, “raw”, “string”) |
| block | 届くまで待つか。TRUEで届くまで待ち、FALSEですぐに戻る。整数で待つ時間の上限をミリ秒で指定。NULLは接続の既定に従う | NULL |
# 店舗側で在庫表を受信
recv(tenpo, block = 100)
品目 産地 在庫kg
1 九条ねぎ 伏見区 120
2 賀茂なす 左京区 45
3 万願寺とうがらし 舞鶴市 80
4 聖護院かぶ 左京区 60
# 倉庫側で注文を文字列として受信
recv(souko, mode = "character", block = 100)
[1] "九条ねぎを30kg追加でお願いします"
<おすすめのRに関する書籍です>
待たずに受信を始める:recv_aioコマンド
受信を予約してすぐに戻ります。送信側の待たない版はsend_aioコマンドです。受け取った中身は、届いた後に [] で取り出します。
| オプション | 意味 | 初期値 |
|---|---|---|
| con | 受信に使うソケット、コンテキスト、ストリーム | なし |
| mode | 受け取ったバイト列の変換先。”serial”はRのオブジェクトとして戻し、ほかは指定した型に変換する。”string”は長さ1の文字列を速く受け取る。ストリームでは”serial”が”character”になる | c(“serial”, “character”, “complex”, “double”, “integer”, “logical”, “numeric”, “raw”, “string”) |
| timeout | 待つ時間の上限(ミリ秒)。NULLはソケットの既定で、ふつうは上限なし | NULL |
| cv | 受信が終わったときに知らせる条件変数(cvコマンドで作成) | NULL |
# 左京区産の行だけを待たずに送信
s_aio <- send_aio(souko, yasai[yasai$産地 == "左京区", ], timeout = 500)
# 店舗側で待たずに受信を開始
r_aio <- recv_aio(tenpo, timeout = 500)非同期の結果を取り出す:collect_aioコマンド
送受信が終わるまで待ち、結果そのものを返します。r_aio[] と書いても同じ結果になります。
| オプション | 意味 | 初期値 |
|---|---|---|
| x | sendAio、recvAio、ncurlAioのオブジェクト、またはそのリスト | なし |
# 送信の結果を取り出す(0は成功)
collect_aio(s_aio)
[1] 0
# 受信した在庫表を取り出す
collect_aio(r_aio)
品目 産地 在庫kg
2 賀茂なす 左京区 45
4 聖護院かぶ 左京区 60
# [] でも同じ中身を取り出せる
r_aio[]
品目 産地 在庫kg
2 賀茂なす 左京区 45
4 聖護院かぶ 左京区 60非同期の完了を待つ:call_aioコマンド
送受信が終わるまで待ち、オブジェクトそのものを返します。中身は受信なら $data、送信なら $result で取り出します。
| オプション | 意味 | 初期値 |
|---|---|---|
| x | sendAio、recvAio、ncurlAioのオブジェクト、またはそのリスト | なし |
# 店舗から倉庫へ仕入れ値の一覧を待たずに送信
s_aio <- send_aio(tenpo, c(宇治茶 = 2400, 丹波黒大豆 = 1800), timeout = 500)
# 倉庫側で待たずに受信を開始
r_aio <- recv_aio(souko, timeout = 500)
# 受信の状態を確認
r_aio
< recvAio | $data >
# 受信が終わるまで待つ
call_aio(r_aio)
# 受信した中身を取り出す
r_aio$data
宇治茶 丹波黒大豆
2400 1800
# 送信の結果を取り出す
s_aio$result
[1] 0
# ソケットを閉じる
close(souko)
close(tenpo)後から待ち受けを足す:listenコマンド
作ったソケットに待ち受けの宛先を足します。autostart = FALSEにすると、設定を済ませてからstartコマンドで開始できます。
| オプション | 意味 | 初期値 |
|---|---|---|
| socket | ソケット | なし |
| url | 待ち受けるURL。’inproc://任意の名前’や’tcp://127.0.0.1:5555’のように文字列で指定 | “inproc://nanonext” |
| tls | tls+tcp://やwss://で暗号化して通信するときの設定。tls_configコマンドで作成したものを指定 | NULL |
| autostart | リスナーをすぐに開始するか。設定を変えてから開始するときはFALSE | TRUE |
| fail | 失敗したときの扱い。”warn”は警告、”error”はエラー、”none”は警告を出さずにerrorValueを返す | c(“warn”, “error”, “none”) |
# 亀岡市の本部のソケットを作成
honbu <- socket("bus")
# 待ち受けの宛先を足す(まだ開始しない)
listen(honbu, url = "inproc://kameoka", autostart = FALSE)
# リスナーの状態を確認
honbu$listener
[[1]]
< nanoListener >
- id: 2
- socket: 3
- state: not started
- url: inproc://kameoka
# リスナーを開始
start(honbu$listener[[1]])
# リスナーの状態を確認
honbu$listener
[[1]]
< nanoListener >
- id: 2
- socket: 3
- state: started
- url: inproc://kameoka後から接続先を足す:dialコマンド
作ったソケットに接続先を足します。オプションの並びはlistenコマンドと同じです。
| オプション | 意味 | 初期値 |
|---|---|---|
| socket | ソケット | なし |
| url | 接続先のURL。’inproc://任意の名前’や’tcp://127.0.0.1:5555’のように文字列で指定 | “inproc://nanonext” |
| tls | tls+tcp://やwss://で暗号化して通信するときの設定。tls_configコマンドで作成したものを指定 | NULL |
| autostart | ダイヤラーをすぐに開始するか。NAで接続の完了を待ってから戻る。設定を変えてから開始するときはFALSE | TRUE |
| fail | 失敗したときの扱い。”warn”は警告、”error”はエラー、”none”は警告を出さずにerrorValueを返す | c(“warn”, “error”, “none”) |
# 宇治市の支店のソケットを作成
shiten <- socket("bus")
# 本部へ接続
dial(shiten, url = "inproc://kameoka")
# ダイヤラーの状態を確認
shiten$dialer
[[1]]
< nanoDialer >
- id: 2
- socket: 4
- state: started
- url: inproc://kameoka
# ソケットを閉じる
close(shiten)
close(honbu)
<おすすめのRに関する書籍です>
やり取りごとの窓口を作る:contextコマンド
1つのソケットの上に、やり取りごとの窓口(コンテキスト)を作ります。問い合わせ(req)と返答(rep)の方式で、複数の問い合わせを取り違えずにさばけます。
| オプション | 意味 | 初期値 |
|---|---|---|
| socket | ソケット | なし |
# 宇治の茶舗の窓口:返答する側のソケットを作成
madoguchi <- socket("rep", listen = "inproc://ujicha")
# お客さん:問い合わせる側のソケットを作成
kyaku <- socket("req", dial = "inproc://ujicha")
# それぞれにコンテキストを作成
ctx_rep <- context(madoguchi)
ctx_req <- context(kyaku)
# 問い合わせ側のコンテキストを確認
ctx_req
< nanoContext >
- id: 2
- socket: 6
- state: opened
- protocol: req問い合わせを送る:requestコマンド
問い合わせを送り、返答の受信を待たずに戻ります。返答は届いた後に [] で取り出します。
| オプション | 意味 | 初期値 |
|---|---|---|
| context | コンテキスト | なし |
| data | 送るオブジェクト。send_mode = “raw”のときはベクトル | なし |
| send_mode | 送り方。”serial”はRのオブジェクトをシリアライズして送り、”raw”はベクトルをバイト列にして送る | c(“serial”, “raw”) |
| recv_mode | 返答のバイト列の変換先。”serial”はRのオブジェクトとして戻し、ほかは指定した型に変換する。”string”は長さ1の文字列を速く受け取る | c(“serial”, “character”, “complex”, “double”, “integer”, “logical”, “numeric”, “raw”, “string”) |
| timeout | 待つ時間の上限(ミリ秒)。NULLはソケットの既定で、ふつうは上限なし | NULL |
| cv | 返答を受け取ったときに知らせる条件変数 | NULL |
| id | パッケージ内部で使うためのもの。NULLのまま | NULL |
# 玉露とかぶせ茶の値段を問い合わせる
toi <- request(ctx_req, data = c("玉露", "かぶせ茶"), timeout = 500)問い合わせに返答する:replyコマンド
問い合わせを受け取り、executeに書いた処理の結果を送り返します。executeには受け取ったデータを1つ目に取る処理を function(x) 〜 の形で渡します。
| オプション | 意味 | 初期値 |
|---|---|---|
| context | コンテキスト | なし |
| execute | 受け取ったデータを1つ目のオプションに取る処理。function(x) 〜 の形でも指定できる | なし |
| recv_mode | 問い合わせのバイト列の変換先。”serial”はRのオブジェクトとして戻し、ほかは指定した型に変換する。”string”は長さ1の文字列を速く受け取る | c(“serial”, “character”, “complex”, “double”, “integer”, “logical”, “numeric”, “raw”, “string”) |
| send_mode | 返答の送り方。”serial”はRのオブジェクトをシリアライズして送り、”raw”はベクトルをバイト列にして送る | c(“serial”, “raw”) |
| timeout | 問い合わせを待つ時間の上限(ミリ秒)。返答を送るときにも同じ上限がかかる。NULLはソケットの既定で、ふつうは上限なし | NULL |
| … | executeに渡すほかのオプション | なし |
# 茶舗の値段表(円/100g)
nedan <- c(煎茶 = 1200, 玉露 = 3000, かぶせ茶 = 1800)
# 問い合わせのあった品目の値段を返す
reply(ctx_rep, execute = function(x) nedan[x], timeout = 500)
[1] 0
# お客さん側で返答を取り出す
toi[]
玉露 かぶせ茶
3000 1800
# コンテキストとソケットを閉じる
close(ctx_req)
close(ctx_rep)
close(kyaku)
close(madoguchi)知らせが来るまで待つ:untilコマンド
cvコマンドで作った条件変数に知らせが来るまで、指定したミリ秒を上限に待ちます。知らせが来ればTRUE、時間切れならFALSEを返します。条件変数の値(cv_valueコマンド)は、知らせが来るたびに1増え、untilで受け取るたびに1減ります。
| オプション | 意味 | 初期値 |
|---|---|---|
| cv | 条件変数(cvコマンドで作成) | なし |
| msec | 知らせを待つ時間の上限(ミリ秒) | なし |
# 条件変数を作成
cv1 <- cv()
# 丹後の産地から入荷の連絡を受けるソケットを作成
uke <- socket("pull", listen = "inproc://tango")
oku <- socket("push", dial = "inproc://tango")
# 受信が終わったら条件変数に知らせるように受信を開始
r_aio <- recv_aio(uke, timeout = 1000, cv = cv1)
# まだ知らせは来ていない
cv_value(cv1)
[1] 0
# 産地から入荷の連絡を送信
send(oku, "丹後のちりめん 20反 入荷", block = 100)
[1] 0
# 知らせが来るまで最大1000ミリ秒待つ
kekka <- until(cv1, 1000)
kekka
[1] TRUE
# 届いた連絡を取り出す
r_aio[]
[1] "丹後のちりめん 20反 入荷"
# ソケットを閉じる
close(oku)
close(uke)
# 条件変数を作成
cv2 <- cv()
# 知らせが無いので100ミリ秒で時間切れ
until(cv2, 100)
# 手で知らせを送る
cv_signal(cv2)
# 値が1になる
cv_value(cv2)
[1] 1ランダムなバイト列を作る:randomコマンド
暗号用の乱数生成器で、指定したバイト数のランダムな値を作ります。受け付け番号や合言葉の生成に使えます。
| オプション | 意味 | 初期値 |
|---|---|---|
| n | 作るバイト数(0〜1024)。ベクトルのときは1つ目の値を使う | 1L |
| convert | TRUEで16進数の文字列、FALSEでrawベクトルとして返す | TRUE |
# 1バイトのランダムな値を16進数の文字列で作成
random()
[1] "37"
# 8バイトの受け付け番号を作成
random(8L)
[1] "8317221ba126c89d"
# 8バイトをrawベクトルで作成
random(n = 8L, convert = FALSE)
[1] 02 90 66 4e 81 c1 54 f0
<おすすめのRに関する書籍です>
この記事が誰かの役に立ちますように。