Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Macros | Enumerations | Functions
openapi_logging.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Data Structures

struct  openapiTrapLogEntry_t
 

Macros

#define OPENAPI_LOG_ENTRY_BUF_SIZE   (OPENAPI_LOG_FORMAT_BUF_SIZE + 80)
 
#define OPENAPI_LOG_FORMAT_BUF_SIZE   512
 
#define OPENAPI_TRAP_ENTRY_SIZE   (300)
 
#define OPENAPI_TRAP_LOG_BUF_SIZE   (256 * sizeof(openapiTrapLogEntry_t))
 

Enumerations

enum  OPEN_LOG_SEVERITY_t {
  OPEN_LOG_SEVERITY_UNDEFINED = -1, OPEN_LOG_SEVERITY_EMERGENCY = 0, OPEN_LOG_SEVERITY_ALERT = 1, OPEN_LOG_SEVERITY_CRITICAL = 2,
  OPEN_LOG_SEVERITY_ERROR = 3, OPEN_LOG_SEVERITY_WARNING = 4, OPEN_LOG_SEVERITY_NOTICE = 5, OPEN_LOG_SEVERITY_INFO = 6,
  OPEN_LOG_SEVERITY_DEBUG = 7
}
 OpEN uses this enumeration to define Logging Severity Levels. More...
 

Functions

open_error_t openapiBufferedLogClear (openapiClientHandle_t *client_handle)
 Clear the content of the buffered messages log. More...
 
open_error_t openapiBufferedLogEntryNextGet (openapiClientHandle_t *client_handle, uint32_t *logIndex, open_buffdesc *logEntry)
 Get the next entry in the in-memory (buffered) message log. More...
 
open_error_t openapiCliCmdLoggingModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *cmdLoggingMode)
 Get CLI command logging mode. More...
 
open_error_t openapiCliCmdLoggingModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t cmdLoggingMode)
 Enable or disable CLI command logging. More...
 
open_error_t openapiConsoleLoggingModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *loggingConsoleMode)
 Get Console Logging mode. More...
 
open_error_t openapiConsoleLoggingModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t loggingConsoleMode)
 Set Console Logging mode. More...
 
open_error_t openapiConsoleLoggingSeverityGet (openapiClientHandle_t *client_handle, OPEN_LOG_SEVERITY_t *severityLevel)
 Get Console Logging severity level. More...
 
open_error_t openapiConsoleLoggingSeveritySet (openapiClientHandle_t *client_handle, OPEN_LOG_SEVERITY_t severityLevel)
 Set Console Logging severity level. More...
 
open_error_t openapiLoggingHostAdd (openapiClientHandle_t *client_handle, open_buffdesc *loggingHost)
 Add a logging host. More...
 
open_error_t openapiLoggingHostIpAddrNextGet (openapiClientHandle_t *client_handle, open_buffdesc *loggingHost)
 Get logging host IP address. More...
 
open_error_t openapiLoggingHostMaxAddrLenGet (openapiClientHandle_t *client_handle, uint32_t *logHostMaxAddrLen)
 Get the maximum length of logging host address. More...
 
open_error_t openapiLoggingHostPortGet (openapiClientHandle_t *client_handle, open_buffdesc *loggingHost, uint16_t *port)
 Get logging host port. More...
 
open_error_t openapiLoggingHostPortSet (openapiClientHandle_t *client_handle, open_buffdesc *loggingHost, uint32_t port)
 Set port number to the logging host. More...
 
open_error_t openapiLoggingHostRemove (openapiClientHandle_t *client_handle, open_buffdesc *loggingHost)
 Remove a logging host entry. More...
 
open_error_t openapiLoggingHostSeverityGet (openapiClientHandle_t *client_handle, open_buffdesc *loggingHost, OPEN_LOG_SEVERITY_t *severityLevel)
 Get logging host severity level. More...
 
open_error_t openapiLoggingHostSeveritySet (openapiClientHandle_t *client_handle, open_buffdesc *loggingHost, OPEN_LOG_SEVERITY_t severityLevel)
 Set severity level to the logging host. More...
 
open_error_t openapiMaxLoggingHostsSupportedGet (openapiClientHandle_t *client_handle, uint32_t *maxLoggingHosts)
 Get the maximum logging hosts supported. More...
 
open_error_t openapiPersistentLoggingModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *loggingPersistentMode)
 Get the persistent logging mode. More...
 
open_error_t openapiPersistentLoggingModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t persistentLoggingMode)
 Set the persistent logging mode. More...
 
open_error_t openapiPersistentLoggingSeverityLevelGet (openapiClientHandle_t *client_handle, OPEN_LOG_SEVERITY_t *severityLevel)
 Get the persistent logging severity level. More...
 
open_error_t openapiPersistentLoggingSeverityLevelSet (openapiClientHandle_t *client_handle, OPEN_LOG_SEVERITY_t severityLevel)
 Set persistent logging severity level. More...
 
open_error_t openapiSysLogModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *sysLogMode)
 Get syslog mode. More...
 
open_error_t openapiSysLogModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t sysLogMode)
 Set the syslog mode. More...
 
open_error_t openapiSysLogPortGet (openapiClientHandle_t *client_handle, uint16_t *port)
 Get syslog port. More...
 
open_error_t openapiSysLogPortSet (openapiClientHandle_t *client_handle, uint32_t port)
 Set syslog port. More...
 
open_error_t openapiSysLogWrite (openapiClientHandle_t *client_handle, open_buffdesc *logMessage, OPEN_LOG_SEVERITY_t severityLevel)
 Write system log. More...
 
open_error_t openapiTrapLogClear (openapiClientHandle_t *client_handle)
 Clear the content of the trap log. More...
 
open_error_t openapiTrapLogGet (openapiClientHandle_t *client_handle, open_buffdesc *trapLogData, uint32_t *numberOfEntries)
 Retrieve the content of the trap log. More...