ycontrol_msg_cmn.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_cmn
#define _H_ycontrol_msg_cmn
 
/*  FILE: ycontrol_msg_cmn.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
 
#include <xmlstring.h>
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_val
#include "val.h"
#endif
 
#ifndef _H_ycontrol_types
#include "ycontrol_types.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
#define YCONTROL_SEND_FAILED (const xmlChar *)"send failed"
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern const xmlChar *
    ycontrol_msg_cmn_get_msgtype (ycontrol_msgtype_t msgtype);
 
 
extern ycontrol_msgtype_t
    ycontrol_msg_cmn_get_msgtype_enum (val_value_t *msgval,
                                       status_t *res);
 
 
extern status_t
    ycontrol_msg_cmn_new (const xmlChar *server_id,
                          const xmlChar *subsys_id,
                          obj_template_t *msgobj,
                          uint32 msgid,
                          ycontrol_msgtype_t msgtype,
                          const xmlChar *service_id,
                          val_value_t **ret_msgval);
 
 
extern status_t
    ycontrol_msg_cmn_reuse (val_value_t *msgval,
                            uint32 msgid,
                            ycontrol_msgtype_t msgtype,
                            const xmlChar *server_id,
                            const xmlChar *subsys_id,
                            const xmlChar *service_id);
 
 
extern status_t
    ycontrol_msg_cmn_new_payload (obj_template_t *msgobj,
                                  val_value_t **ret_payload);
 
 
 
extern status_t
    ycontrol_msg_cmn_new_error (obj_template_t *msgobj,
                                status_t res,
                                const xmlChar *errstr,
                                val_value_t **ret_error);
 
 
extern status_t
    ycontrol_msg_cmn_reuse_error (val_value_t *error_val,
                                  status_t res,
                                  const xmlChar *errstr);
 
 
extern status_t
    ycontrol_msg_cmn_new_ok (obj_template_t *msgobj,
                             val_value_t **ret_ok);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_ycontrol_msg */