Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_app_ctrl.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_app_ctrl.h
28 *
29 * @purpose Application Controls
30 *
31 * @component OpEN
32 *
33 * @create 11/23/2015
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_APP_CTRL_H_INCLUDED
39 #define OPENAPI_APP_CTRL_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /* max size for application status and version strings (including terminating NULL) */
44 #define OPEN_APP_CTRL_NAME_SIZE 17
45 #define OPEN_APP_CTRL_STATUS_SIZE 512
46 #define OPEN_APP_CTRL_VERSION_SIZE 20
47 
48 /*****************************************************************/
64 open_error_t openapiAppCtrlEntryCreate(openapiClientHandle_t *client_handle,
65  open_buffdesc *appName);
66 
67 /*****************************************************************/
86 open_error_t openapiAppCtrlEntryDelete(openapiClientHandle_t *client_handle,
87  open_buffdesc *appName);
88 
89 /*****************************************************************/
112 open_error_t openapiAppCtrlAttrGet(openapiClientHandle_t *client_handle,
113  open_buffdesc *appName,
114  OPEN_CONTROL_t *startOnBoot,
115  OPEN_CONTROL_t *autoRestart,
116  uint32_t *cpuShare,
117  uint32_t *maxMemory);
118 
119 /*****************************************************************/
148 open_error_t openapiAppCtrlAttrSet(openapiClientHandle_t *client_handle,
149  open_buffdesc *appName,
150  OPEN_CONTROL_t *startOnBoot,
151  OPEN_CONTROL_t *autoRestart,
152  uint32_t *cpuShare,
153  uint32_t *maxMemory);
154 
155 /*****************************************************************/
171 open_error_t openapiAppCtrlStart(openapiClientHandle_t *client_handle,
172  open_buffdesc *appName);
173 
174 /*****************************************************************/
189 open_error_t openapiAppCtrlStop(openapiClientHandle_t *client_handle,
190  open_buffdesc *appName);
191 
192 /*****************************************************************/
211 open_error_t openapiAppCtrlStatusGet(openapiClientHandle_t *client_handle,
212  open_buffdesc *appName,
213  open_buffdesc *status);
214 
215 /*****************************************************************/
241 open_error_t openapiAppCtrlStatusSet(openapiClientHandle_t *client_handle,
242  open_buffdesc *appName,
243  open_buffdesc *status);
244 
245 /*****************************************************************/
264 open_error_t openapiAppCtrlVersionGet(openapiClientHandle_t *client_handle,
265  open_buffdesc *appName,
266  open_buffdesc *version);
267 
268 /*****************************************************************/
296 open_error_t openapiAppCtrlVersionSet(openapiClientHandle_t *client_handle,
297  open_buffdesc *appName,
298  open_buffdesc *version);
299 
300 #endif /* OPENAPI_APP_CTRL_H_INCLUDED */
301