ycontrol_msg.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_ycontrol_msg
#define _H_ycontrol_msg
 
/*  FILE: ycontrol_msg.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
08-apr-14    abb      Begun
*/
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern 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);
 
 
extern 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);
 
 
extern 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);
 
 
extern obj_template_t *
    ycontrol_msg_get_service_object (ycontrol_profile_t *profile,
                                     const xmlChar *service_name);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_ycontrol_msg */