syslog_client.h

Go to the documentation of this file.

/**
 * @file syslog_client.h
 * @brief Syslog client
 *
 * @section License
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
 *
 * This file is part of CycloneTCP Open.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * @author Oryx Embedded SARL (www.oryx-embedded.com)
 * @version 2.4.4
 **/
 
#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
 
 
/**
 * @brief Syslog facility values
 **/
 
typedef enum
{
   SYSLOG_FACILITY_KERNEL       = 0,  ///<Kernel messages
   SYSLOG_FACILITY_USER_LEVEL   = 1,  ///<User-level messages
   SYSLOG_FACILITY_MAIL         = 2,  ///<Mail system
   SYSLOG_FACILITY_SYSTEM       = 3,  ///<System daemons
   SYSLOG_FACILITY_SEC_AUTH     = 4,  ///<Security/authorization messages
   SYSLOG_FACILITY_INTENAL      = 5,  ///<Messages generated internally by syslogd
   SYSLOG_FACILITY_LINE_PRINTER = 6,  ///<Line printer subsystem
   SYSLOG_FACILITY_NETWORK_NEWS = 7,  ///<Network news subsystem
   SYSLOG_FACILITY_UUCP         = 8,  ///<UUCP subsystem
   SYSLOG_FACILITY_CLOCK        = 9,  ///<Clock daemon
   SYSLOG_FACILITY_SEC_AUTH2    = 10, ///<Security/authorization messages
   SYSLOG_FACILITY_FTP          = 11, ///<FTP daemon
   SYSLOG_FACILITY_NTP          = 12, ///<NTP subsystem
   SYSLOG_FACILITY_LOG_AUDIT    = 13, ///<Log audit
   SYSLOG_FACILITY_LOG_ALERT    = 14, ///<Log alert
   SYSLOG_FACILITY_Clock        = 15, ///<Clock daemon
   SYSLOG_FACILITY_LOCAL0       = 16, ///<Local use 0
   SYSLOG_FACILITY_LOCAL1       = 17, ///<Local use 1
   SYSLOG_FACILITY_LOCAL2       = 18, ///<Local use 2
   SYSLOG_FACILITY_LOCAL3       = 19, ///<Local use 3
   SYSLOG_FACILITY_LOCAL4       = 20, ///<Local use 4
   SYSLOG_FACILITY_LOCAL5       = 21, ///<Local use 5
   SYSLOG_FACILITY_LOCAL6       = 22, ///<Local use 6
   SYSLOG_FACILITY_LOCAL7       = 23  ///<Local use 7
} SyslogFacility;
 
 
/**
 * @brief Syslog severity values
 **/
 
typedef enum
{
   SYSLOG_SEVERITY_EMERGENCY = 0, ///<System is unusable
   SYSLOG_SEVERITY_ALERT     = 1, ///<Action must be taken immediately
   SYSLOG_SEVERITY_CRITICAL  = 2, ///<Critical conditions
   SYSLOG_SEVERITY_ERROR     = 3, ///<Error conditions
   SYSLOG_SEVERITY_WARNING   = 4, ///<Warning conditions
   SYSLOG_SEVERITY_NOTICE    = 5, ///<Normal but significant condition
   SYSLOG_SEVERITY_INFO      = 6, ///<Informational messages
   SYSLOG_SEVERITY_DEBUG     = 7  ///<Debug-level messages
} SyslogSeverity;
 
 
/**
 * @brief Syslog client context
 **/
 
typedef struct
{
   OsMutex mutex;                            ///<Mutex preventing simultaneous access to the context
   NetInterface *interface;                  ///<Underlying network interface
   Socket *socket;                           ///<Underlying UDP socket
   char_t buffer[SYSLOG_CLIENT_BUFFER_SIZE]; ///<Internal buffer
   SYSLOG_CLIENT_PRIVATE_CONTEXT             ///<Application specific 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