Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_APP_CTRL_NAME_SIZE 17 |
#define | OPEN_APP_CTRL_STATUS_SIZE 512 |
#define | OPEN_APP_CTRL_VERSION_SIZE 20 |
Functions | |
open_error_t | openapiAppCtrlAttrGet (openapiClientHandle_t *client_handle, open_buffdesc *appName, OPEN_CONTROL_t *startOnBoot, OPEN_CONTROL_t *autoRestart, uint32_t *cpuShare, uint32_t *maxMemory) |
Gets start on boot, auto-restart, CPU sharing and memory limit settings for the process entry. More... | |
open_error_t | openapiAppCtrlAttrSet (openapiClientHandle_t *client_handle, open_buffdesc *appName, OPEN_CONTROL_t *startOnBoot, OPEN_CONTROL_t *autoRestart, uint32_t *cpuShare, uint32_t *maxMemory) |
Sets start on boot, auto-restart, CPU sharing and memory limit settings for the process entry. More... | |
open_error_t | openapiAppCtrlEntryCreate (openapiClientHandle_t *client_handle, open_buffdesc *appName) |
Creates a new Application Process Table entry for the given file name. More... | |
open_error_t | openapiAppCtrlEntryDelete (openapiClientHandle_t *client_handle, open_buffdesc *appName) |
Deletes an Application Process Table entry for the given file name. More... | |
open_error_t | openapiAppCtrlStart (openapiClientHandle_t *client_handle, open_buffdesc *appName) |
Starts the process with Process Manager using the parameters configured in the process entry. More... | |
open_error_t | openapiAppCtrlStatusGet (openapiClientHandle_t *client_handle, open_buffdesc *appName, open_buffdesc *status) |
Get application operational status. More... | |
open_error_t | openapiAppCtrlStatusSet (openapiClientHandle_t *client_handle, open_buffdesc *appName, open_buffdesc *status) |
Set application operational status. More... | |
open_error_t | openapiAppCtrlStop (openapiClientHandle_t *client_handle, open_buffdesc *appName) |
Stops the process with Process Manager. More... | |
open_error_t | openapiAppCtrlVersionGet (openapiClientHandle_t *client_handle, open_buffdesc *appName, open_buffdesc *version) |
Get application version identifier. More... | |
open_error_t | openapiAppCtrlVersionSet (openapiClientHandle_t *client_handle, open_buffdesc *appName, open_buffdesc *version) |
Set application version identifier. More... | |
open_error_t openapiAppCtrlAttrGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName, | ||
OPEN_CONTROL_t * | startOnBoot, | ||
OPEN_CONTROL_t * | autoRestart, | ||
uint32_t * | cpuShare, | ||
uint32_t * | maxMemory | ||
) |
Gets start on boot, auto-restart, CPU sharing and memory limit settings for the process entry.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) | |
[out] | startOnBoot | Returns OPEN_ENABLE if start on boot enabled, else OPEN_DISABLE if not |
[out] | autoRestart | Returns OPEN_ENABLE if auto-restart enabled, else OPEN_DISABLE if not |
[out] | cpuShare | Pointer to CPU share percentage |
[out] | maxMemory | Pointer to maximum memory in megabytes the application is allowed to consume |
OPEN_E_NONE | If successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | If failure. |
OpEN API Version: 1.11
open_error_t openapiAppCtrlAttrSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName, | ||
OPEN_CONTROL_t * | startOnBoot, | ||
OPEN_CONTROL_t * | autoRestart, | ||
uint32_t * | cpuShare, | ||
uint32_t * | maxMemory | ||
) |
Sets start on boot, auto-restart, CPU sharing and memory limit settings for the process entry.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) | |
[in] | startOnBoot | Start on boot |
[in] | autoRestart | Auto restart |
[in] | cpuShare | CPU share percentage Maximum value OPEN_MAX_CPU_SHARE |
[in] | maxMemory | Maximum memory in megabytes the application is allowed to consume Maximum value OPEN_MAX_MEMORY_LIMIT |
OPEN_E_NONE | If successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | If failure. |
OpEN API Version: 1.11
open_error_t openapiAppCtrlEntryCreate | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName | ||
) |
Creates a new Application Process Table entry for the given file name.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) |
OPEN_E_NONE | If successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | If failure. |
OpEN API Version: 1.11
open_error_t openapiAppCtrlEntryDelete | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName | ||
) |
Deletes an Application Process Table entry for the given file name.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) |
OPEN_E_NONE | If successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | If failure. |
OpEN API Version: 1.11
open_error_t openapiAppCtrlStart | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName | ||
) |
Starts the process with Process Manager using the parameters configured in the process entry.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) |
OPEN_E_NONE | If successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | If failure. |
OpEN API Version: 1.11
open_error_t openapiAppCtrlStatusGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName, | ||
open_buffdesc * | status | ||
) |
Get application operational status.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) | |
[out] | status | Application status buffer
|
OPEN_E_NONE | if successful. |
OPEN_E_FAIL | if get operation has failed. |
OPEN_E_PARAM | if invalid parameter is supplied. |
OpEN API Version: 1.8
open_error_t openapiAppCtrlStatusSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName, | ||
open_buffdesc * | status | ||
) |
Set application operational status.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) | |
[in] | status | Application status buffer |
OPEN_E_NONE | if application status is set successfully. |
OPEN_E_FAIL | if application status contains non printable characters. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.8
open_error_t openapiAppCtrlStop | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName | ||
) |
Stops the process with Process Manager.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) |
OPEN_E_NONE | If successful. |
OPEN_E_PARAM | Invalid parameter is supplied. |
OPEN_E_ERROR | If failure. |
OpEN API Version: 1.11
open_error_t openapiAppCtrlVersionGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName, | ||
open_buffdesc * | version | ||
) |
Get application version identifier.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) | |
[out] | version | Application version buffer
|
OPEN_E_NONE | if successful. |
OPEN_E_FAIL | if get operation has failed. |
OPEN_E_PARAM | if invalid parameter is supplied. |
OpEN API Version: 1.8
open_error_t openapiAppCtrlVersionSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | appName, | ||
open_buffdesc * | version | ||
) |
Set application version identifier.
[in] | client_handle | Client handle from registration API |
[in] | appName | Application name |
- | Maximum length is (OPENAPI_APP_NAME_SIZE - 1) | |
[in] | version | Application version buffer |
OPEN_E_NONE | if application version is set successfully. |
OPEN_E_FAIL | if application version contains non printable characters. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.8