{"id":18516578,"url":"https://github.com/sugarsweetrobotics/juiz_core","last_synced_at":"2026-03-11T10:32:25.279Z","repository":{"id":209077704,"uuid":"723183780","full_name":"sugarsweetrobotics/juiz_core","owner":"sugarsweetrobotics","description":"juiz Rustベースのロボット用ミドルウェア。PythonやC++でもモジュールを記述できる。","archived":false,"fork":false,"pushed_at":"2025-06-10T07:17:22.000Z","size":59587,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-10T08:27:08.232Z","etag":null,"topics":["middleware","robotframework","robotics","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sugarsweetrobotics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support/install_opencv_windows_choco.ps1","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-11-24T21:55:08.000Z","updated_at":"2024-12-21T12:40:28.000Z","dependencies_parsed_at":"2023-11-24T22:45:13.283Z","dependency_job_id":"772cbf7c-234e-44fa-9bc3-dfd3716f394f","html_url":"https://github.com/sugarsweetrobotics/juiz_core","commit_stats":{"total_commits":163,"total_committers":2,"mean_commits":81.5,"dds":"0.030674846625766916","last_synced_commit":"0a3b92d0b2a3e83179e9b5bd3c60d3e3be1c0369"},"previous_names":["sugarsweetrobotics/juiz_core_pre","sugarsweetrobotics/juiz_core"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sugarsweetrobotics/juiz_core","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sugarsweetrobotics%2Fjuiz_core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sugarsweetrobotics%2Fjuiz_core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sugarsweetrobotics%2Fjuiz_core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sugarsweetrobotics%2Fjuiz_core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sugarsweetrobotics","download_url":"https://codeload.github.com/sugarsweetrobotics/juiz_core/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sugarsweetrobotics%2Fjuiz_core/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30378084,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T06:09:32.197Z","status":"ssl_error","status_checked_at":"2026-03-11T06:09:17.086Z","response_time":84,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["middleware","robotframework","robotics","rust"],"created_at":"2024-11-06T16:03:00.071Z","updated_at":"2026-03-11T10:32:25.261Z","avatar_url":"https://github.com/sugarsweetrobotics.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# juiz - the robot middleware\n\n## 概要\n\nJUIZ (ジュイス) はロボットをネットワーク分散システム的に開発するためのミドルウェアおよびソフトウェアプラットフォームの呼称である。\nJUIZを使うことで、複数の言語でネットワーク分散的に動作する複数のソフトウェアを結合して、一つのソフトウェアサービスのように動作させることができる。\n同様のソフトウェアプラットフォームとしてROSやOpenRTM-aist、naoqiがある。\nこれらとはソフトウェアモジュールのプログラミングモデルや利用形態において一線を画す革新的なソフトウェアになっていると自負しているが、ysugaひとりで作っていることもあって、ミッションクリティカルなタスクへの利用は控えてほしい。\n\n## モチベーション Motivation\n\nMOTIVATION.mdに長々と書いてある。\n\n## 設計の特徴\n\n本プロジェクトで提案するアーキテクチャには、今の所、名前は無い。\nその実装として、juizという名前をつけた。JUIZ （ジュイス）はポルトガル語で審判の意味だが、筆者が好きなアニメのキャラクターの名前から頂いた。\njuizの特徴としては、ROSのNodeのようなコンポーネント的アーキテクチャを分解し、その核となる状態変数をまとめたものを「コンテナ」、振る舞いを「プロセス」としたことにある。\nプロセスという名前には変遷があり、以前は国内の会議で「Operation」という名前で発表していたが、「データの処理をする」という意味でProcessという名前を選択した。\nDockerコンテナやUnixプロセスと名前がかぶることもあり、これらの呼称については議論の余地があると考えている。\n以下では単純にコンテナ、プロセスと呼ぶ場合は、juizにおけるコンテナ、プロセスの意と解釈してほしい。\n\nコンテナはC言語で言えば構造体である。\n変数をまとめて一つの単位として見做すことが出来るようにしたものである。\n変数を束ねてグループ化し、一つの単位として見做せる、ということは、ソフトウェアの見通しやすさとして重要な機能である。\n\nプロセスは一つの関数であると言える。\nプロセスは任意の個数の引数を取り、一つの値を出力する。\nプロセスに状態はなく、完全に冪等なサービスを提供することを前提としている。\nプロセスに状態がなく、副作用がないという点で、プロセスは「関数」であると言っても良いと考えている。\nこれを後述するコンテナプロセスと区別する場合は、特別に「純粋プロセス」と呼ぶことにする。\n\n純粋なプロセスだけではI/Oのアクセスが前提となるロボット用ミドルウェアの部品としては不十分であり、このためにコンテナに結びつけたプロセスである「コンテナプロセス」を定義する。\nコンテナプロセスはオブジェクト指向言語で言うところのクラスのインスタンスメソッドである。\n純粋なプロセスとの違いとして、最初の引数として、そのコンテナプロセスが結びつけられたコンテナの実体への参照が渡される。\n参照がリードオンリーな参照であれば、リードコンテナプロセス、書き込みも可能ならばライトコンテナプロセスと呼ぶことにする。\n\n純粋、コンテナに限らずプロセスは基本的にべき等な写像であり、テストし易いこと、コードの見通しが良いことがメリットとして上げられる。\nロボット等の物理的なエフェクターの利用を考えた本プロジェクトでは、システムの振る舞いの始まりや終わりには、上述のコンテナプロセスの出番が多いと考えられる。\nコンテナの第一の役割はI/Oアクセスのためのファイルデスクプリタの置き場であり、コンテナプロセスでioctlを呼び出して制御するのが一般的な例である。\nまたコンテナは実行の結果をシリアライゼーション抜きで保存することができるため、副作用を高速に請け負う物置きであるとも言える。\n\nロボット要素のプログラマーは、このコンテナとコンテナプロセス、および純粋なプロセスを用意することで機能を提供する。\nロボットの専用SDKをラッピングする形で機能提供することが多いと思うが、機能を司るクラスのオブジェクトをコンテナに持たせ、そのAPIをそれぞれコンテナプロセスでラッピングするのが通常の使い方になる。\n\nここまで紹介したコンテナやプロセス（コンテナプロセスを含む）は型であり、プログラムが実行されると実体化される。\n実体化されたコンテナやプロセスは、後述するブローカーを通して、いくつかのAPIを提供する。\nプロセスが提供するAPIとして最も重要なものはcallである。\ncallは遠隔呼び出しであり、プロセスの引数全てを送信すると、プロセスの結果を受け取ることができる。\nプロセスにどんな引数があるか、などの情報はprofileというAPIで取得できる。\n\ncall以外にもプロセスの処理を使う方法としてexecuteを提供している。\nexecuteは引数がない遠隔呼び出しであり、この場合、プロセスは二つの方法から引数の値を得る。\n\nその一つがconnectionである。\nプロセス同士はconnectすることが可能である。\nプロセスは実体化すると各引数および出力にバッファ (outlet, inlet) を持つが、connectでは、プロセスの出力 (outlet) を別のプロセスの引数の一つ (inlet) に繋ぐことができる。\nconnectionに繋がったプロセスのうち、出力する側をsourceとよび、入力を受ける側をdestinationと呼ぶ。\nconnectionにはタイプがある。\nあるプロセスがexecuteされると、そのinletのうち、pull型connectionを持つものは、そのconnectionのsourceに対してexecuteを要求し、出力を受け取る。\nプロセスの値を計算した後、outletの持つconnectionのうち、push型のものがあればそのdestinationに対してexecuteを要求する。\nこのようにconnectionではexecuteを伝播させることができる。\n\nもう一つの方法が引数 (inlet) に与えられたバッファを使う方法である。\nプロセスがexecuteされたときにinletにconnectionがない場合や、connectionがすべてpull型でない場合はキャッシュの値を引数に束縛する。\nこのキャッシュはプロセスが実体化する際に、デフォルトの値が割り振られ、またこの値はプロセスが提供するAPIであるp_applyで変更することが出来る。\np_applyの名前からも分かるとおり、このAPIは引数の部分適用 (partial apply) に相当する機能であり、関数の振る舞いを調整するコンフィグレーションのような機能を提供する事が出来る。\n\n以上の通り、本提案では「コンテナ」と「プロセス（コンテナプロセス）」が機能要素を実装する方法である。\n提供する機能をプロセスの入力（引数）と出力として定義し、また副作用をコンテナに格納することで、ROSで得られた、データフロー型通信、遠隔呼び出し通信、動作の調整（パラメータ）が全て利用できるようになる。\nこの事は、機能要素を設計するエンジニアの負担を軽減するのみでなく、機能要素の再利用性を大幅に向上する。\n\n## 機能要素の利用方法に関して\n\n機能要素が実体化されると外部に向けてAPIを提供することは既に説明した。\nこれを利用することによりロボット要素を利用したアプリケーションを作るのが通常の利用方法になる。\n機能要素の外部向けAPIは対象とする言語にあわせてラッピングされており、SDKの形で提供される。\nこれは、対象とする言語の様々なソフトウェアから利用しやすい機能としてロボットを提供する、という設計哲学の表れである。\n\nこのようにSDKの形で通信をラッピングして、プログラマフレンドリーな形でAPIを提供するロボットミドルウェアとしてはnaoqiやORiNが挙げられる。\n一方でROSやOpenRTM-aistは、機能要素を利用する場合も、そのユーザープログラムを機能要素として用意することを前提とした設計が見られる。\n例えばROSではTopicやServiceの機能をクライアントとして利用するには、ROSのNodeとしての基本機能を有している必要があった。\n一方でnaoqiでは、機能要素であるALModuleを実行するブローカーに対してリクエスト・レスポンス型の通信を行い機能を利用するが、これをラッピングする各言語のライブラリがあり、これをALProxyと呼び、このALProxyを介して、例えばPythonのプログラムを書く事が出来る。\nこれは、naoqiの機能要素を利用するプログラマーにとって、naoqiの提供するSDKやAPIに関する知識が殆ど必要無いことを意味している。\nまた、ALModuleは実体化されるとドキュメントを自動生成し、ブローカーで動作するhttpサーバー上でドキュメントを閲覧出来るため、通常のライブラリとして提供される以上の知識を得る方法もまた標準化されている。\n\n本提案でも、同様にProxyライブラリを提供することで、各プログラミング言語の任意のアプリケーションに組み込みやすい形での機能提供を考えている。\n本提案が考えるシステム開発のモデルは、継続的に状態を更新し続ける処理、特にリアルタイム性が高い処理は機能要素をconnectして大きな機能要素を作り、キーとなるプロセスを周期的にexecuteすることで状態を更新し続ける。\n一方で、ロボットが適用されるサービスのドメイン、例えば工場のアセンブリ工程や、農作物の収穫作業の自動化、自動走行する搬送機械などが挙げられるが、これらのロボットを統合して価値を生み出すソフトウェアを構築するためには、Proxyライブラリを使うことを想定している。\n\nちなみに脱線するが、juizの実装では、周期的にexecuteを呼ぶスレッドの作成が頻出パターンであったので、特別に「実行コンテキスト、ExecutionContext」の機能を提供している。\nEC (Execution Context) は、実体化するとprocessを結びつけることができる。\nまたECはSTART_STATEおよびSTOP_STATEの状態を持っており、外部APIでECをstartしてSTART_STATEに遷移すると、processをexecuteする。\nECには種類があり、デフォルトで提供しているTimerECは、定められたrateに従ってSTART_STATEである間は周期的にprocessをexecuteする。\nまたデフォルトで提供されているMainLoopECは、OSがプログラムに割り当てたメインのスレッド上でprocessをexecuteすることができる。\nこれはmain threadでの実行を要求するOSおよび主にGUI等のライブラリの利用上で便利な機能となる。\n\n一方で、ロボットやロボット要素を使う開発者は、Proxyライブラリを使って独自のアプリケーションを作る。\n研究者であればmain関数でロボット要素を初期化するコマンドを送った後、ループ内で繰り返し、状態の取得とアクチュエータの動作を指令するプログラムを書くかもしれない。\n特定のプロセスが励起された場合に呼ばれるコールバックを使ってイベントドリブンなアプリケーションを書くこともできる。\nもちろん、ロボットを利用する側の開発者が機能要素を開発することも可能である。\n\nこのように本提案モデルでは、多層的なユーザー層を想定した、ユーザーとの接点の設計を行っている。\nこの設計はnaoqiに強く影響を受けている。\nいずれはchoregraphのようなグラフィカルなツールを用意することを準備している。\n\n## 実装について\n\n上記のように本提案が提供するのは機能要素との通信機能を提供するミドルウェアと、それを利用するためのラッパーライブラリであるプロキシーである。\n\nミドルウェア部の実装はRust言語を用いたcrateとして実装されている。\n主に、機能要素を開発するためのjuiz_sdkと、機能要素を実体化するためのツールとしてのjuiz_coreおよびjuiz_appである。\n\n機能要素を提供するユーザーは、juiz_sdk crateを利用して機能要素を作成する。\n機能要素のためのコードはスケルトンコードを自動生成するためのアプリケーションを開発中である。\nこれを使ってビルドしたコードはdynamic link library (DLL. .so, .dylib, .dllファイル) として提供できる。\n\n機能要素を利用してシステムを構成するユーザは、juiz_appが提供するjuizコマンドを使う。\njuizコマンドに、yaml形式の設定ファイルを読み込ませる。\nこのyaml形式ファイルが指定するDLLをjuizコマンドがロードし、設定ファイルに従ってコンテナやプロセスを実体化する。\nコンテナやプロセスはCoreBrokerによって管理されており、CoreBrokerと外部APIとのインターフェースはBrokerと名付けられている。\nBrokerはCoreBrokerを通してコンテナやプロセスにアクセスするためのAPIを定義したインターフェースである。\nBrokerの実装として、デフォルトでHTTP+JSONとQUIC (バイナリ) が提供されている。\n特にHTTPのBrokerはデフォルトでOpenAPIのインターフェース定義を提供するので、SwaggerUIで動作確認をすることが可能である。\n\n例えば\n```\n$ juiz -f examples/rust/container/example_container.conf -d \n```\nのように、.confファイル (実際はyamlファイル) を-fオプションで利用する。-dオプションは実行後に待機するオプションで、Ctrl+Cでシグナルを送ると終了する。\njuizコマンドが待機中は、デフォルトで8000番ポートでhttp_brokerが動作しており、提供するAPIをSwaggerUIで試すことができるので、\n```\nhttp://127.0.0.1:8000/docs\n```\nにアクセスすると動作する。\n\n## 機能要素の実装方法\n機能要素であるContainer, ContainerProcessおよびProcessは、Rust, Python, C++の３種類の言語で実装することができる。\n\n### Processの実装\n#### Rustでの実装\n\n機能要素を実装するには、juiz_sdkというcrateを使う。Cargo.tomlは以下のようになる。\n```toml\n[package]\nname = \"increment_process\"\nversion = \"0.1.0\"\nedition = \"2021\"\n\n[lib]\ncrate-type = [\"cdylib\"]\n\n[dependencies]\njuiz_sdk = { path = \"$PATH_TO/juiz_sdk/\" }\n```\n$PATH_TOにはjuiz_sdk crateまでの相対パスを書く。 (これはcrates.ioにjuiz_sdkを登録したら楽になると思う。)\n\n例えば、引数に1を足して返すだけの純粋プロセスのコードを書いてみる。\n\nRustで記述するのが現状ではもっともエレガントにProcessやContainerを記述できる。\n\n``` rust\nuse juiz_sdk::prelude::*;\n\n#[juiz_process]\nfn increment_process(arg1: i64) -\u003e JuizResult\u003cCapsule\u003e {\n    log::trace!(\"increment_process({:?}) called\", arg1);\n    return Ok(jvalue!(arg1+1).into());\n}\n```\nまずjuiz_sdk::prelude::*をインポートすると、基本的なマクロや変数の型が使えるようになる。\njuiz_processマクロを当てた関数が、Processの本体になる。関数の名前がProcessのタイプ名になる。\n引数は複数の引数が使えて、i64, f64, bool, String, Value, Vec\u003cValue\u003eなどが使える。\n引数の名前もパラメータになっている。\njuiz_processマクロに引数を与えると、ドキュメントやデフォルト引数を自動生成できる。詳しい内容は後述（予定）\n\n#### C++での実装\n\nモジュールのローダーであるjuizコマンドはrustで書かれているが、他の言語とのインターフェースを持っているので、機能モジュールを別の言語で書くことができる。\nC++では、exportすべき関数の名前と、扱うべきデータ型が決まっており、これを提供するヘッダーファイルであるjuiz.hが提供されている。\njuiz.hはbindings/cppjuiz/includeディレクトリにあるので、このディレクトリにINCLDUE_PATHを通しておいてほしい。\n\n``` c++\n#include \"juiz/juiz.h\"\n\njuiz::Value manifest() {\n    return ProcessManifest{\"increment_process_cpp\"}\n        .add_int_arg(\"arg1\", \"test_argument\", 1)\n        .into_value();\n}\n\nstd::optional\u003cint64_t\u003e increment_process(juiz::CapsuleMap cm) {\n    auto a = cm.get_int(\"arg1\");\n    return a + 1;\n}\n\nPROCESS_FACTORY(manifest, increment_process);\n```\nC++はRustで自動生成していた部分をかなり自分で書かないといけない。\nこれはいずれなんとかしたいが、できるのだろうか・・・\n\n#### Pythonでの実装\n\nPythonとのインターフェースはRustのPyO3 crateを用いて実装されており、入出力で扱うデータ型は主にintやstrなどのプリミティブやlist, tuple, dictなどの複合型になる。\n独自のデータ型を使う場合は、dataclassを使って構成して、juizに渡す関数の出力ではasdictメソッドでdictに変換して送ることになる。\n\npythonはpyjuizというパッケージを作成してある。\nbindings/pyjuizにPYTHONPATHを通しておくと便利だ。\n\n``` python\nfrom juiz import *\n\n@juiz_process\ndef increment_process(arg1:int = 1):\n    return arg1 + 1\n```\nPythonはデコレータで記述量をかなり減らすことができた。\n\n### Containerの実装\nContainerはstructを与えてやることで実現する。\n後述のContainerProcessはこのstructを最初の引数として受け取るProcessを定義することになる。\n\n#### Rustでの実装\n例によってRustでのContainerの記述はエレガントである。\nCargo.tomlについてはProcessの章を参照してほしい。\n\nContainerを作成する関数にjuiz_containerのマクロアトリビュートを追加するだけで実現できる。\nこの関数をコンテナのコンストラクタと呼ぶことにする。\n返り値はBoxして渡して欲しい。\n``` rust\nuse juiz_sdk::prelude::*;\n\n#[repr(Rust)]\npub struct ExampleContainer {\n    pub value: i64\n}\n\n#[juiz_container]\nfn example_container(initial_value: i64) -\u003e JuizResult\u003cBox\u003cExampleContainer\u003e\u003e {\n    Ok(Box::new(ExampleContainer{value:initial_value}))\n}\n```\n\n#### C++での実装\nC++ではヘッダーファイル (*.h) でstructを定義して、ソースファイル (*.cpp) でコンストラクタ等を定義する。\nヘッダーファイルのPATHについてはProcessの章を参照してほしい。\n``` c++ \n// -- example_contaienr.h\n#pragma once\n\n#include \u003ccstdint\u003e\n\nclass CppContainer {\npublic:\n    int64_t value;\n    CppContainer(int64_t v) : value(v) {}\n};\n```\n\nコンテナのコンストラクタとしてcreate_container関数を定義している。\nこのあたりもtemplateを使えばもう少しウマく書けそうなんだけど、Rustとの接続の部分も含めて設計が必要で、難しい。\n``` c++\n// --- example_container_cpp.cpp\n#include \"juiz/juiz.h\"\n#include \"example_container.h\"\n\njuiz::Value manifest() {\n    return ContainerManifest(\"example_container_cpp\").into_value();\n}\n\nCppContainer* create_container(juiz::Value value) {\n    int64_t int_value = 0;\n    if (value.isObjectValue()) {\n        if (value.hasKey(\"value\")) {\n            auto objv = value.objectValue();\n            auto v = objv[\"value\"];\n            if (v.isIntValue()) {\n               int_value = v.intValue();\n            }\n        }   \n    }\n    return new CppContainer(int_value);\n}\n\nbool destroy_container(CppContainer* p_container) {\n    if (p_container) {\n        delete p_container;\n        return true;\n    }\n    return false;\n}\n\nCONTAINER_FACTORY(manifest, create_container, destroy_container);\n```\n#### Pythonでの実装\n\nPythonはやはり記述としては少ないが、もう少しスッキリさせるにはデコレータでなんとかしたいと考えている。\npyjuizのPATHについてはProcessの章を参照してほしい。\njuiz_containerデコレータで記述がスッキリした。\n``` python\n\nfrom juiz import *\n\nclass PyContainer:\n    value: int\n    def __init__(self, value):\n        self.value = value\n\n@juiz_container\ndef example_container_python(initial_value:int = 0):\n    # print(f'example_container_python(value = {initial_value}) called')\n    return PyContainer(initial_value)\n\n```\n\n### Container Processの実装\n\n#### Rustでの実装\nコンテナプロセスではjuiz_container_processマクロを使い、このマクロの引数に「container_type = ほにゃらら」という値を入れる。\nマクロの引数は初めて出てきたが、実はjuiz_processやjuiz_containerにも引数を与えることができる。\nCargo.tomlについてはProcessの章を参照してほしい。\n``` rust\nuse example_container::ExampleContainer;\nuse juiz_sdk::prelude::*;\n\n#[juiz_container_process( container_type = \"example_container\" )]\nfn increment_function(container: \u0026mut ContainerImpl\u003cExampleContainer\u003e, arg1: i64) -\u003e JuizResult\u003cCapsule\u003e {\n    container.value = container.value + arg1;\n    return Ok(jvalue!(container.value).into());\n}\n```\n\n#### C++での実装\nC++はやはりどこか冗長な記述になってしまう。\nコンテナを生成するコードで使ったヘッダーを再利用することで、同じ構造体にアクセスするコンテナプロセスを作ることができる。\njuiz.hについてはProcessの章を参照してほしい。\n``` c++\n#include \"juiz/juiz.h\"\n#include \"example_container.h\"\n\njuiz::Value manifest() {\n    return ProcessManifest(\"example_container_cpp_increment\")\n        .container_type(\"example_container_cpp\")\n        .add_int_arg(\"arg0\", \"test_argument\", 2)\n        .into_value();\n}\n\nstd::optional\u003cint64_t\u003e example_container_increment(CppContainer* container, juiz::CapsuleMap cm) {\n    int64_t v = cm.get_int(\"arg0\");\n    container-\u003evalue = container-\u003evalue + v;\n    return container-\u003evalue;\n}\n\nCONTAINER_PROCESS_FACTORY(CppContainer, manifest, example_container_increment)\n```\n#### Pythonでの実装\nコンテナプロセスはやはりC++よりはスッキリと書ける。\n\n\n``` python\nfrom juiz import juiz_container_process\n\n@juiz_container_process(\n    container_type=\"example_container_python\"\n)\ndef example_container_python_get(container):\n    # print(f'example_container_python_get({container}) called')\n    return container.value\n```\n\n### Componentの実装\nコンポーネントは、Process, Container, ContainerProcessを一つのプロジェクトで一斉に作り配布する方法である。\n\n\n#### RustでのComponentの実装方法\n```rust\nuse juiz_sdk::prelude::*;\n\n#[juiz_component_process]\nfn example_component_increment(arg1: i64) -\u003e JuizResult\u003cCapsule\u003e {\n    log::trace!(\"increment_process({:?}) called\", arg1);\n    return Ok(jvalue!(arg1+1).into());\n}\n\n#[repr(Rust)]\npub struct ExampleComponentContainer {\n    pub value: i64\n}\n\n#[juiz_component_container]\nfn example_component_container(initial_value: i64) -\u003e JuizResult\u003cBox\u003cExampleComponentContainer\u003e\u003e {\n    println!(\"example_component_container({initial_value}) called\");\n    Ok(Box::new(ExampleComponentContainer{value: initial_value}))\n}\n\n#[juiz_component_container_process( container_type = \"example_component_container\" )]\nfn example_component_container_get(container: \u0026mut ContainerImpl\u003cExampleComponentContainer\u003e) -\u003e JuizResult\u003cCapsule\u003e {\n    println!(\"example_component_container_get()\");\n    Ok(jvalue!(container.value).into())\n}\n\n#[juiz_component_container_process( container_type = \"example_component_container\" )]\nfn example_component_container_increment(container: \u0026mut ContainerImpl\u003cExampleComponentContainer\u003e) -\u003e JuizResult\u003cCapsule\u003e {\n    println!(\"example_component_container_increment()\");\n    container.value = container.value + 1;\n    Ok(jvalue!(container.value).into())\n}   \n\n#[juiz_component_container_process( container_type = \"example_component_container\" \n   arguments = {\n      default = {\n        arg1 = 1\n      }\n   }\n)]\nfn example_component_container_add(container: \u0026mut ContainerImpl\u003cExampleComponentContainer\u003e, arg1: i64) -\u003e JuizResult\u003cCapsule\u003e {\n    println!(\"example_component_container_add({arg1})\");\n    container.value = container.value + arg1;\n    Ok(jvalue!(container.value).into())\n}\n\njuiz_component_manifest!(\n    component_name = \"example_component\"\n    containers = {\n        example_component_container = [\n            example_component_container_get,\n            example_component_container_increment,\n            example_component_container_add\n        ]\n    }\n    processes = [\n        example_component_increment\n    ]\n);\n```\n\n#### C++でのComponentの実装\n\n\n## 機能要素の単体実行方法\njuizクレートをビルドするとjuizコマンドが生成される。このコマンドを使う。\n\n### Processを試す。\nたとえば、RustでつくったProcessがtarget/debug/libtalker.dylibだった場合、以下のコマンドで単体プロセスが実行できる。\n```terminal\njuiz --process target/debug/libtalker.dylib -l rust -e -1\n```\n--processオプションで生成物を指定する。Pythonなら.pyファイル、C++ならば.dllや.so, .dylibなどのバイナリである。\n-lオプションは言語を指定する。rust|cpp|pythonの3つから選び、デフォルトはrustであるので例の場合は\"-l rust\"は省略が可能なオプションである。\n-eオプションはロードしたプロセスを一つ、自動で名前をつけて実体化し、デフォルトの引数を使ってexecuteする。\n-1オプションで、ロードしたモジュール一つにつき、一つのインスタンスを作成する。\n\nこのjuizクレートの中で試すなら、以下のように行う\n```terminal\ncargo run -- --process ./target/debug/libtalker.dylib -e -1\n```\nデフォルトのbinとしてjuizコマンドが登録されているのでcargo runで実行される。\n\n-dオプションをつけると、実行後にサーバーを立ててそのまま待機をする。\nこの状態ならばhttp://localhost:8000/docsをブラウザで開くと、swagger-uiを使ったテストを行うことができる。\nこれについては後述する。\n\n### ContainerおよびContainerProcessを試す。\nRustで作ったContainerとContainerProcessがそれぞれ、./target/debug/my_container.dylibと./target/debug/my_container_process.dylibであった場合、以下のコマンドで単体のコンテナプロセスを実行できる。\n```terminal\njuiz --container ./target/debug/my_container.dylib --container_process ./target/debug/my_container_process.dylib -l rust -e -1\n```\n--containerでコンテナのファイルを、--container_processでコンテナプロセスのバイナリを指定する。\n-lで言語を指定するのも同じであり、-eオプションも同じ効果である。\n-1オプションで、ロードしたモジュール一つにつき、一つのインスタンスを作成する。\nこの方法ではただ一のコンテナのみインスタンスにできる。コンテナプロセスは、そのコンテナのプロセスとして結びつけられる。\n\n\n## 設定ファイルの中身\n複数の成果物を一気に読み込む場合は設定ファイルを記述するのが簡単である。\n\n設定ファイルの例について示す。\n``` yaml\nname: \"test_system\"\noption:\n  http_broker:\n    start: true\n    port: 8000\nplugins:  \n  container_factories:\n    example_container:\n      language: \"rust\"\n      path: \"./target/debug\"\n      processes:\n        example_container_get:\n          path: \"./target/debug\"\n        example_container_increment:\n          path: \"./target/debug\"\n  \"process_factories\":\n    \"increment_process\":\n      \"path\": \"./target/debug\"\n\"containers\":\n  - \"type_name\": \"example_container\"\n    \"name\": \"container0\"\n    \"processes\":\n    - \"type_name\": \"example_container_increment\"\n      \"name\": \"increment0\"\n    - \"type_name\": \"example_container_get\"\n      \"name\": \"get0\"\n\"processes\":\n  - \"type_name\": \"increment_process\"\n    \"name\": \"inc0\" \n```\n現状、かなり記述量が多いので、これを減らすことを考えている。\n\nこのファイルではコンテナのファクトリーとして、example_container型のコンテナのファクトリーを含んだexample_container.dylibファイルと、そのexample_containerに結び付けられたexample_container_get型のコンテナプロセスのファクトリーを含んだdylibファイル、同じくexample_container下のexample_container_incrementのdylib、\n同時に、純粋プロセスのファクトリーとしてincrement_processのdylibを読み込んでいる。\nファクトリーのdylibファイルは、それが提供する型の名前＋拡張子、で指定するルールになっている。\nまた、containerの実体としてexample_container型のcontainer0を実体化し、このコンテナのメンバーとしてexample_container_increment型のコンテナプロセスであるincrement0と、example_container_getのget0を実体化している。\nまた、純粋プロセスであるincrement_process型のinc0も実体化している。\n\nここでもう少し設定ファイルについて説明する。\n\nトップレベルの「name」はシステムの名前を定義する。\n\n「option」はデフォルトで動作するモジュールの動作定義をする。\n「http_broker」はhttp Brokerの振る舞いについて定義できる。\n「start」をtrueにするとデフォルトでhttp_brokerが起動し、portで指定するポートで通信が可能になる。\nこれ以外にも後述するpythonpathなど、デフォルトの動作について調整できる。\n\n「plugins」は、コンテナやプロセスおよびbrokerの実装のDLLを読み込むための定義が書かれている。\n「container_factories」はコンテナのDLLの読み込み、「process_factories」はプロセスのDLL読み込みを行っている。\n\nトップレベルの「containers」は、pluginsで読み込まれたコンテナを実体化するための設定が書かれている。\n同様に「processes」は純粋プロセス実体化のための定義が書かれている。\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsugarsweetrobotics%2Fjuiz_core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsugarsweetrobotics%2Fjuiz_core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsugarsweetrobotics%2Fjuiz_core/lists"}