Coldwave Documentation

Appearance

Error and Status Codes ​

Return values used throughout the Flake API.

Negative values indicate errors; E_OK (0) signals success. Use the FLAKE_SUCCEEDED macro to test for "logical success" values.

Defines ​

Name
E_TIMEOUT
E_NOT_CONNECTED
E_REFUSED
E_DONT_DISPATCH
E_DESTINATION_UNREACHABLE
E_INVALID_PARAM
E_FCNTL
E_LISTEN
E_SOCK
E_BIND
E_OK
E_FAILED
E_NO_ALLOC
E_NOT_FOUND
E_READ_ONLY
E_NOT_IMPL
E_PENDING
E_OBJECT_NOT_INITIALIZED
E_UNREGISTERED_OBJECT
E_IGNORED
E_NO_CHANGES
E_PARTIAL_SUCCESS
E_INCOMPLETE
E_UNSUPPORTED
E_UNAUTHORIZED
E_EOF
E_BUSY

Macros Documentation ​

define E_TIMEOUT ​

cpp
#define E_TIMEOUT (-101)

Operation timed out.

define E_NOT_CONNECTED ​

cpp
#define E_NOT_CONNECTED (-102)

No active connection to the router.

define E_REFUSED ​

cpp
#define E_REFUSED (-103)

Connection was refused by the peer.

define E_DONT_DISPATCH ​

cpp
#define E_DONT_DISPATCH (-104)

Internal: message should not be dispatched.

define E_DESTINATION_UNREACHABLE ​

cpp
#define E_DESTINATION_UNREACHABLE (-105)

The destination address is unreachable.

define E_INVALID_PARAM ​

cpp
#define E_INVALID_PARAM (-106)

One or more parameters are invalid.

define E_FCNTL ​

cpp
#define E_FCNTL (-1000)

[fcntl()](/embed/v2/API//group__tcpip.md#function-fcntl) system call failed.

define E_LISTEN ​

cpp
#define E_LISTEN (-1001)

[listen()](/embed/v2/API//group__tcpip.md#function-listen) system call failed.

define E_SOCK ​

cpp
#define E_SOCK (-1002)

Socket creation failed.

define E_BIND ​

cpp
#define E_BIND (-1003)

[bind()](/embed/v2/API//group__tcpip.md#function-bind) system call failed.

define E_OK ​

cpp
#define E_OK (0)

Operation completed successfully.

define E_FAILED ​

cpp
#define E_FAILED (-1)

Generic / unspecified failure.

define E_NO_ALLOC ​

cpp
#define E_NO_ALLOC (-2)

Memory allocation failed.

define E_NOT_FOUND ​

cpp
#define E_NOT_FOUND (-3)

Requested item does not exist.

define E_READ_ONLY ​

cpp
#define E_READ_ONLY (-4)

Attempt to write a read-only property.

define E_NOT_IMPL ​

cpp
#define E_NOT_IMPL (-5)

Feature or function not implemented.

define E_PENDING ​

cpp
#define E_PENDING (-6)

Operation is in progress (async).

define E_OBJECT_NOT_INITIALIZED ​

cpp
#define E_OBJECT_NOT_INITIALIZED (-7)

Object has not been initialized yet.

define E_UNREGISTERED_OBJECT ​

cpp
#define E_UNREGISTERED_OBJECT (-8)

Object is not registered with the router.

define E_IGNORED ​

cpp
#define E_IGNORED (-9)

Request was intentionally ignored.

define E_NO_CHANGES ​

cpp
#define E_NO_CHANGES (-10)

No property values were modified.

define E_PARTIAL_SUCCESS ​

cpp
#define E_PARTIAL_SUCCESS (-11)

Some, but not all, sub-operations succeeded.

define E_INCOMPLETE ​

cpp
#define E_INCOMPLETE (-12)

Data or operation is incomplete.

define E_UNSUPPORTED ​

cpp
#define E_UNSUPPORTED (-13)

The operation is not supported.

define E_UNAUTHORIZED ​

cpp
#define E_UNAUTHORIZED (-14)

Caller lacks required authorization.

define E_EOF ​

cpp
#define E_EOF (-15)

End of file / stream reached.

define E_BUSY ​

cpp
#define E_BUSY (-16)

Resource is currently busy.