syslog_client.h

Go to the documentation of this file.

 
#ifndef _SYSLOG_CLIENT_H
#define _SYSLOG_CLIENT_H
 
//Dependencies
#include "core/net.h"
 
//Syslog client support
#ifndef SYSLOG_CLIENT_SUPPORT
   #define SYSLOG_CLIENT_SUPPORT DISABLED
#elif (SYSLOG_CLIENT_SUPPORT != ENABLED && SYSLOG_CLIENT_SUPPORT != DISABLED)
   #error SYSLOG_CLIENT_SUPPORT parameter is not valid
#endif
 
//Size of internal buffer
#ifndef SYSLOG_CLIENT_BUFFER_SIZE
   #define SYSLOG_CLIENT_BUFFER_SIZE 512
#elif (SYSLOG_CLIENT_BUFFER_SIZE < 128)
   #error SYSLOG_CLIENT_BUFFER_SIZE parameter is not valid
#endif
 
//Application specific context
#ifndef SYSLOG_CLIENT_PRIVATE_CONTEXT
   #define SYSLOG_CLIENT_PRIVATE_CONTEXT
#endif
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
   SYSLOG_FACILITY_KERNEL       = 0,  
   SYSLOG_FACILITY_USER_LEVEL   = 1,  
   SYSLOG_FACILITY_MAIL         = 2,  
   SYSLOG_FACILITY_SYSTEM       = 3,  
   SYSLOG_FACILITY_SEC_AUTH     = 4,  
   SYSLOG_FACILITY_INTENAL      = 5,  
   SYSLOG_FACILITY_LINE_PRINTER = 6,  
   SYSLOG_FACILITY_NETWORK_NEWS = 7,  
   SYSLOG_FACILITY_UUCP         = 8,  
   SYSLOG_FACILITY_CLOCK        = 9,  
   SYSLOG_FACILITY_SEC_AUTH2    = 10, 
   SYSLOG_FACILITY_FTP          = 11, 
   SYSLOG_FACILITY_NTP          = 12, 
   SYSLOG_FACILITY_LOG_AUDIT    = 13, 
   SYSLOG_FACILITY_LOG_ALERT    = 14, 
   SYSLOG_FACILITY_Clock        = 15, 
   SYSLOG_FACILITY_LOCAL0       = 16, 
   SYSLOG_FACILITY_LOCAL1       = 17, 
   SYSLOG_FACILITY_LOCAL2       = 18, 
   SYSLOG_FACILITY_LOCAL3       = 19, 
   SYSLOG_FACILITY_LOCAL4       = 20, 
   SYSLOG_FACILITY_LOCAL5       = 21, 
   SYSLOG_FACILITY_LOCAL6       = 22, 
   SYSLOG_FACILITY_LOCAL7       = 23  
} SyslogFacility;
 
 
typedef enum
{
   SYSLOG_SEVERITY_EMERGENCY = 0, 
   SYSLOG_SEVERITY_ALERT     = 1, 
   SYSLOG_SEVERITY_CRITICAL  = 2, 
   SYSLOG_SEVERITY_ERROR     = 3, 
   SYSLOG_SEVERITY_WARNING   = 4, 
   SYSLOG_SEVERITY_NOTICE    = 5, 
   SYSLOG_SEVERITY_INFO      = 6, 
   SYSLOG_SEVERITY_DEBUG     = 7  
} SyslogSeverity;
 
 
typedef struct
{
   OsMutex mutex;                            
   NetInterface *interface;                  
   Socket *socket;                           
   char_t buffer[SYSLOG_CLIENT_BUFFER_SIZE]; 
   SYSLOG_CLIENT_PRIVATE_CONTEXT             
} SyslogClientContext;
 
 
//Syslog client related functions
error_t syslogClientInit(SyslogClientContext *context);
 
error_t syslogClientBindToInterface(SyslogClientContext *context,
   NetInterface *interface);
 
error_t syslogClientConnect(SyslogClientContext *context,
   const IpAddr *serverIpAddr, uint16_t serverPort);
 
error_t syslogClientSendMessage(SyslogClientContext *context, uint_t facility,
   uint_t severity, const char_t *message);
 
error_t syslogClientFormatMessage(SyslogClientContext *context, uint_t facility,
   uint_t severity, const char_t *format, ...);
 
error_t syslogClientClose(SyslogClientContext *context);
 
void syslogClientDeinit(SyslogClientContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif