Types
API core data types. More...
Data Structures | |
| struct | zos_buffer_t |
| Generic data buffer type. More... | |
Typedefs | |
| typedef uint8_t | zos_bool_t |
| boolean type | |
| typedef void(* | zos_stream_event_handler_t) (uint32_t handle) |
| Data stream event handler prototype. More... | |
Detailed Description
API core data types.
Typedef Documentation
| typedef void(* zos_stream_event_handler_t) (uint32_t handle) |
Data stream event handler prototype.
- Parameters
-
handleThe handle of the data stream
Enumeration Type Documentation
| anonymous enum |
| Enumerator | |
|---|---|
| ZOS_FALSE |
False value, zos_bool_t. |
| ZOS_TRUE |
True value, zos_bool_t. |
| enum zos_app_flag_t |
| enum zos_app_priority_t |
| enum zos_app_type_t |
| enum zos_result_t |
Result codes for API calls.
| Enumerator | |
|---|---|
| ZOS_SUCCESS |
Complete successfully. |
| ZOS_PENDING |
Results still pending. |
| ZOS_TIMEOUT |
Timed-out waiting for result. |
| ZOS_ERROR |
Failed with general error. |
| ZOS_INVALID_ARG |
Invalid arg supplied to API call. |
| ZOS_UNSUPPORTED |
The given argument is not supported. |
| ZOS_NOTUP |
Interface is not currently Up. |
| ZOS_NOT_FOUND |
The requested argument is not found. |
| ZOS_ABORTED |
Aborted will executing. |
| ZOS_NOT_CONNECTED |
Not remotely connected. |
| ZOS_INVALID_INTERFACE |
The supplied interface is invalid (zos_interface_t ) |
| ZOS_NO_MEM |
Out of Heap memory. |
| ZOS_DECRYPT_ERROR |
Error decrypting encrypted file/data. |
| ZOS_NO_CHANGE |
No change occurred from the previous call. |
| ZOS_EXTERNAL_CMD_FAILED |
Failed to execute serial command. |
| ZOS_NULL_PTR |
Supplied a null pointer as argument. |
| ZOS_UNINITIALIZED |
Attempting to use API without initializing first. |
| ZOS_NEVER_SET |
Failed to set variable first. |
| ZOS_SHUTTING_DOWN |
The ZAP or interface is shutdown. |
| ZOS_INVALID_HEADER |
Invalid header encountered. |
| ZOS_UNDERFLOW |
Data underflow. |
| ZOS_HTTP_UNAUTHORIZED |
HTTP server returned 403 response code. |
| ZOS_HTTP_SERVER_ERROR |
HTTP server returned 50x response code. |
| ZOS_HTTP_NOT_FOUND |
HTTP server returned 404 response code. |
| ZOS_HTTP_BAD_REQUEST |
HTTP server returned 400 response code. |
| ZOS_NO_SSID |
WLAN SSID (i.e. network name) not configured and required. |
| ZOS_NO_PASSKEY |
WLAN passowrd not configured and required. |
| ZOS_SEMAPHORE_ERROR |
Error while waiting for semaphore. |
| ZOS_WAIT_ABORTED |
Abort while waiting for semaphore, mutex, or other RTOS construct. |
| ZOS_QUEUE_MESSAGE_UNALIGNED |
Messages supplied to rtos queue api must be 32bit aligned. |
| ZOS_UNIMPLEMENTED |
The given API hasn't been implemented yet. |
| ZOS_CMD_SUCCESS |
The ZentriOS command completed successfully. |
| ZOS_CMD_FAILED |
The command failed, probably in the firmware somewhere. |
| ZOS_CMD_PARSE_ERROR |
Failed to parse the command. |
| ZOS_CMD_UNKNOWN |
Unknown command. |
| ZOS_CMD_TOO_FEW_ARGS |
Not enough command arguments. |
| ZOS_CMD_TOO_MANY_ARGS |
Too many command arguments. |
| ZOS_CMD_UNKNOWN_OPTION |
Unknown option (e.g. unknown 'set' command option) |
| ZOS_CMD_BAD_ARGS |
Invalid command arguments. |
| ZOS_CMD_BUFFER_OVERFLOW |
Serial command line buffer overflow. |
| ZOS_CMD_BOUNDS_ERROR |
Command specific, the parameters of the command were exceeded. |
| ZOS_BUFFER_OVERFLOW |
A buffer overflowed. |
| ZOS_DUPLICATE_EVENT |
Attempting to issue event pointer/arg that is still waiting to execute. |
| ZOS_BAD_EVENT_PERIOD |
Failed to specify periodic event period. |
| ZOS_NESTED_COMMAND |
Can't call ZentriOS command from custom command. |
| ZOS_NOT_SUBSCRIBED |
Not subscribed to stream. |
| ZOS_ZERO_LENGTH_BUFFER |
Supplied buffer with now length. |
| ZOS_NO_DATA |
No data available. |
| ZOS_LOG_FILE_OVERFLOW |
Log file has no more room to append records. |
| ZOS_INVALID_TOKEN |
No valid token available which is needed for action. |
| ZOS_WRITE_ERROR |
Error while writing data. |