Trema Ruby ライブラリのクラスは 100 個以上ありますが、そのうちよく使うものはせいぜい 10 個とかそこらです。そこで今日は、このようなよく使うクラスやメソッドだけを集めた便利な URL を紹介します。
チートシート
よく使う機能をまとめたものを一般にチートシート (カンニング・ペーパーの意) と呼びますが、Trema の README.md にはこのチートシートが含まれています。
README.md の Ruby API セクションがそれで、Trema を使った OpenFlow プログラミングで多用する次の機能一覧がコンパクトにまとめられています。
- イベント・メッセージハンドラの一覧
- Flow Mod と Packet Out 用メソッド一覧
- その他の OpenFlow メッセージ一覧
- フローのアクション一覧
それぞれの項目は簡潔かつ完全な一覧になっていて、さらにリンクをたどることで詳細な API 調べることができるようになっています。とくにハンドラの一覧は作者自身である私も重宝しています。
さらに良くしよう
チートシートの使い勝手はその密度で決まります。内容を濃くするための改善案や「もっといい物を自分で作ってしまった」という方がいましたらコメント欄や Twitter などでぜひ教えてください。
また、チートシートから飛べる Trema Ruby API ドキュメントはまだまだ未熟なので次のような点があるかもしれません。
- リンクが切れている
- API の説明がまちがっている/わかりづらい
- 例が無い/例がまちがっている
- API の設計がおかしい
もし、こうした点を見つけた方は同様にご連絡いただけると助かります。