Skip to content
shundroid edited this page Jul 17, 2016 · 3 revisions

makeRawOrb(name, port)

orb を生成します。

引数

  • name (string) : orb の名前
  • port (string) : シリアルポート

戻り値

Orb のインスタンス

addOrb(orb)

orb を追加します。

引数

  • orb (Orb) : 追加する orb

戻り値

なし

注意

引数 orb の name プロパティ、port プロパティと一致するものが既にあった場合、
Error を返します。

getOrb([name|index])

orb を取得します。

引数

  • name (string) 省略可、indexと併用不可: 取得する orb の名前
  • index (number) 省略可、nameと併用不可: 取得する orb のindex

戻り値

  • name もしくは index を指定した場合で、それが有効な場合: Orb のインスタンス
  • name もしくは index を指定した場合で、それが無効な場合: false
  • 指定しなかった場合: Object (キー: name、値: Orb のインスタンス)

getUnlinkedOrbs()

client と link されていない orb をすべて取得します。

引数

なし

戻り値

Array

removeOrb(name)

orb を disconnect してから、削除します。

引数

  • name (string) : 削除する orb の名前

戻り値

なし

addClient(key, connection)

外部からは使用しないでください。

getClient([key])

client を取得します。

引数

  • key (string) 省略可 : 取得する client の key

戻り値

  • key を指定した場合で、それが有効な場合: Client のインスタンス
  • key を指定した場合で、それが無効な場合: false
  • key を指定しなかった場合: Object (キー: key、値: Clientのインスタンス)

removeClient(key)

外部からは使用しないでください。