Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
Welcome
ADK Documentation
API Reference
Files
File List
Globals
api
include
openapi_switch_cpu.h
Go to the documentation of this file.
1
9
/*********************************************************************
10
*
11
* Copyright 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_switch_cpu.h
28
*
29
* @purpose Switch CPU API
30
*
31
* @component OpEN
32
*
33
* @create 08/31/2018
34
*
35
* @end
36
*
37
**********************************************************************/
38
#ifndef OPENAPI_SWITCH_CPU_H_INCLUDED
39
#define OPENAPI_SWITCH_CPU_H_INCLUDED
40
41
#include "
openapi_common.h
"
42
43
#define OPEN_CPU_UTIL_SCALAR 10000
44
45
typedef
struct
46
{
47
uint32_t
timePeriod
;
48
uint32_t
utilization
;
49
}
OPEN_CPU_PERIOD_UTIL_INFO_t
;
50
51
/*****************************************************************/
73
open_error_t
openapiTotalCpuUtilArrayGet
(
openapiClientHandle_t
*client_handle,
74
open_buffdesc
*data);
75
76
/*****************************************************************/
90
open_error_t
openapiCpuUtilMaxPeriodsGet
(
openapiClientHandle_t
*client_handle,
91
uint32_t *max);
92
93
#endif
/* OPENAPI_SWITCH_CPU_H_INCLUDED */
94
OPEN_CPU_PERIOD_UTIL_INFO_t::timePeriod
uint32_t timePeriod
Time period (secs) over which CPU utilization is being measured.
Definition:
openapi_switch_cpu.h:47
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition:
openapi_common.h:64
openapiTotalCpuUtilArrayGet
open_error_t openapiTotalCpuUtilArrayGet(openapiClientHandle_t *client_handle, open_buffdesc *data)
Get CPU utilization for all tracked periods.
open_buffdesc
Definition:
openapi_common.h:136
openapiClientHandle_s
Definition:
openapi_common.h:129
OPEN_CPU_PERIOD_UTIL_INFO_t
Definition:
openapi_switch_cpu.h:45
OPEN_CPU_PERIOD_UTIL_INFO_t::utilization
uint32_t utilization
Utilization of the CPU (% * OPEN_CPU_UTIL_SCALAR)
Definition:
openapi_switch_cpu.h:48
openapiCpuUtilMaxPeriodsGet
open_error_t openapiCpuUtilMaxPeriodsGet(openapiClientHandle_t *client_handle, uint32_t *max)
Get the maximum number of periods tracked for CPU utilization.
openapi_common.h
© 2019 by Broadcom. All rights reserved.