メソッド ¶
インスタンスメソッド ¶
addClients()
→ pdg.ServiceAddClientBlock
Opens a context manager that waits for any pending clients to connect.
addPendingClient(server_addr, server_port, client_index)
→ pdg.ServiceClientInfo
Adds a client that’s pending connection, and returns its client info. This
method should be called in a with statement using pdg.Service.addClients.
client(client_name)
→ pdg.ServiceClientInfo
Return the client info given the name of the client.
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
Returns the polling client for this service’s MQ server, if applicable. Returns None if there is none; for example, when the service is idle.
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()
This method is deprecated, and should be replaced with a class to pdg.Service.addPendingClient inside of a with statement using the pdg.Service.addClients context manager.
stopReadyListener()
このメソッドは廃止されました。pdg.Service.addClientsコンテキストマネージャに置き換えてください。
waitForClients()
このメソッドは廃止されました。pdg.Service.addClientsコンテキストマネージャに置き換えてください。
clearScheduler()
サービスがスケジューラサービスの場合、このメソッドは、そのサービスに関連付けられているスケジューラをクリアします。 スケジューラは、サービスが起動できるようになるまでに必ず再び設定しなければなりません。
auto_start
: bool
Property
This property is deprecated. Use pdg.Service.isAutoStart instead.
clients
: list
of str
Property
The list of client names that have been added to the service.
client_logging_dir
: str
Property
This property is deprecated. Use pdg.Service.clientLogDir instead.
clientLogDir
: str
Property
クライアントインスタンスによってログファイルが書き出されるディレクトリ。
clientLogType
: pdg.serviceClientLogType
Property
The log type used by client instances.
command
: str
Property
PDG Service Managerがサービスのクライアントインスタンスを起動する際に使用するコマンドライン引数。
connectionTimeout
: str
Property
サービスで使用されている接続タイムアウトを格納します。 このタイムアウトは、サービスクライアント、MQサーバー、Houdini間のすべての接続で使用されます。
data
: object
Property
登録されているサービスに関連付けられているpdg.SchedulerTypeがサービスを起動/停止する必要性があるかどうかを示した情報を含んだobject。
envVarNames
: list
of 'str'
Property
The names of the environment variables to be added to the environment for this service’s processes.
envVarValues
: list
of 'str'
Property
The values of the environment variables to be added to the environment for this service’s processes.
isAutoStart
: bool
Property
Indicates if the service should be automatically started on the first PDG graph cook where the service is used (if the service is not already running).
isInternal
: bool
Property
サービスがPDGの内部サービスかどうかを示します。 内部サービスはユーザ側で設定することはできません。
isPersistent
: bool
Property
Indicates whether or not the service is saved to the pdgservices.json
file when the pdg.ServiceManager saves service definitions to disk.
memoryLimit
: `int
Property
The memory limit for service clients. When this limit is reached, the client
is reset using the operation defined by the memoryResetType property.
memoryResetType
: pdg.serviceResetType
Property
The type of reset operation to perform a when service client exceeds the memory limit.
mqLogDir
: str
Property
サービスに対して生成されるMQサーバーのログの書き出し先のディレクトリ。
mqLogLevel
: int
Property
サービスに対して生成されるMQサーバーのログレベル。
(0 = なし, 1 = エラー, 2 = 警告, 3 = すべて)
mqserver_log_dir
: str
Property
This property is deprecated. Use pdg.Service.mqLogDir instead.
mqserver_log_level
: int
Property
This property is deprecated. Use pdg.Service.mqLogLevel instead.
mqPort
: int
Property
サービスに関連付けられているMQサーバーが使用しているポートを格納します。
mqUrl
: str
Property
サービスが使用しているMQサーバーのURLを格納します。
name
: str
Property
サービスの名前。
owner
: pdg.serviceOwner
Property
サービスがスケジューラノードまたはHoudiniセッションで所有されているかどうかを示します。
poolSize
: int
Property
The number of clients available in the service pool.
pool_size
: int
Property
This property is deprecated. Use pdg.Service.poolSize instead.
port
: int
Property
サービスが使用するポート。