ses_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_ses_msg
#define _H_ses_msg
/*  FILE: ses_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
----------------------------------------------------------------------
20-jan-07    abb      Begun.
*/
 
#include <xmlstring.h>
#include <xmlreader.h>
 
#ifndef _H_dlq
#include  "dlq.h"
#endif
 
#ifndef _H_log
#include  "log.h"
#endif
 
#ifndef _H_ses
#include  "ses.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
 
 
 
/********************************************************************
*                                                                   *
*                             T Y P E S                             *
*                                                                   *
*********************************************************************/
 
typedef struct ses_msg_tempchunk_t_ {
    dlq_hdr_t  qhdr;       
    xmlChar    *chunk;     
    uint32      chunklen;  
} ses_msg_tempchunk_t;
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
 
extern void
    ses_msg_init (void);
 
 
 
extern void
    ses_msg_cleanup (void);
 
 
extern status_t
    ses_msg_new_msg (ses_msg_t **msg);
 
 
extern void
    ses_msg_free_msg (ses_cb_t *scb,
              ses_msg_t *msg);
 
 
extern status_t
    ses_msg_new_buff (ses_cb_t *scb,
                      boolean outbuff,
                      ses_msg_buff_t **buff);
 
 
extern void
    ses_msg_free_buff (ses_cb_t *scb,
               ses_msg_buff_t *buff);
 
 
extern status_t
    ses_msg_write_buff (ses_cb_t *scb,
                        ses_msg_buff_t *buff,
                        xmlChar ch);
 
 
extern status_t
    ses_msg_send_buffs (ses_cb_t *scb,
                        boolean *anyout);
 
 
extern status_t
    ses_msg_new_output_buff (ses_cb_t *scb,
                             boolean start_chunk_mode);
 
 
extern void
    ses_msg_make_inready (ses_cb_t *scb);
 
 
extern void
    ses_msg_make_outready (ses_cb_t *scb);
 
 
extern void
    ses_msg_make_outready_ycontrol (ses_cb_t *scb);
 
 
extern void
    ses_msg_finish_outmsg (ses_cb_t *scb);
 
 
extern ses_ready_t *
    ses_msg_get_first_inready (boolean ycontrol);
 
 
extern ses_ready_t *
    ses_msg_get_first_inready_ses (ses_id_t sid);
 
 
extern ses_ready_t *
    ses_msg_get_first_outready (void);
 
 
extern ses_ready_t *
    ses_msg_get_first_outready_ycontrol (void);
 
 
extern void
  ses_msg_dump (log_debug_t lvl,
                const ses_msg_t *msg,
                const xmlChar *text);
 
 
 extern void
    ses_msg_add_framing (ses_cb_t *scb,
                         ses_msg_buff_t *buff);
 
 
extern void
    ses_msg_init_buff (ses_cb_t *scb,
                       boolean outbuff,
                       ses_msg_buff_t *buff);
 
 
extern status_t
    ses_msg_reset_message (ses_cb_t *scb,
                           ses_msg_t *msg,
                           dlq_hdr_t *tempchunkQ);
 
 
extern ses_msg_tempchunk_t *
    ses_msg_new_tempchunk (xmlChar *chunk,
                           uint32 chunklen);
 
 
extern void
    ses_msg_free_tempchunk (ses_msg_tempchunk_t *tc);
 
 
extern void
    ses_msg_clean_tempchunkQ (dlq_hdr_t *tempchunkQ);
 
 
extern uint32
    ses_msg_size_tempchunkQ (dlq_hdr_t *tempchunkQ);
 
 
extern ses_msg_buff_t *
    ses_msg_first_outbuff (ses_cb_t *scb);
 
 
extern ses_msg_buff_t *
    ses_msg_next_outbuff (ses_cb_t *scb,
                          ses_msg_buff_t *curbuff);
 
 
extern size_t
    ses_msg_buff_size (ses_msg_buff_t *buff);
 
 
extern size_t
    ses_msg_copy_buff (ses_msg_buff_t *buff,
                       xmlChar *retbuff,
                       size_t retbuff_size);
 
 
extern void
    ses_msg_clean_outbuffs (ses_cb_t *scb);
 
 
extern xmlChar *
    ses_msg_convert_outbuffs (ses_cb_t *scb,
                              uint32 *len);
 
 
extern status_t
    ses_msg_add_input_msg (ses_cb_t *scb,
                           xmlChar *data,
                           size_t datalen);
 
extern void
    ses_msg_clean_msgQ (ses_cb_t *scb);
 
 
extern boolean
    ses_msg_is_binary (const ses_msg_t *msg);
 
 
extern boolean
    ses_msg_is_json (const ses_msg_t *msg);
 
 
extern xmlChar *
    ses_msg_get_onebuff (ses_msg_t *msg,
                         xmlChar **retbuff,
                         uint32 *retlen);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif            /* _H_ses_msg */