- NzaeApi& getApi(nz::ae::NzaeApi::ApiTypetype)
- APIオブジェクトを取得します。
- パラメーター
- ApiTypeタイプ
- 指定されたAPIタイプまたはANY。
- 戻り
- NzaeApi
- APIオブジェクト。
- 例外
- NzaeException
APIオブジェクトをローカルまたはリモートモードで返す。 指定された型を返すか、例外をスローする。 APIはヘルパー・オブジェクトが所有する。
APIオブジェクトはAEプログラムのメイン・オブジェクトである。
- NzaeApi* getApi(nz::ae::NzaeApi::ApiTypetype, bool fork)
- APIオブジェクトを取得します。
- パラメーター
- ApiTypeタイプ
- 指定されたAPIタイプまたはANY。
- fork する
- TRUEの場合、新しいプロセスをフォークする。
- 戻り
- NzaeApi
- fork が TRUE で AE がリモート AE の場合、API オブジェクトは親 AE 内で NULL となる。
- 例外
- NzaeException
ローカルモードまたはリモートモードのAPIを返す。 指定された型のいずれかを返すか、例外を投げる。 APIは、ownsAPIの設定によって、ヘルパーが所有することも、呼び出し元が所有することもある。
APIオブジェクトはAEプログラムのメイン・オブジェクトである。
- NzaeRemoteProtocolCallback* getCallbackHandler()
- リモートプロトコルのコールバックハンドラを取得します。
- パラメーター
- NzaeRemoteProtocolCallback
- コールバックハンドラ。
リモート・プロトコル・ハンドラ・クラスは、stop、status、pingなどのリモート・コマンドを処理するために使われる。
- ブールisLocal()
- ローカルAEプロセスであればtrueを返す。
- 戻り
- AEがローカルであれば真
- ブールisRemote()
- リモートAEプロセスであればtrueを返す。
- 戻り
- AEがリモートであれば真。
- NzaeApiGenerator()
- コンストラクター
- boolownsAPI()
- ヘルパーが API を所有している場合に TRUE を返す。
- 戻り
- ヘルパーがAPIを所有している場合はTRUE。
TRUEを指定すると、新しいAPIを受け付けるか、ヘルパーを削除したときにAPIが削除される。
- voidsetCallbackHandler(NzaeRemoteProtocolCallback*handler)
- リモートプロトコルのコールバックハンドラを設定します。
- パラメーター
- NzaeRemoteProtocolCallbackハンドラ
- リモートプロトコルハンドラ。
リモート・プロトコル・ハンドラ・クラスは、stop、status、pingなどのリモート・コマンドを処理するために使用される。
- virtual voidsetDataSliceId(int dataSliceId)
- リモート接続ポイントのデータスライスIDを設定する。
- パラメーター
- dataSliceId
- リモート接続ポイントのデータスライスID。
この関数は、NzaeConnec- tionPointクラスで利用可能なランチャーからのリモート値をオーバー ライドしない。
- virtual voidsetName(constchar *name)
- リモート接続ポイント名を設定します。
- パラメーター
- 名前
- リモート接続ポイント名。
この関数は、NzaeConnection-Point クラスで利用可能なランチャーからのリモート値をオーバー ライドしない。
- voidsetOwnsAPI(boolowns)
- このオブジェクトがAPIを管理するかどうかを設定します。
- パラメーター
- 所有
- ヘルパーがAPIを所有している場合はTRUE。
TRUEを指定すると、新しいAPIを受け付けるか、ヘルパーを削除したときにAPIが削除される。
- virtual voidsetSessionId(int sessionId)
- リモート接続ポイントのセッションIDを設定します。
- パラメーター
- sessionId
- リモート接続ポイントのセッションID。
この関数は、NzaeConnectionPointクラスで利用可能なランチャーからのリモート値をオーバー ライドしない。
- 仮想 voidsetTransactionId(int64_t transactionId)
- リモート接続のトランザクションIDを設定します。
- パラメーター
- transactionId
- リモート接続ポイントのトランザクションID。
この関数は、NzaeConnectionPointクラスで利用可能なランチャーからのリモート値をオーバー ライドしない。
- ~NzaeApiGenerator()
- 破壊者。
- APIオブジェクトが所有されている場合、それを削除する。 接続ポイントとリモートプロトコルオブジェクトを削除する。