yumapro
23.10T-12
YumaPro SDK
|
YControl message send APIs are used to send any of the subsystem message types to the main server. More...
Functions | |
status_t | ycontrol_msg_send (ycontrol_profile_t *profile, const xmlChar *service_id, uint32 *msgid, ycontrol_msgtype_t msgtype, val_value_t *service_payload, status_t msg_status) |
Send a YControl message. More... | |
status_t | ycontrol_msg_send_ex (ycontrol_profile_t *profile, const xmlChar *service_id, uint32 *msgid, ycontrol_msgtype_t msgtype, val_value_t *service_payload, status_t msg_status, uint32 error_index, const xmlChar *error_msg, boolean with_ywattrs, const xmlChar *txid_str) |
Send a YControl message (extended) More... | |
status_t | ycontrol_msg_send_ex2 (ycontrol_profile_t *profile, const xmlChar *service_id, uint32 *msgid, ycontrol_msgtype_t msgtype, val_value_t *service_payload, status_t msg_status, uint32 error_index, const xmlChar *error_msg, boolean with_ywattrs, boolean with_origin, const xmlChar *txid_str) |
Send a YControl message (extended2) More... | |
obj_template_t * | ycontrol_msg_get_service_object (ycontrol_profile_t *profile, const xmlChar *service_name) |
Get the service object from the payload container. More... | |
YControl message send APIs are used to send any of the subsystem message types to the main server.
Multiple variants are provided because parameters were added over time and older APIs cannot be changed, since this would cause existing customer code to stop compiling.
All functions in this module are system APIs for subsystem use only!
obj_template_t * ycontrol_msg_get_service_object | ( | ycontrol_profile_t * | profile, |
const xmlChar * | service_name | ||
) |
Get the service object from the payload container.
profile | ycontrol layer profile to use |
service_name | name of service to find |
status_t ycontrol_msg_send | ( | ycontrol_profile_t * | profile, |
const xmlChar * | service_id, | ||
uint32 * | msgid, | ||
ycontrol_msgtype_t | msgtype, | ||
val_value_t * | service_payload, | ||
status_t | msg_status | ||
) |
Send a YControl message.
profile | ycontrol layer profile to use | |
service_id | service sending this message | |
[in,out] | msgid | address of message ID; for response this is non-zero
|
msgtype | type of YControl message to send | |
service_payload | val_value_t tree to add to message payload NULL if not used | |
msg_status | NO_ERR or error status for message; ignored if service_payload is non-NULL |
status_t ycontrol_msg_send_ex | ( | ycontrol_profile_t * | profile, |
const xmlChar * | service_id, | ||
uint32 * | msgid, | ||
ycontrol_msgtype_t | msgtype, | ||
val_value_t * | service_payload, | ||
status_t | msg_status, | ||
uint32 | error_index, | ||
const xmlChar * | error_msg, | ||
boolean | with_ywattrs, | ||
const xmlChar * | txid_str | ||
) |
Send a YControl message (extended)
profile | ycontrol layer profile to use | |
service_id | service sending this message | |
[in,out] | msgid | address of message ID;
|
msgtype | type of YControl message to send | |
service_payload | val_value_t tree to add to message payload NULL if not used | |
msg_status | NO_ERR or error status for message; ignored if service_payload is non-NULL | |
error_index | error index if sending an <error> response | |
error_msg | error message if sending an <error> response | |
with_ywattrs | TRUE to add the yumaworks-attrs prefix to the attrs map; FALSE if not | |
txid_str | transaction-id string to add (may be NULL to skip) |
status_t ycontrol_msg_send_ex2 | ( | ycontrol_profile_t * | profile, |
const xmlChar * | service_id, | ||
uint32 * | msgid, | ||
ycontrol_msgtype_t | msgtype, | ||
val_value_t * | service_payload, | ||
status_t | msg_status, | ||
uint32 | error_index, | ||
const xmlChar * | error_msg, | ||
boolean | with_ywattrs, | ||
boolean | with_origin, | ||
const xmlChar * | txid_str | ||
) |
Send a YControl message (extended2)
profile | ycontrol layer profile to use | |
service_id | service sending this message | |
[in,out] | msgid | address of message ID;
|
msgtype | type of YControl message to send | |
service_payload | val_value_t tree to add to message payload NULL if not used | |
msg_status | NO_ERR or error status for message; ignored if service_payload is non-NULL | |
error_index | error index if sending an <error> response | |
error_msg | error message if sending an <error> response | |
with_ywattrs | TRUE to add the yumaworks-attrs prefix to the attrs map; FALSE if not | |
with_origin | TRUE to enable adding the origin attribute | |
txid_str | transaction-id string to add (may be NULL to skip) |