Module raw
Expand description
Raw bindings access.
This module contains the raw bindings also available in the gc_abi_sys crate.
A plugin should never use this module directly as it is inherently unsafe.
It’s exposure is required by the the macros or tests.
Structs§
- __
fsid_ t - sGCDatapoint
- @brief Datapoint information The information about a datapoint, each DatapointValue will belong to a specific Datapoint which can be verified by it’s ID which is unique for the entire Gateway/plugins.
- sGCDatapoint
Value - @brief The value of a datapoint
- sGCEthernet
Interface - @brief Ethernet interface configuration
- sGCJson
Callbacks - @brief The JSON configuration data and parsing callbacks
- sGCJson
Object - @brief The JSON object
- sGCPlugin
Info - @brief Plugin version information The information that the core uses to register a new plugin. Every plugin must provide this information.
- sGCPlugin
Interface - @brief The plugin interface
- sGCSerial
Interface - @brief Serial interface configuration
- sPlugin
Config - @brief Holds the configuration and related functions
Constants§
- GCData
Bits_ GC_ DATA_ BITS_ EIGHT - 7 data bits
- GCData
Bits_ GC_ DATA_ BITS_ FIVE - GCData
Bits_ GC_ DATA_ BITS_ SEVEN - 6 data bits
- GCData
Bits_ GC_ DATA_ BITS_ SIX - 5 data bits
- GCParity_
GC_ PARITY_ EVEN - Odd parity
- GCParity_
GC_ PARITY_ NONE - GCParity_
GC_ PARITY_ ODD - No parity
- GCStop
Bits_ GC_ STOP_ BITS_ ONE - GCStop
Bits_ GC_ STOP_ BITS_ TWO - 1 stop bit
- GC_
INTERFACE_ NAME_ MAX - INT8_
MAX - INT8_
MIN - INT16_
MAX - INT16_
MIN - INT32_
MAX - INT32_
MIN - INTPTR_
MAX - INTPTR_
MIN - INT_
FAST8_ MAX - INT_
FAST8_ MIN - INT_
FAST16_ MAX - INT_
FAST16_ MIN - INT_
FAST32_ MAX - INT_
FAST32_ MIN - INT_
LEAS T8_ MAX - INT_
LEAS T8_ MIN - INT_
LEAS T16_ MAX - INT_
LEAS T16_ MIN - INT_
LEAS T32_ MAX - INT_
LEAS T32_ MIN - PTRDIFF_
MAX - PTRDIFF_
MIN - SIG_
ATOMIC_ MAX - SIG_
ATOMIC_ MIN - SIZE_
MAX - UINT8_
MAX - UINT16_
MAX - UINT32_
MAX - UINTPTR_
MAX - UINT_
FAST8_ MAX - UINT_
FAST16_ MAX - UINT_
FAST32_ MAX - UINT_
LEAS T8_ MAX - UINT_
LEAS T16_ MAX - UINT_
LEAS T32_ MAX - WINT_
MAX - WINT_
MIN - _ATFILE_
SOURCE - _BITS_
STDINT_ INTN_ H - _BITS_
STDINT_ LEAST_ H - _BITS_
STDINT_ UINTN_ H - _BITS_
TIME64_ H - _BITS_
TYPESIZES_ H - _BITS_
TYPES_ H - _BITS_
WCHAR_ H - _DEFAULT_
SOURCE - _FEATURES_
H - _POSIX_
C_ SOURCE - _POSIX_
SOURCE - _STDC_
PREDEF_ H - _STDINT_
H - _SYS_
CDEFS_ H - __
FD_ SETSIZE - __
GLIBC_ MINOR__ - __
GLIBC_ USE_ C23_ STRTOL - __
GLIBC_ USE_ DEPRECATED_ GETS - __
GLIBC_ USE_ DEPRECATED_ SCANF - __
GLIBC_ USE_ IEC_ 60559_ BFP_ EXT - __
GLIBC_ USE_ IEC_ 60559_ BFP_ EXT_ C23 - __
GLIBC_ USE_ IEC_ 60559_ EXT - __
GLIBC_ USE_ IEC_ 60559_ FUNCS_ EXT - __
GLIBC_ USE_ IEC_ 60559_ FUNCS_ EXT_ C23 - __
GLIBC_ USE_ IEC_ 60559_ TYPES_ EXT - __
GLIBC_ USE_ ISOC2Y - __
GLIBC_ USE_ ISOC23 - __
GLIBC_ USE_ LIB_ EXT2 - __
GLIBC__ - __
GNU_ LIBRARY__ - __
HAVE_ GENERIC_ SELECTION - __
INO_ T_ MATCHES_ INO64_ T - __
KERNEL_ OLD_ TIMEVAL_ MATCHES_ TIMEVA L64 - __
LDOUBLE_ REDIRECTS_ TO_ FLOA T128_ ABI - __
OFF_ T_ MATCHES_ OFF64_ T - __
RLIM_ T_ MATCHES_ RLIM64_ T - __
STATFS_ MATCHES_ STATF S64 - __
STDC_ IEC_ 559_ COMPLEX__ - __
STDC_ IEC_ 559__ - __
STDC_ IEC_ 60559_ BFP__ - __
STDC_ IEC_ 60559_ COMPLEX__ - __
STDC_ ISO_ 10646__ - __
SYSCALL_ WORDSIZE - __
TIMESIZE - __
USE_ ATFILE - __
USE_ FORTIFY_ LEVEL - __
USE_ ISOC11 - __
USE_ ISOC95 - __
USE_ ISOC99 - __
USE_ MISC - __
USE_ POSIX - __
USE_ POSI X2 - __
USE_ POSI X199309 - __
USE_ POSI X199506 - __
USE_ POSIX_ IMPLICITLY - __
USE_ TIME_ BITS64 - __
USE_ XOPE N2K - __
USE_ XOPE N2K8 - __
WORDSIZE - __
WORDSIZE_ TIME64_ COMPA T32 - __
bool_ true_ false_ are_ defined - __
glibc_ c99_ flexarr_ available - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ BAD_ REFERENCE - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ FAILURE - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ FIRST_ TWO_ BITS_ MASK - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ GOOD - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ INACCURATE - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ INCONSISTENT - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ INVALID - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ OLD_ DATA - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ OPERATOR_ BLOCKED - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ OSCILLATORY - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ OUT_ OF_ RANGE - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ OVERFLOW - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ QUESTIONABLE - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ RESERVED - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ SOURCE - eGCDatapoint
Value Quality_ GC_ DATAPOINT_ QUALITY_ TEST - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ BOOLEAN - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ BYTE_ ARRAY - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ DOUBLEPOINT - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ FLOA T32 - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ FLOA T64 - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ INT32 - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ INT64 - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ TIMESTAMPNS - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ UINT32 - eGCDatapoint
Value Type_ GCOS_ DATAPOINT_ TYPE_ UINT64 - eGCJson
Type_ GC_ JSON_ TYPE_ ARRAY - eGCJson
Type_ GC_ JSON_ TYPE_ BOOL - eGCJson
Type_ GC_ JSON_ TYPE_ DOUBLE - eGCJson
Type_ GC_ JSON_ TYPE_ INT - eGCJson
Type_ GC_ JSON_ TYPE_ NULL - eGCJson
Type_ GC_ JSON_ TYPE_ OBJECT - eGCJson
Type_ GC_ JSON_ TYPE_ STRING - eGCLog
Level_ CRITICAL - eGCLog
Level_ DEBUG - eGCLog
Level_ ERROR - eGCLog
Level_ INFO - eGCLog
Level_ WARNING - eResult
Callback_ GC_ JSON_ ERROR - eResult
Callback_ GC_ JSON_ OK - false_
- true_
Statics§
- PLUGIN_
GET_ INFO_ FUNC_ NAME - PLUGIN_
RECEIVE_ DATAPOINT_ FUNC_ NAME - PLUGIN_
SHUTDOWN_ FUNC_ NAME - PLUGIN_
START_ FUNC_ NAME
Functions§
- GCDatapoint
Value_ ⚠setQuality Invalid - @brief Set the quality of a datapoint value to invalid
- gc_
plugin_ ⚠get_ info - @brief Retrieves the plugin information
- gc_
plugin_ ⚠init - @brief Initializes the plugin
- gc_
plugin_ ⚠receive_ datapoint - @brief Receives a datapoint value
- gc_
plugin_ ⚠shutdown - @brief Safely shuts down the plugin instance.
Type Aliases§
- GCCore
Ctx - CORE CALLBACKS ///////////////////
- GCData
Bits - @brief Serial port data bits configuration
- GCDatapoint
- @brief Datapoint information The information about a datapoint, each DatapointValue will belong to a specific Datapoint which can be verified by it’s ID which is unique for the entire Gateway/plugins.
- GCDatapoint
Identifier - GCDatapoint
Value - GCDatapoint
Value Quality - GCDatapoint
Value Type - @brief The type of the datapoint value
- GCEthernet
Interface - GCGet
Ethernet Interface Core Export - GCGet
Last Datapoint Value Core Export - GCGet
Serial Interface Core Export - GCInfo
Plugin Export - GCInit
Plugin Export - GCInstance
Handle - @brief The handle to the plugin instance
- GCJson
Callbacks - GCJson
Object - @brief The JSON object
- GCJson
Type - @brief The JSON types available
- GCLog
Level - @brief The log levels available
- GCParity
- @brief Serial port parity configuration
- GCPlugin
Config - @brief Holds the configuration and related functions
- GCPlugin
Info - GCPlugin
Interface - GCPublish
Datapoint Value Core Export - GCReceive
Datapoint Plugin Export - GCRelease
Datapoint Value Core Export - GCResult
Callback - @brief The result of a json callback
- GCSerial
Interface - GCShutdown
Plugin Export - GCStop
Bits - @brief Serial port stop bits configuration
- GCStore
Datapoint Value Core Export - GCString
- GCSystem
LogAudit Core Export - GCSystem
LogCore Export - __
blkcnt64_ t - __
blkcnt_ t - __
blksize_ t - __
caddr_ t - __
clock_ t - __
clockid_ t - __
daddr_ t - __dev_t
- __
fsblkcnt64_ t - __
fsblkcnt_ t - __
fsfilcnt64_ t - __
fsfilcnt_ t - __
fsword_ t - __gid_t
- __id_t
- __
ino64_ t - __ino_t
- __
int8_ t - __
int16_ t - __
int32_ t - __
int64_ t - __
int_ least8_ t - __
int_ least16_ t - __
int_ least32_ t - __
int_ least64_ t - __
intmax_ t - __
intptr_ t - __key_t
- __
loff_ t - __
mode_ t - __
nlink_ t - __
off64_ t - __off_t
- __pid_t
- __
quad_ t - __
rlim64_ t - __
rlim_ t - __
sig_ atomic_ t - __
socklen_ t - __
ssize_ t - __
suseconds64_ t - __
suseconds_ t - __
syscall_ slong_ t - __
syscall_ ulong_ t - __
time_ t - __
timer_ t - __
u_ char - __u_int
- __
u_ long - __
u_ quad_ t - __
u_ short - __uid_t
- __
uint8_ t - __
uint16_ t - __
uint32_ t - __
uint64_ t - __
uint_ least8_ t - __
uint_ least16_ t - __
uint_ least32_ t - __
uint_ least64_ t - __
uintmax_ t - __
useconds_ t - eGCDatapoint
Value Quality - @cond
- eGCDatapoint
Value Type - @brief The type of the datapoint value
- eGCJson
Type - @brief The JSON types available
- eGCLog
Level - @brief The log levels available
- eResult
Callback - @brief The result of a json callback
- int_
fast8_ t - int_
fast16_ t - int_
fast32_ t - int_
fast64_ t - int_
least8_ t - int_
least16_ t - int_
least32_ t - int_
least64_ t - intmax_
t - tAudit
Log - tFree
Sring - tGet
Ethernet Interface - tGet
Last Datapoint Value - tGet
Serial Interface - tJson
Object GetArray Idx - tJson
Object GetArray Length - tJson
Object GetBool - tJson
Object GetDouble - tJson
Object GetInt - tJson
Object GetObject Field - tJson
Object GetString - tJson
Object Serialize - tPublish
Datapoint Value - tRelease
Datapoint Value - tStore
Datapoint Value - tSystem
Log - uint_
fast8_ t - uint_
fast16_ t - uint_
fast32_ t - uint_
fast64_ t - uint_
least8_ t - uint_
least16_ t - uint_
least32_ t - uint_
least64_ t - uintmax_
t
Unions§
- sGCDatapoint
Value__ bindgen_ ty_ 1 - @brief The value of the datapoint