| Inheritance |
|
グローバルサービスマネージャを取得したいのであれば、以下のコードを使用します:
service_manager = pdg.ServiceManager.get()
メソッド ¶
静的メソッド ¶
saveRegisteredServices()
Static method
登録されているサービスとその設定をすべてユーザープリファレンスフォルダに保存します。
インスタンスメソッド ¶
registerService(type_name, service_name, pool_size, port, auto_start, client_logging_dir, mqserver_log_level=0, mqserver_log_dir="$HOUDINI_TEMP_DIR", connection_timeout=5000, client_logging_type=
pdg.serviceClientLogType.File, persistent=True)
→ pdg.Service
サービスを登録します。
type_name引数には、必ず有効なpdg.ServiceTypeの名前を指定してください。
service_name引数には、そのサービスに関して人に分かりやすい名前を指定してください。
pool_size引数には、サービスが起動された時に使用されるクライアントインスタンスの数を指定します。
scheduler_type引数には、ここで登録するサービスと関連付けるpdg.SchedulerTypeを指定します。
このメソッドに渡すscheduler_typeは、必ずPDGサービスに対応していなければなりません。
port引数には、ポート番号を指定します。
ポート番号に0を指定すると、そのポートは自動的に決定されます。
auto_start引数には、サービスを自動的に起動するかどうかを指定します。
client_logging_dir引数には、クライアントインスタンスがログファイルを書き出すディレクトリを指定します。
登録に成功すると、このメソッドはpdg.Serviceインスタンスを返します。
deregisterService(name)
PDGサービスマネージャの登録からサービスを削除します。
nameは必ず有効なサービスの名前でなければなりません。
registerSessionService(type_name, service_name, pool_size, port, auto_start, client_logging_dir, mqserver_log_level=0, mqserver_log_dir="$HOUDINI_TEMP_DIR", connection_timeout=5000, client_logging_type=
pdg.serviceClientLogType.File, persistent=True)
→ pdg.Service
セッションサービスを登録します。
type_name引数には、必ず有効なpdg.ServiceTypeの名前を指定してください。
service_name引数には、そのサービスに関して人に分かりやすい名前を指定してください。
pool_size引数には、サービスが起動された時に使用されるクライアントインスタンスの数を指定します。
port引数には、ポート番号を指定します。
ポート番号に0を指定すると、そのポートは自動的に決定されます。
auto_start引数には、サービスを自動的に起動するかどうかを指定します。
client_logging_dir引数には、クライアントインスタンスがログファイルを書き出すディレクトリを指定します。
mqserver_log_level引数には、MQサーバープロセスのログレベル(0 = なし, 1 = エラー, 2 = 警告, 3 = すべて)を指定します。
デフォルトのログレベルは0です。
mqserver_log_dir引数には、MQサーバープロセスがログファイルを書き出すディレクトリを指定します。
デフォルトでは、ログファイルはHoudiniの一時ディレクトリに書き出されます。
登録に成功すると、このメソッドはpdg.Serviceインスタンスを返します。
startService(name)
→ bool
PDGサービスを起動します。
成功すればTrue、失敗すればFalseを返します。
stopService(name, ignore_stopped=False)
→ bool
起動中のPDGサービスを停止します。
成功すればTrue、失敗すればFalseを返します。
ignore_stoppedがTrueの場合、サービスが既に停止されている、または、現在停止中の場合であっても、このメソッドは成功します。
ignore_stoppedがFalseの場合、このメソッドは、現在起動されていないサービスに対してコールすると失敗します。
resetClient(service_name, client_name="")
→ bool
起動中のPDGサービスをリセットします。
リセットによって実行されるアクションは、サービスタイプで定義されています。
成功すればTrue、失敗すればFalseを返します。
client_nameを指定した場合、その名前のクライアントのサービスのみがリセットされます。
restartClient(service_name, client_name="")
→ bool
Restarts a sevice client, or all service clients if client_name is not
specified. Returns True for success, and False for failure.
stopClient(service_name, client_name="")
→ bool
Stops a sevice client, or all service clients if client_name is not
specified. Returns True for success, and False for failure.
resetService(service_name, client_name="")
→ bool
This method is deprecated. Use pdg.ServiceManager.resetClient instead.
registeredServiceNames()
→ list
of str
PDGサービスマネージャに登録されているすべてのサービスの名前のlistを返します。
hasServiceSupport(scheduler_type)
→ bool
scheduler_type引数で指定されたpdg.SchedulerTypeが起動中のPDGサービスに対応しているかどうかをチェックします。
Methods from pdg.EventEmitter ¶
addEventHandler(handler, filter=pdg.EventType.All, pass_handler=False)
→ pdg.PyEventHandler
受信するイベントタイプの値を指定してイベントハンドラーをエミッターに追加します。
handlerには、pdg.Eventタイプの引数に対応したコール可能オブジェクトを指定してください。
pass_handlerがTrueの場合、handler自体が1番目の引数としてこの関数に渡されます。
Falseの場合、イベントオブジェクトのみがこの関数に渡されます。
hasEventHandler(handler)
→ bool
handler関数またはコールバックオブジェクトを使用しているイベントハンドラーをイベントエミッターが既に持っていればTrueを返します。
removeEventHandler(handler)
エミッターからイベントハンドラーを削除します。
removeAllEventHandlers()
エミッターからすべてのイベントハンドラーを削除します。
eventHandlers
→ list
of pdg.EventHandler
Property
エミッターのすべてのアクティブなイベントハンドルのリストを返します。
supportedEventTypes
→ list
of `pdg.EventType
Property
PDGがクック中にこのイベントエミッターが生成できるイベントタイプのリスト。