Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_logging.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_logging.h
28 *
29 * @purpose Logging Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 28/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_LOGGING_H_INCLUDED
39 #define OPENAPI_LOGGING_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
46  OPEN_LOG_SEVERITY_UNDEFINED = -1,
47  OPEN_LOG_SEVERITY_EMERGENCY = 0,
48  OPEN_LOG_SEVERITY_ALERT = 1,
49  OPEN_LOG_SEVERITY_CRITICAL = 2,
50  OPEN_LOG_SEVERITY_ERROR = 3,
51  OPEN_LOG_SEVERITY_WARNING = 4,
52  OPEN_LOG_SEVERITY_NOTICE = 5,
53  OPEN_LOG_SEVERITY_INFO = 6,
54  OPEN_LOG_SEVERITY_DEBUG = 7
56 } OPEN_LOG_SEVERITY_t;
57 
58 #define OPENAPI_LOG_FORMAT_BUF_SIZE 512
59 
60 #define OPENAPI_LOG_ENTRY_BUF_SIZE (OPENAPI_LOG_FORMAT_BUF_SIZE + 80)
61 
62 #define OPENAPI_TRAP_ENTRY_SIZE (300)
63 
64 typedef struct
65 {
66  char trapEntry[OPENAPI_TRAP_ENTRY_SIZE];
67 } openapiTrapLogEntry_t;
68 
69 #define OPENAPI_TRAP_LOG_BUF_SIZE (256 * sizeof(openapiTrapLogEntry_t))
70 
71 
72 /*****************************************************************/
86 open_error_t openapiCliCmdLoggingModeSet(openapiClientHandle_t *client_handle,
87  OPEN_CONTROL_t cmdLoggingMode);
88 
89 /*****************************************************************/
103 open_error_t openapiCliCmdLoggingModeGet(openapiClientHandle_t *client_handle,
104  OPEN_CONTROL_t *cmdLoggingMode);
105 
106 /*****************************************************************/
121 open_error_t openapiConsoleLoggingModeSet(openapiClientHandle_t *client_handle,
122  OPEN_CONTROL_t loggingConsoleMode);
123 
124 /*****************************************************************/
138 open_error_t openapiConsoleLoggingModeGet(openapiClientHandle_t *client_handle,
139  OPEN_CONTROL_t *loggingConsoleMode);
140 
141 /*****************************************************************/
158 open_error_t openapiConsoleLoggingSeveritySet(openapiClientHandle_t *client_handle,
159  OPEN_LOG_SEVERITY_t severityLevel);
160 
161 /*****************************************************************/
175 open_error_t openapiConsoleLoggingSeverityGet(openapiClientHandle_t *client_handle,
176  OPEN_LOG_SEVERITY_t *severityLevel);
177 
178 /*****************************************************************/
194 open_error_t openapiPersistentLoggingModeSet(openapiClientHandle_t *client_handle,
195  OPEN_CONTROL_t persistentLoggingMode);
196 
197 /*****************************************************************/
214 open_error_t openapiPersistentLoggingSeverityLevelSet(openapiClientHandle_t *client_handle,
215  OPEN_LOG_SEVERITY_t severityLevel);
216 
217 /*****************************************************************/
232 open_error_t openapiPersistentLoggingModeGet(openapiClientHandle_t *client_handle,
233  OPEN_CONTROL_t *loggingPersistentMode);
234 
235 /*****************************************************************/
250 open_error_t openapiPersistentLoggingSeverityLevelGet(openapiClientHandle_t *client_handle,
251  OPEN_LOG_SEVERITY_t *severityLevel);
252 
253 /*****************************************************************/
268 open_error_t openapiSysLogModeSet(openapiClientHandle_t *client_handle,
269  OPEN_CONTROL_t sysLogMode);
270 
271 /*****************************************************************/
285 open_error_t openapiSysLogModeGet(openapiClientHandle_t *client_handle,
286  OPEN_CONTROL_t *sysLogMode);
287 
288 /*****************************************************************/
306 open_error_t openapiSysLogPortSet(openapiClientHandle_t *client_handle,
307  uint32_t port);
308 
309 /*****************************************************************/
323 open_error_t openapiSysLogPortGet(openapiClientHandle_t *client_handle,
324  uint16_t *port);
325 
326 /*****************************************************************/
349 open_error_t openapiLoggingHostAdd(openapiClientHandle_t *client_handle,
350  open_buffdesc *loggingHost);
351 
352 /*****************************************************************/
374 open_error_t openapiLoggingHostPortSet(openapiClientHandle_t *client_handle,
375  open_buffdesc *loggingHost, uint32_t port);
376 
377 /*****************************************************************/
398 open_error_t openapiLoggingHostSeveritySet(openapiClientHandle_t *client_handle,
399  open_buffdesc *loggingHost,
400  OPEN_LOG_SEVERITY_t severityLevel);
401 
402 /*****************************************************************/
420 open_error_t openapiLoggingHostIpAddrNextGet(openapiClientHandle_t *client_handle,
421  open_buffdesc *loggingHost);
422 
423 /*****************************************************************/
440 open_error_t openapiLoggingHostSeverityGet(openapiClientHandle_t *client_handle,
441  open_buffdesc *loggingHost,
442  OPEN_LOG_SEVERITY_t *severityLevel);
443 
444 /*****************************************************************/
461 open_error_t openapiLoggingHostPortGet(openapiClientHandle_t *client_handle,
462  open_buffdesc *loggingHost,
463  uint16_t *port);
464 
465 /*****************************************************************/
483 open_error_t openapiLoggingHostRemove(openapiClientHandle_t *client_handle,
484  open_buffdesc *loggingHost);
485 
486 /*****************************************************************/
499 open_error_t openapiMaxLoggingHostsSupportedGet(openapiClientHandle_t *client_handle,
500  uint32_t *maxLoggingHosts);
501 
502 /*****************************************************************/
516 open_error_t openapiLoggingHostMaxAddrLenGet(openapiClientHandle_t *client_handle,
517  uint32_t *logHostMaxAddrLen);
518 
519 /*****************************************************************/
536 open_error_t openapiSysLogWrite(openapiClientHandle_t *client_handle,
537  open_buffdesc *logMessage,
538  OPEN_LOG_SEVERITY_t severityLevel);
539 
540 /*****************************************************************/
564 open_error_t openapiBufferedLogEntryNextGet(openapiClientHandle_t *client_handle, uint32_t *logIndex,
565  open_buffdesc *logEntry);
566 
567 /*****************************************************************/
579 open_error_t openapiBufferedLogClear(openapiClientHandle_t *client_handle);
580 
581 /*****************************************************************/
596 open_error_t openapiTrapLogGet(openapiClientHandle_t *client_handle, open_buffdesc *trapLogData,
597  uint32_t *numberOfEntries);
598 
599 /*****************************************************************/
611 open_error_t openapiTrapLogClear(openapiClientHandle_t *client_handle);
612 
613 #endif
614