msg_buf.h

Go to the documentation of this file.

#ifndef FLEXPTP_MSG_BUF
#define FLEXPTP_MSG_BUF
 
#include <stdbool.h>
#include <stdint.h>
 
#include "ptp_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MSGBUF_TTL_DONT_AGE (0xFFFFFFFF) 
 
#define MSGBUF_TAG_OVERWRITE (0x80000000) 
 
typedef struct {
    bool allocated;    
    bool committed;    
    bool sent;         
    uint32_t tag;      
    uint32_t uid;      
    uint32_t ttl;      
    RawPtpMessage msg; 
} PtpMsgBufBlock;
 
typedef enum {
    MSGB_ERR_NONE = 0, 
    MSGB_ERR_FULL,     
    MSGB_ERR_EXISTS,   
    MSGB_ERR_MISC,     
} PtpMsgBufError;
 
typedef struct {
    uint32_t n;             
    uint32_t used;          
    uint32_t lastUId;       
    uint32_t error;         
    PtpMsgBufBlock *blocks; 
} PtpMsgBuf;
 
void msgb_init(PtpMsgBuf *buf, PtpMsgBufBlock *pool, uint32_t n);
 
RawPtpMessage *msgb_alloc(PtpMsgBuf *buf, uint32_t tag, uint32_t ttl);
 
void msgb_commit(PtpMsgBuf *buf, RawPtpMessage *msg);
 
void msgb_free(PtpMsgBuf *buf, RawPtpMessage *msg);
 
RawPtpMessage *msgb_get_oldest(PtpMsgBuf *buf);
 
RawPtpMessage *msgb_get_by_uid(PtpMsgBuf *buf, uint32_t uid);
 
void msgb_set_sent(PtpMsgBuf *buf, RawPtpMessage *msg);
 
uint32_t msgb_get_uid(const PtpMsgBuf *buf, const RawPtpMessage *msg);
 
RawPtpMessage *msgb_get_sent_by_tag(PtpMsgBuf *buf, uint32_t tag);
 
void msgb_tick(PtpMsgBuf *buf);
 
void msgb_report(PtpMsgBuf *buf);
 
uint32_t msgb_get_error(PtpMsgBuf * buf);
 
#ifdef __cplusplus
}
#endif
 
#endif /* FLEXPTP_MSG_BUF */