simpdiscover

シンプディスカバー

Simpdiscover は、UDP ブロードキャスト データグラムまたは「ビーコン」を使用して、ローカル エリア ネットワーク (LAN) 内のサービスの検出を容易にするシンプルな Rust クレートです。

サービスの「アナウンサー」は、別のマシン上のプロセス、または同じマシン上の別のスレッドまたはプロセスである可能性があります。

目標

• 名前付きサービスとその IP を LAN 全体で検出
• 理解しやすく使いやすい
• ライブラリへの依存関係が小さく、メモリと CPU のフットプリントが小さい
• 使いやすく、ライブラリに特定のファイル形式のサポートを導入しないシンプルなビーコン形式

非目標

• LAN、WAN、Web、またはクラウド上のサービスの検出。

これまでに実装された

• ビーコンを送信するように設定できる BeaconSender 構造体:
  • 特定のビーコンコンテンツ文字列を含む
  • 特定のポート上で
  • メソッドを使用して次のことを行います。
    • 指定された期間にループで永久に送信する
    • ビーコンを 1 つだけ送信する
• ビーコンを受信するように設定できる単純な BeaconListener 構造体:
  • 特定のメッセージ内容と一致する
  • 送信者をブロックし、メッセージが受信されるまで待機するメソッドを使用する
    • オプションのタイムアウト値を指定して待機するか、None を指定して無期限に待機します
• ライブラリを例として使用する単純な「announce」および「listen」バイナリ
• API ドキュメントを正確に保つためのいくつかのドキュメント テスト
• Github Action をビルドしてクリッピーチェックし、すべてをテストします

バイナリを「発表」する

cargo run --bin announceを使用してリポジトリからこのバイナリを実行するか、カーゴを含むクレートをインストールしたかどうかをannounce 。

オプションのコマンド ライン パラメータを使用して、アナウンスするビーコン メッセージの文字列を指定します。 cargo run --bin announce -- Hello

「聞く」バイナリ

cargo run --bin listen使用してリポジトリからこのバイナリを実行するか、カーゴでクレートをインストールした場合はlistenだけです。

オプションのコマンド ライン パラメータを使用して、終了する前に待機するビーコン メッセージの文字列を指定します。 cargo run --bin listen -- Hello

今後の取り組み

今後の作業に関するメモのほとんどを GitHub の問題に変換しました。

いくつかは私が理解できないことについての単なる質問であり、UDP と Rust の専門家に説明してもらいたいと思っています。

コメントするか、実装に興味のあるものを開始してください。

PR は、ドキュメントのコメント、ドキュメントのテスト、またはテストを伴う場合には、明らかに歓迎されます。

開発者

• リポジトリをクローン/フォークしてダウンロードします。
• cdでディレクトリに移動します
• 変更を追加し、ドキュメント コメントやドキュメント テストとテストを追加します。
• cargo build
• cargo test
• cargo clippy -- -D warnings
• PRを作成する
• Github アクションは上記と同じ手順を実行します
• 見直して統合してみます