Skip to main content

Module raw

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.
sGCDatapointValue
@brief The value of a datapoint
sGCEthernetInterface
@brief Ethernet interface configuration
sGCJsonCallbacks
@brief The JSON configuration data and parsing callbacks
sGCJsonObject
@brief The JSON object
sGCPluginInfo
@brief Plugin version information The information that the core uses to register a new plugin. Every plugin must provide this information.
sGCPluginInterface
@brief The plugin interface
sGCSerialInterface
@brief Serial interface configuration
sPluginConfig
@brief Holds the configuration and related functions

Constants§

GCDataBits_GC_DATA_BITS_EIGHT
7 data bits
GCDataBits_GC_DATA_BITS_FIVE
GCDataBits_GC_DATA_BITS_SEVEN
6 data bits
GCDataBits_GC_DATA_BITS_SIX
5 data bits
GCParity_GC_PARITY_EVEN
Odd parity
GCParity_GC_PARITY_NONE
GCParity_GC_PARITY_ODD
No parity
GCStopBits_GC_STOP_BITS_ONE
GCStopBits_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_LEAST8_MAX
INT_LEAST8_MIN
INT_LEAST16_MAX
INT_LEAST16_MIN
INT_LEAST32_MAX
INT_LEAST32_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_LEAST8_MAX
UINT_LEAST16_MAX
UINT_LEAST32_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_TIMEVAL64
__LDOUBLE_REDIRECTS_TO_FLOAT128_ABI
__OFF_T_MATCHES_OFF64_T
__RLIM_T_MATCHES_RLIM64_T
__STATFS_MATCHES_STATFS64
__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_POSIX2
__USE_POSIX199309
__USE_POSIX199506
__USE_POSIX_IMPLICITLY
__USE_TIME_BITS64
__USE_XOPEN2K
__USE_XOPEN2K8
__WORDSIZE
__WORDSIZE_TIME64_COMPAT32
__bool_true_false_are_defined
__glibc_c99_flexarr_available
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_BAD_REFERENCE
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_FAILURE
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_FIRST_TWO_BITS_MASK
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_GOOD
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_INACCURATE
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_INCONSISTENT
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_INVALID
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_OLD_DATA
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_OPERATOR_BLOCKED
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_OSCILLATORY
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_OUT_OF_RANGE
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_OVERFLOW
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_QUESTIONABLE
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_RESERVED
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_SOURCE
eGCDatapointValueQuality_GC_DATAPOINT_QUALITY_TEST
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_BOOLEAN
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_BYTE_ARRAY
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_DOUBLEPOINT
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_FLOAT32
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_FLOAT64
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_INT32
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_INT64
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_TIMESTAMPNS
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_UINT32
eGCDatapointValueType_GCOS_DATAPOINT_TYPE_UINT64
eGCJsonType_GC_JSON_TYPE_ARRAY
eGCJsonType_GC_JSON_TYPE_BOOL
eGCJsonType_GC_JSON_TYPE_DOUBLE
eGCJsonType_GC_JSON_TYPE_INT
eGCJsonType_GC_JSON_TYPE_NULL
eGCJsonType_GC_JSON_TYPE_OBJECT
eGCJsonType_GC_JSON_TYPE_STRING
eGCLogLevel_CRITICAL
eGCLogLevel_DEBUG
eGCLogLevel_ERROR
eGCLogLevel_INFO
eGCLogLevel_WARNING
eResultCallback_GC_JSON_ERROR
eResultCallback_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§

GCDatapointValue_setQualityInvalid
@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§

GCCoreCtx
CORE CALLBACKS ///////////////////
GCDataBits
@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.
GCDatapointIdentifier
GCDatapointValue
GCDatapointValueQuality
GCDatapointValueType
@brief The type of the datapoint value
GCEthernetInterface
GCGetEthernetInterfaceCoreExport
GCGetLastDatapointValueCoreExport
GCGetSerialInterfaceCoreExport
GCInfoPluginExport
GCInitPluginExport
GCInstanceHandle
@brief The handle to the plugin instance
GCJsonCallbacks
GCJsonObject
@brief The JSON object
GCJsonType
@brief The JSON types available
GCLogLevel
@brief The log levels available
GCParity
@brief Serial port parity configuration
GCPluginConfig
@brief Holds the configuration and related functions
GCPluginInfo
GCPluginInterface
GCPublishDatapointValueCoreExport
GCReceiveDatapointPluginExport
GCReleaseDatapointValueCoreExport
GCResultCallback
@brief The result of a json callback
GCSerialInterface
GCShutdownPluginExport
GCStopBits
@brief Serial port stop bits configuration
GCStoreDatapointValueCoreExport
GCString
GCSystemLogAuditCoreExport
GCSystemLogCoreExport
__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
eGCDatapointValueQuality
@cond
eGCDatapointValueType
@brief The type of the datapoint value
eGCJsonType
@brief The JSON types available
eGCLogLevel
@brief The log levels available
eResultCallback
@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
tAuditLog
tFreeSring
tGetEthernetInterface
tGetLastDatapointValue
tGetSerialInterface
tJsonObjectGetArrayIdx
tJsonObjectGetArrayLength
tJsonObjectGetBool
tJsonObjectGetDouble
tJsonObjectGetInt
tJsonObjectGetObjectField
tJsonObjectGetString
tJsonObjectSerialize
tPublishDatapointValue
tReleaseDatapointValue
tStoreDatapointValue
tSystemLog
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§

sGCDatapointValue__bindgen_ty_1
@brief The value of the datapoint