gupnp_device_action_callback_set
(PECL gupnp >= 0.1.0)
gupnp_device_action_callback_set — Set device callback function
説明
$root_device
, int $signal
, string $action_name
, mixed $callback
[, mixed $arg
] )Set device callback function for signal and action.
パラメータ
-
root_device -
A root device identifier, returned by gupnp_root_device_new().
-
signal -
The value of signal. Signal can be one of the following values:
-
GUPNP_SIGNAL_ACTION_INVOKED - Emitted whenever an action is invoked. Handler should process action and must call either gupnp_service_action_return() or gupnp_service_action_return_error().
-
GUPNP_SIGNAL_NOTIFY_FAILED - Emitted whenever notification of a client fails.
-
-
action_name -
The name of action.
-
callback -
The callback function for the certain signal. Typically, callback function takes on three parameters. The
serviceparameter's identifier being the first,actionparameter's identifier (in case GUPNP_SIGNAL_ACTION_INVOKED signal) orerrorparameter's message (in case GUPNP_SIGNAL_NOTIFY_FAILED signal) being the second, and theargis third. -
arg -
User data for
callback.
返り値
成功した場合に TRUE を、失敗した場合に FALSE を返します。
エラー / 例外
Issues E_WARNING either with not valid callback function or with not valid signal.