yumapro  20.10-14
YumaPro SDK
Message Send APIs

YControl message send APIs are used to send any of the subsystem message types to the main server. More...

Collaboration diagram for Message Send APIs:

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_tycontrol_msg_get_service_object (ycontrol_profile_t *profile, const xmlChar *service_name)
 Get the service object from the payload container. More...
 

Detailed Description

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!

Function Documentation

◆ ycontrol_msg_get_service_object()

obj_template_t* ycontrol_msg_get_service_object ( ycontrol_profile_t profile,
const xmlChar *  service_name 
)

Get the service object from the payload container.

Parameters
profileycontrol layer profile to use
service_namename of service to find
Returns
pointer to object template; NULL if not found
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ycontrol_msg_send()

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.

Parameters
profileycontrol layer profile to use
service_idservice sending this message
msgidaddress of message ID;
for response this is non-zero
msgtypetype of YControl message to send
service_payloadval_value_t tree to add to message payload
NULL if not used
msg_statusNO_ERR or error status for message; ignored if service_payload is non-NULL
Return values
*msgidset to the message ID assigned to the message, if *msgid was zero on input:
Returns
status
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ycontrol_msg_send_ex()

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)

Parameters
profileycontrol layer profile to use
service_idservice sending this message
msgidaddress of message ID;
for response this is non-zero
msgtypetype of YControl message to send
service_payloadval_value_t tree to add to message payload
NULL if not used
msg_statusNO_ERR or error status for message; ignored if service_payload is non-NULL
error_indexerror index if sending an <error> response
error_msgerror message if sending an <error> response
with_ywattrsTRUE to add the yumaworks-attrs prefix to the attrs map; FALSE if not
txid_strtransaction-id string to add (may be NULL to skip)
Return values
*msgidset to the message ID assigned to the message, if *msgid was zero on input:
Returns
status
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ycontrol_msg_send_ex2()

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)

Parameters
profileycontrol layer profile to use
service_idservice sending this message
msgidaddress of message ID;
for response this is non-zero
msgtypetype of YControl message to send
service_payloadval_value_t tree to add to message payload
NULL if not used
msg_statusNO_ERR or error status for message; ignored if service_payload is non-NULL
error_indexerror index if sending an <error> response
error_msgerror message if sending an <error> response
with_ywattrsTRUE to add the yumaworks-attrs prefix to the attrs map; FALSE if not
with_originTRUE to enable adding the origin attribute
txid_strtransaction-id string to add (may be NULL to skip)
Return values
*msgidset to the message ID assigned to the message, if *msgid was zero on input:
Returns
status
Here is the call graph for this function:
Here is the caller graph for this function: