udpnotif.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, 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_udpnotif
#define _H_udpnotif
 
/*  FILE: udpnotif.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
05-jan-12    abb      Begun
*/
 
#include "ses.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
/********************************************************************
*                                                                   *
*                       C O N S T A N T S                           *
*                                                                   *
*********************************************************************/
 
#define UDPNOTIF_MIN_HDRSIZE  12
#define UDPNOTIF_FIXED_HDRSIZE 12
#define UDPNOTIF_SEGMENT_HDRSIZE 16
 
#define UDPNOTIF_SEGOPT_TYPE 1
#define UDPNOTIF_SEGOPT_LEN  4
 
 
#define UDPNOTIF_PRIVOPT_TYPE 2
 
 
/********************************************************************
*                                                                   *
*                             T Y P E S                             *
*                                                                   *
*********************************************************************/
 
typedef struct udpnotif_hdr1_t_ {
 
    uint32 version : 3;
 
    uint32 space : 1;
 
    uint32 media_type : 4;
 
    uint32 hdrlen : 8;
 
    uint32 msglen : 16;
 
} YPACK udpnotif_hdr1_t;
 
 
typedef struct udpnotif_segoption_t_ {
 
    uint32 type : 8;
 
    uint32 len : 8;
 
    uint32 segment : 15;
 
    uint32 last : 1;
 
} YPACK udpnotif_segoption_t;
 
 
typedef struct udpnotif_privoption_t_ {
 
    uint32 type : 8;
 
    uint32 len : 8;
 
    uint32 descr : 8;
 
    uint32 padding : 8;
 
} YPACK udpnotif_privoption_t;
 
 
typedef union udpnotif_u_hdr1_t_ {
    udpnotif_hdr1_t f;
 
    uint32 u;
} udpnotif_u_hdr1_t;
 
 
typedef union udpnotif_u_segopt_t_ {
    udpnotif_segoption_t f;
 
    uint32 u;
} udpnotif_u_segoption_t;
 
 
typedef struct udpnotif_hdr_t_ {
 
    uint16 hdrlen;
 
    uint16 msglen;
 
    uint32 publisher_id;
 
    uint32 message_id;
 
    uint32 segment;
 
    boolean is_segment;
 
    boolean is_last_segment;
 
    ncx_msg_encoding_t encoding;
 
} YPACK udpnotif_hdr_t;
 
 
 
extern status_t
    udpnotif_get_hdr (const xmlChar *buff,
                      size_t bufflen,
                      udpnotif_hdr_t *rethdr);
 
 
extern int
    udpnotif_read (ses_cb_t *scb);
 
 
extern status_t
    udpnotif_init_scb (ses_cb_t *scb);
 
 
extern void
    udpnotif_clean_scb (ses_cb_t *scb);
 
 
extern uint32
    udpnotif_get_publisher_cnt (const ses_cb_t *scb);
 
 
extern dlq_hdr_t *
    udpnotif_get_msgQ (ses_cb_t *scb,
                       udpnotif_hdr_t *hdr);
 
 
 
extern const xmlChar *
    udpnotif_get_print_addr (const ses_cb_t *scb);
 
 
extern void
    udpnotif_dump_hdr (const udpnotif_hdr_t *hdr,
                       log_debug_t lvl);
 
 
extern status_t
    udpnotif_setup_new_msg (ses_cb_t *scb);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_udpnotif */