Coldwave Documentation

Appearance

file /Users/ios_developer/workspace/coldwave-os/build/_deps/flake-src/inc/FlakeConst.h ​

Defines ​

Name
FLAKE_DEBUG_LOGGING
FLAKE_AUTH_SUPPORT
FLAKE_TLS
FLAKE_DTLS
FLAKE_STREAM_TIMEOUT_MS
FLAKE_DEFAULT_TIMEOUT_MS
MAX_PENDING_REPLIES
MAX_PENDING_INDICATIONS
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
E_TIMEOUT
E_NOT_CONNECTED
E_REFUSED
E_DONT_DISPATCH
E_DESTINATION_UNREACHABLE
E_INVALID_PARAM
E_FCNTL
E_LISTEN
E_SOCK
E_BIND
FLAKE_SUCCEEDED(e)

Macros Documentation ​

define FLAKE_DEBUG_LOGGING ​

cpp
#define FLAKE_DEBUG_LOGGING 1

define FLAKE_AUTH_SUPPORT ​

cpp
#define FLAKE_AUTH_SUPPORT 1

define FLAKE_TLS ​

cpp
#define FLAKE_TLS 0

define FLAKE_DTLS ​

cpp
#define FLAKE_DTLS 0

define FLAKE_STREAM_TIMEOUT_MS ​

cpp
#define FLAKE_STREAM_TIMEOUT_MS 30000U

define FLAKE_DEFAULT_TIMEOUT_MS ​

cpp
#define FLAKE_DEFAULT_TIMEOUT_MS 10000U

define MAX_PENDING_REPLIES ​

cpp
#define MAX_PENDING_REPLIES 10U

define MAX_PENDING_INDICATIONS ​

cpp
#define MAX_PENDING_INDICATIONS 10U

define E_OK ​

cpp
#define E_OK (0)

define E_FAILED ​

cpp
#define E_FAILED (-1)

define E_NO_ALLOC ​

cpp
#define E_NO_ALLOC (-2)

define E_NOT_FOUND ​

cpp
#define E_NOT_FOUND (-3)

define E_READ_ONLY ​

cpp
#define E_READ_ONLY (-4)

define E_NOT_IMPL ​

cpp
#define E_NOT_IMPL (-5)

define E_PENDING ​

cpp
#define E_PENDING (-6)

define E_OBJECT_NOT_INITIALIZED ​

cpp
#define E_OBJECT_NOT_INITIALIZED (-7)

define E_UNREGISTERED_OBJECT ​

cpp
#define E_UNREGISTERED_OBJECT (-8)

define E_IGNORED ​

cpp
#define E_IGNORED (-9)

define E_NO_CHANGES ​

cpp
#define E_NO_CHANGES (-10)

define E_PARTIAL_SUCCESS ​

cpp
#define E_PARTIAL_SUCCESS (-11)

define E_INCOMPLETE ​

cpp
#define E_INCOMPLETE (-12)

define E_UNSUPPORTED ​

cpp
#define E_UNSUPPORTED (-13)

define E_UNAUTHORIZED ​

cpp
#define E_UNAUTHORIZED (-14)

define E_EOF ​

cpp
#define E_EOF (-15)

define E_BUSY ​

cpp
#define E_BUSY (-16)

define E_TIMEOUT ​

cpp
#define E_TIMEOUT (-101)

define E_NOT_CONNECTED ​

cpp
#define E_NOT_CONNECTED (-102)

define E_REFUSED ​

cpp
#define E_REFUSED (-103)

define E_DONT_DISPATCH ​

cpp
#define E_DONT_DISPATCH (-104)

define E_DESTINATION_UNREACHABLE ​

cpp
#define E_DESTINATION_UNREACHABLE (-105)

define E_INVALID_PARAM ​

cpp
#define E_INVALID_PARAM (-106)

define E_FCNTL ​

cpp
#define E_FCNTL (-1000)

define E_LISTEN ​

cpp
#define E_LISTEN (-1001)

define E_SOCK ​

cpp
#define E_SOCK (-1002)

define E_BIND ​

cpp
#define E_BIND (-1003)

define FLAKE_SUCCEEDED ​

cpp
#define FLAKE_SUCCEEDED(
    e
)
({ int result = (e); result == E_OK || result == E_READ_ONLY || result == E_NO_CHANGES; })

Source code ​

cpp
/*******************************************************************************
 * @file      FlakeConst.h
 * @license   This file is part of the ImagineOn Flake software package
 *            licensed under the ImagineOn software-licensing terms available
 *            under https://www.imagineon.de/de/info/licensing-terms
 * @copyright Copyright (c) 2025 ImagineOn GmbH. www.imagineon.de.
*******************************************************************************/

#ifndef FLAKE_CONST_H_
#define FLAKE_CONST_H_

#ifndef FLAKE_DEBUG_LOGGING
#define FLAKE_DEBUG_LOGGING             1
#endif

#ifndef FLAKE_AUTH_SUPPORT
#define FLAKE_AUTH_SUPPORT              1
#endif

#ifndef FLAKE_TLS
#define FLAKE_TLS                       0
#endif

#ifndef FLAKE_DTLS
#define FLAKE_DTLS                      0
#endif

#ifndef FLAKE_STREAM_TIMEOUT_MS
#define FLAKE_STREAM_TIMEOUT_MS          30000U
#endif

#ifndef FLAKE_DEFAULT_TIMEOUT_MS
#define FLAKE_DEFAULT_TIMEOUT_MS         10000U
#endif

#define MAX_PENDING_REPLIES              10U
// Pending indications should relate to the number of concurrent tcp connections
#define MAX_PENDING_INDICATIONS          10U

#define E_OK                             (0)
#define E_FAILED                         (-1)
#define E_NO_ALLOC                       (-2)
#define E_NOT_FOUND                      (-3)
#define E_READ_ONLY                      (-4)
#define E_NOT_IMPL                       (-5)
#define E_PENDING                        (-6)
#define E_OBJECT_NOT_INITIALIZED         (-7)
#define E_UNREGISTERED_OBJECT            (-8)
#define E_IGNORED                        (-9)
#define E_NO_CHANGES                     (-10)
#define E_PARTIAL_SUCCESS                (-11)
#define E_INCOMPLETE                     (-12)
#define E_UNSUPPORTED                    (-13)
#define E_UNAUTHORIZED                   (-14)
#define E_EOF                            (-15)
#define E_BUSY                           (-16)

#define E_TIMEOUT                        (-101)
#define E_NOT_CONNECTED                  (-102)
#define E_REFUSED                        (-103)
#define E_DONT_DISPATCH                  (-104)
#define E_DESTINATION_UNREACHABLE        (-105)
#define E_INVALID_PARAM                  (-106)

// Internal Wire Error Messages

#define E_FCNTL                          (-1000)
#define E_LISTEN                         (-1001)
#define E_SOCK                           (-1002)
#define E_BIND                           (-1003)

#define FLAKE_SUCCEEDED(e)  ({ int result = (e); result == E_OK || result == E_READ_ONLY || result == E_NO_CHANGES; })

#endif /* FLAKE_CONST_H_ */