C# Class Baku.LibqiDotNet.QiSession

通信セッションを表します。
Exibir arquivo Open project: malaybaku/BakuLibQiDotNet Class Usage Examples

Private Properties

Property Type Description
QiSession System
ThrowIfNotConnected void

Public Methods

Method Description
Close ( ) : QiFuture

セッションを閉じます。

Connect ( string address ) : QiFuture

指定したアドレスへの接続を試みます。

Create ( ) : QiSession

非接続状態で新しくセッションを生成します。

Create ( string address ) : QiSession

接続先アドレスを指定し、接続が完了した状態のセッションを取得します。

Destroy ( ) : void

セッションを破棄します。

GetEndpoints ( ) : QiValue

セッションのエンドポイントを取得します。

GetService ( string name ) : QiObject

サービス名を指定してサービスを取得します。この関数はGetServiceAsync(string)の待機結果を返します。

GetServiceAsync ( string name ) : QiFuture

サービス名を指定してサービスを取得します。

GetServices ( ) : string[]

サービス一覧を文字列の配列として取得します。

GetServicesAsync ( ) : QiFuture

サービス名の一覧を取得します。

GetUrl ( ) : string

(動作未確認)セッションに対応したURLを取得します。

Listen ( string address, bool standAlone = false ) : QiFuture

セッションをリスンします。

RegisterService ( string name, QiObject obj ) : QiFuture

サービスに名前を付けて登録します。

SetIdentity ( string key, string crt ) : int

(動作未確認)セッションの一意識別子を設定します。

UnregisterService ( uint idx ) : QiFuture

IDを指定してサービスを登録解除します。

Private Methods

Method Description
QiSession ( IntPtr handle ) : System
ThrowIfNotConnected ( ) : void

Method Details

Close() public method

セッションを閉じます。
public Close ( ) : QiFuture
return QiFuture

Connect() public method

指定したアドレスへの接続を試みます。
public Connect ( string address ) : QiFuture
address string 接続先アドレス
return QiFuture

Create() public static method

非接続状態で新しくセッションを生成します。
public static Create ( ) : QiSession
return QiSession

Create() public static method

接続先アドレスを指定し、接続が完了した状態のセッションを取得します。
public static Create ( string address ) : QiSession
address string 接続先のアドレス
return QiSession

Destroy() public method

セッションを破棄します。
public Destroy ( ) : void
return void

GetEndpoints() public method

セッションのエンドポイントを取得します。
public GetEndpoints ( ) : QiValue
return QiValue

GetService() public method

サービス名を指定してサービスを取得します。この関数はGetServiceAsync(string)の待機結果を返します。
public GetService ( string name ) : QiObject
name string サービス名
return QiObject

GetServiceAsync() public method

サービス名を指定してサービスを取得します。
public GetServiceAsync ( string name ) : QiFuture
name string サービス名
return QiFuture

GetServices() public method

サービス一覧を文字列の配列として取得します。
public GetServices ( ) : string[]
return string[]

GetServicesAsync() public method

サービス名の一覧を取得します。
public GetServicesAsync ( ) : QiFuture
return QiFuture

GetUrl() public method

(動作未確認)セッションに対応したURLを取得します。
public GetUrl ( ) : string
return string

Listen() public method

セッションをリスンします。
public Listen ( string address, bool standAlone = false ) : QiFuture
address string リスン先アドレスです。例えばアクセスを制限しない場合は"tcp://0.0.0.0:0"を指定します。
standAlone bool アプリケーションがスタンドアロンである場合はtrueにします。通常は設定する必要はありません。
return QiFuture

RegisterService() public method

サービスに名前を付けて登録します。
public RegisterService ( string name, QiObject obj ) : QiFuture
name string サービス名
obj QiObject サービスの実体
return QiFuture

SetIdentity() public method

(動作未確認)セッションの一意識別子を設定します。
public SetIdentity ( string key, string crt ) : int
key string
crt string
return int

UnregisterService() public method

IDを指定してサービスを登録解除します。
public UnregisterService ( uint idx ) : QiFuture
idx uint 解除の対象となるサービスのID
return QiFuture