udp_notif.h

Go to the documentation of this file.

 
#ifndef SYSREPO_UDP_NOTIF_H_
#define SYSREPO_UDP_NOTIF_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <net/if.h>
#include <netinet/in.h>
#include <stdint.h>
#include <time.h>
 
#include "sysrepo.h"
 
#define SRUDPN_VERSION 1
 
#define SRUDPN_HDR_SIZE 12
 
#define SRUDPN_OPT_SEGMENTATION 1
 
#define SRUDPN_OPT_SEGMENTATION_SIZE 4
 
#define SRUDPN_ADDR_STRLEN (INET6_ADDRSTRLEN + IF_NAMESIZE)
 
typedef enum {
    SRUDPN_MT_JSON = 1,             
    SRUDPN_MT_XML = 2,              
    SRUDPN_MT_CBOR = 3,             
    SRUDPN_MT_PRIVATE = 16          
} srudpn_media_type_t;
 
typedef struct {
    uint8_t version;                
    uint8_t s_flag;                 
    uint8_t media_type;             
    uint8_t header_len;             
    uint16_t message_len;           
    uint32_t publisher_id;          
    uint32_t message_id;            
    int segmented;                  
    uint16_t segment_num;           
    int last_segment;               
} srudpn_hdr_t;
 
typedef struct {
    uint32_t datagrams;             
    uint32_t messages;              
    uint32_t dup_segments;          
    uint32_t malformed;             
    uint32_t unsupported;           
    uint32_t reasm_discarded;       
} srudpn_stats_t;
 
typedef struct srudpn_msg_s srudpn_msg_t;
 
typedef struct srudpn_notif_s srudpn_notif_t;
 
typedef struct srudpn_s srudpn_t;
 
int srudpn_open(const char *address, uint16_t port, srudpn_t **udp);
 
int srudpn_get_fd(const srudpn_t *udp);
 
uint16_t srudpn_get_port(const srudpn_t *udp);
 
srudpn_stats_t srudpn_get_stats(const srudpn_t *udp);
 
void srudpn_close(srudpn_t *udp);
 
int srudpn_read_msg(srudpn_t *udp, int32_t timeout_ms, srudpn_msg_t **msg);
 
const srudpn_hdr_t *srudpn_msg_get_hdr(const srudpn_msg_t *msg);
 
srudpn_media_type_t srudpn_msg_get_media_type(const srudpn_msg_t *msg);
 
void srudpn_msg_get_payload(const srudpn_msg_t *msg, const uint8_t **payload, uint32_t *payload_len);
 
void srudpn_msg_get_source(const srudpn_msg_t *msg, char *addr, uint16_t *port);
 
int srudpn_msg_parse(const srudpn_msg_t *msg, const struct ly_ctx *ly_ctx, srudpn_notif_t **notif);
 
void srudpn_msg_free(srudpn_msg_t *msg);
 
const struct lyd_node *srudpn_notif_get_tree(const srudpn_notif_t *notif);
 
const struct lyd_node *srudpn_notif_get_envelope(const srudpn_notif_t *notif);
 
const struct timespec *srudpn_notif_get_event_time(const srudpn_notif_t *notif);
 
void srudpn_notif_free(srudpn_notif_t *notif);
 
typedef struct {
    uint8_t hdr[SRUDPN_HDR_SIZE + SRUDPN_OPT_SEGMENTATION_SIZE]; 
    uint8_t hdr_len;                
    const uint8_t *data;            
    uint16_t data_len;              
} srudpn_dgram_t;
 
int srudpn_encode_notification(const struct lyd_node *notif, const struct timespec *event_time,
        srudpn_media_type_t media_type, uint8_t **payload, uint32_t *payload_len);
 
int srudpn_build_dgrams(srudpn_media_type_t media_type, uint32_t publisher_id, uint32_t message_id,
        const uint8_t *payload, uint32_t payload_len, uint16_t max_segment_size, srudpn_dgram_t **dgrams);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SYSREPO_UDP_NOTIF_H_ */