メソッド ¶
インスタンスメソッド ¶
addClients()
→ pdg.ServiceAddClientBlock
保留中のクライアントが接続されるのを待機するコンテキストマネージャを開きます。
addPendingClient(server_addr, server_port, client_index)
→ pdg.ServiceClientInfo
接続を保留中のクライアントを追加し、そのクライアント情報を返します。
このメソッドは、pdg.Service.addClientsを使用してwith
ステートメント内でコールしてください。
schedulerContextName()
→ str
サービスに関連付けられているスケジューラのグラフコンテキストの名前を返します。
schedulerName()
→ str
サービスに関連付けられているスケジューラの名前を返します。
setScheduler(name, context_name)
サービスに関連付けるスケジューラインスタンスとそのグラフコンテキストの名前を格納します。 これはサービスの停止と起動をする際に使用します。
getCommand(server_address, server_port, client_num)
→ str
サービスクライアントのコマンド文字列を返します。このコマンド文字列をコール側で使用することで、そのクライアントプロセスを起動することができます。 このコマンド文字列内の環境変数やPDGトークンを展開するかどうかはコール側に委ねられています。
getCommandArgs(server_address, server_port, client_num)
→ list
サービスクライアントのコマンドを引数のリストとして返します。この引数のリストをコール側で使用することで、そのクライアントプロセスを起動することができます。 この引数のリスト内の環境変数やPDGトークンを展開するかどうかはコール側に委ねられています。
getPollingClient()
: PDGNPollingClient
このサービスのMQサーバーにポーリング(問い合わせ)しているクライアントがあれば、そのクライアントを返します。 なければ(例えば、サービスがアイドル中の時)Noneを返します。
getServiceClientName(client_num)
→ str
このメソッドは、指定したクライアント番号を持つクライアントの名前を返します。
クライアント番号は、ゼロから始まるインデックスで、その範囲は0以上pool_size
- 1以下でなければなりません。
stop(stop_mq_server, wait_for_clients)
→ bool
サービスを停止します。
stop_mq_server
がFalse
の場合、このメソッドはMQサーバーを停止しません。
wait_for_clients
がTrue
の場合、このメソッドは、すべてのクライアントがシャットダウンしてMQサーバーから接続解除されるまでは返しません。
成功すればTrue
、失敗すればFalse
を返します。
startReadyListener()
このメソッドは廃止されました。pdg.Service.addClientsコンテキストマネージャに置き換えてください。
incrementStartingClientsCount()
このメソッドは廃止されました。代わりにpdg.Service.addClientsコンテキストマネージャを使用してwith
ステートメント内でpdg.Service.addPendingClientクラスを使用してください。
stopReadyListener()
このメソッドは廃止されました。pdg.Service.addClientsコンテキストマネージャに置き換えてください。
waitForClients()
このメソッドは廃止されました。pdg.Service.addClientsコンテキストマネージャに置き換えてください。
clearScheduler()
サービスがスケジューラサービスの場合、このメソッドは、そのサービスに関連付けられているスケジューラをクリアします。 スケジューラは、サービスが起動できるようになるまでに必ず再び設定しなければなりません。
auto_start
: bool
Property
このプロパティは廃止されました。代わりにpdg.Service.isAutoStartを使用してください。
clients
: list
of str
Property
サービスに追加されているクライアント名のリスト。
client_logging_dir
: str
Property
このプロパティは廃止されました。代わりにpdg.Service.clientLogDirを使用してください。
clientLogDir
: str
Property
クライアントインスタンスによってログファイルが書き出されるディレクトリ。
clientLogType
: pdg.serviceClientLogType
Property
クライアントインスタンスで使用されているログタイプ。
command
: str
Property
PDG Service Managerがサービスのクライアントインスタンスを起動する際に使用するコマンドライン引数。
connectionTimeout
: str
Property
サービスで使用されている接続タイムアウトを格納します。 このタイムアウトは、サービスクライアント、MQサーバー、Houdini間のすべての接続で使用されます。
data
: object
Property
登録されているサービスに関連付けられているpdg.SchedulerTypeがサービスを起動/停止する必要性があるかどうかを示した情報を含んだobject
。
envVarNames
: list
of 'str'
Property
このサービスのプロセスの環境に追加されている環境変数の名前(s)。
envVarValues
: list
of 'str'
Property
このサービスのプロセスの環境に追加されている環境変数の値(s)。
isAutoStart
: bool
Property
サービスが使用される場所で(そのサービスがまだ起動中でない場合に)最初のPDGグラフがクックされる時にそのサービスが自動で開始されるかどうかを示します。
isInternal
: bool
Property
サービスがPDGの内部サービスかどうかを示します。 内部サービスはユーザ側で設定することはできません。
isPersistent
: bool
Property
pdg.ServiceManagerがサービス定義をディスクに保存する時に、サービスがpdgservices.json
ファイルに保存されるかどうかを示します。
memoryLimit
: `int
Property
サービスクライアントもメモリ上限。
この上限に到達すると、クライアントは、memoryResetType
プロパティで定義されているオペレーションを使用してリセットされます。
memoryResetType
: pdg.serviceResetType
Property
サービスクライアントがメモリ上限を越えた時に実行されるリセットオペレーションのタイプ。
mqLogDir
: str
Property
サービスに対して生成されるMQサーバーのログの書き出し先のディレクトリ。
mqLogLevel
: int
Property
サービスに対して生成されるMQサーバーのログレベル。
(0 = なし, 1 = エラー, 2 = 警告, 3 = すべて)
mqserver_log_dir
: str
Property
このプロパティは廃止されました。代わりにpdg.Service.mqLogDirを使用してください。
mqserver_log_level
: int
Property
このプロパティは廃止されました。代わりにpdg.Service.mqLogLevelを使用してください。
mqPort
: int
Property
サービスに関連付けられているMQサーバーが使用しているポートを格納します。
mqUrl
: str
Property
サービスが使用しているMQサーバーのURLを格納します。
name
: str
Property
サービスの名前。
owner
: pdg.serviceOwner
Property
サービスがスケジューラノードまたはHoudiniセッションで所有されているかどうかを示します。
poolSize
: int
Property
サービスプールで利用可能なクライアントの数。
pool_size
: int
Property
このプロパティは廃止されました。代わりにpdg.Service.poolSizeを使用してください。
port
: int
Property
サービスが使用するポート。