logwire.h

Go to the documentation of this file.

#pragma once
 
 
#include <cx/buffer/buffer.h>
#include <cx/container/sarray.h>
#include <cx/log/log.h>
#include <cx/log/logctx.h>
 
CX_C_BEGIN
 
enum LOG_WIRE_FRAME {
    LOG_WireSegment = 1,   
    LOG_WireChanDecl,      
    LOG_WireSiteDecl,      
    LOG_WireEntry,         
    LOG_WireGap,           
    LOG_WireSubscribe,     
    LOG_WireCatalog,       
};
 
enum LOG_WIRE_FLAGS {
    LOG_WireOmitCtx = 0x00000001,
};
 
typedef struct LogWireRecord {
    int level;             
    strref chanpath;       
    flags_t chanflags;     
    int64 timestamp;       
    uint64 seq;            
    uint32 batchid;        
    uint32 sample;         
    int trigger;           
    uint8 hops;            
    strref origin;         
    strref msgtmpl;        
    bool istmpl;           
    const stvar* args;     
    int nargs;             
    const stvar* ctx;      
    int nctx;              
} LogWireRecord;
 
typedef struct LogSubSpec {
    sa_string patterns;
 
    int maxlevel;
 
    int64 expiry;
} LogSubSpec;
 
typedef struct LogWireChanInfo {
    strref path;         
    flags_t flags;       
    int maxlevel;        
} LogWireChanInfo;
 
typedef struct LogWireCatalog {
    const LogWireChanInfo* chans;   
    int nchans;                     
} LogWireCatalog;
 
typedef struct LogWireGap {
    uint64 count;      
    uint64 firstseq;   
    uint64 lastseq;    
} LogWireGap;
 
typedef struct LogWireFrame {
    int kind;                     
    const LogWireRecord* rec;     
    const LogWireGap* gap;        
    const LogSubSpec* sub;        
    const LogWireCatalog* cat;    
} LogWireFrame;
 
typedef bool (*LogWireFrameCB)(_In_ const LogWireFrame* frame, _In_opt_ void* ctx);
 
typedef struct LogWireEncoder LogWireEncoder;
 
typedef struct LogWireDecoder LogWireDecoder;
 
_Ret_valid_ LogWireEncoder* logWireEncoderCreate(_In_opt_ strref origin, flags_t flags);
 
void logWireEncoderDestroy(_Inout_ LogWireEncoder** enc);
 
bool logWireEncode(_Inout_ LogWireEncoder* enc, _Inout_ Buffer* out, _In_ const LogRecord* rec);
 
bool logWireEncodeGap(_Inout_ LogWireEncoder* enc, _Inout_ Buffer* out, uint64 n, uint64 firstseq,
                      uint64 lastseq);
 
bool logWireEncodeSub(_Inout_ LogWireEncoder* enc, _Inout_ Buffer* out,
                      _In_opt_ const LogSubSpec* spec);
 
bool logWireEncodeCatalog(_Inout_ LogWireEncoder* enc, _Inout_ Buffer* out,
                          _In_reads_(nchans) const LogWireChanInfo* chans, int nchans);
 
void logWireEndSegment(_Inout_ LogWireEncoder* enc);
 
_Ret_valid_ LogWireDecoder* logWireDecoderCreate(void);
 
void logWireDecoderDestroy(_Inout_ LogWireDecoder** dec);
 
bool logWireDecode(_Inout_ LogWireDecoder* dec, _In_reads_bytes_(len) const uint8* buf, size_t len,
                   _In_ LogWireFrameCB cb, _In_opt_ void* ctx);
 
bool logInject(_In_ strref chanpath, _In_ const LogWireRecord* rec);
 
 
CX_C_END