syslogmessage.h

Go to the documentation of this file.

#ifndef __LIB3195_SYSLOGMESSAGE_H_INCLUDED__
#define __LIB3195_SYSLOGMESSAGE_H_INCLUDED__ 1

#ifdef __cplusplus
extern "C" {
#endif

#define srSLMGCHECKVALIDOBJECT_API(x) {if((x) == NULL) return SR_RET_NULL_POINTER_PROVIDED; if((x)->OID != OIDsrSLMG) return SR_RET_INVALID_HANDLE;}
#define srSLMGCHECKVALIDOBJECT(x) {assert((x) != NULL);assert((x)->OID == OIDsrSLMG);}

#if (FEATURE_LISTENER == 1) || (FEATURE_MSGAPI == 1)

enum srSLMGFormat_
{
        srSLMGFmt_Invalid = 0,          
        srSLMGFmt_3164RAW = 100,        
        srSLMGFmt_3164WELLFORMED = 101, 
        srSLMGFmt_SIGN_12 = 200         
};
typedef enum srSLMGFormat_ srSLMGFormat;

enum srSLMGTimStampType_
{
        srSLMG_TimStamp_INVALID = 0,            
        srSLMG_TimStamp_3164 = 1,
        srSLMG_TimStamp_3339 = 2
};
typedef enum srSLMGTimStampType_ srSLMGTimStampType;

enum srSLMGSource_
{
        srSLMG_Source_INVALID = 0,              
        srSLMG_Source_OWNGenerated = 1,
        srSLMG_Source_BEEPRAW = 2,
        srSLMG_Source_BEEPCOOKED = 3,
        srSLMG_Source_UDP = 4,
        srSLMG_Source_UX_DFLT_DOMSOCK = 5,
};
typedef enum srSLMGSource_ srSLMGSource;

struct srSLMGObject
{
        srObjID OID;                                    
        unsigned char *pszRawMsg;               
        int bOwnRawMsgBuf;                              
        unsigned char *pszRemoteHost;   
        int bOwnRemoteHostBuf;                  
        srSLMGFormat iFormat;                   
        srSLMGSource iSource;                   
#       if FEATURE_MSGAPI == 1
        int iFacility;                                  
        int iSeverity;                                  
        unsigned char* pszHostname;             
        unsigned char* pszTag;                  
        unsigned char* pszMsg;                  
        int bOwnMsg;                                    
        unsigned char* pszLanguage;             
        /* The timestamp is split through several fields, because this makes it less
         * ambigious and is (hopefully) more portable.
         */
        srSLMGTimStampType iTimStampType;
        int iTimStampYear;
        int iTimStampMonth;
        int iTimStampDay;
        int iTimStampHour;
        int iTimStampMinute;
        int iTimStampSecond;
        int iTimStampSecFrac;
        int iTimStampSecFracPrecision;  
        int iTimStampOffsetHour;
        int iTimStampOffsetMinute;
        char cTimStampOffsetMode;               /* '+'/'-' */
        int     bTimStampIncludesTZ;            
        char *pszTimeStamp;                             
#       endif
};
typedef struct srSLMGObject srSLMGObj;


srRetVal srSLMGConstruct(srSLMGObj **ppThis);

void srSLMGDestroy(srSLMGObj *pThis);

srRetVal srSLMGGetPriority(srSLMGObj *pThis, int *piPrio);

srRetVal srSLMGGetFacility(srSLMGObj *pThis, int *piFac);

srRetVal srSLMGGetRemoteHost(srSLMGObj *pThis, char**ppsz);

srRetVal srSLMGGetHostname(srSLMGObj *pThis, char**ppsz);

srRetVal srSLMGGetTag(srSLMGObj *pThis, unsigned char**ppsz);

srRetVal srSLMGGetMSG(srSLMGObj *pThis, unsigned char**ppsz);

srRetVal srSLMGParseMesg(srSLMGObj *pThis);

srRetVal srSLMGGetRawMSG(srSLMGObj *pThis, unsigned char**ppsz);

srRetVal srSLMGSetRemoteHostIP(srSLMGObj *pThis, char *pszRemHostIP, int bCopyRemHost);

srRetVal srSLMGSetRawMsg(srSLMGObj *pThis, char *pszRawMsg, int bCopyRawMsg);

srRetVal srSLMGSetMSG(srSLMGObj *pThis, char *pszMSG, int bCopyMSG);

srRetVal srSLMGSetTIMESTAMPtoCurrent(srSLMGObj *pThis);

srRetVal srSLMGSetHOSTNAMEtoCurrent(srSLMGObj* pThis);

srRetVal srSLMGFormatRawMsg(srSLMGObj *pThis, srSLMGFormat iFmtToUse);

srRetVal srSLMGSetSeverity(srSLMGObj* pThis, int iNewVal);

srRetVal srSLMGSetFacility(srSLMGObj* pThis, int iNewVal);

srRetVal srSLMGSetTAG(srSLMGObj* pThis, char* pszNewTag);


#endif /* #if (FEATURE_LISTENER == 1) || (FEATURE_MSGAPI == 1) */

#ifdef __cplusplus
};
#endif

#endif

---