A set of functions for simplified access to SMA-X for specific variable types. More...

Functions
XField *	smaxCreate1DField (const char name, XType type, int size, const void value)
XField *	smaxCreateBooleanField (const char *name, boolean value)
XField *	smaxCreateDoubleField (const char *name, double value)
XField *	smaxCreateIntField (const char *name, int value)
XField *	smaxCreateLongField (const char *name, long long value)
XField *	smaxCreateScalarField (const char name, XType type, const void value)
XField *	smaxCreateStringField (const char name, const char value)
int	smaxGetArrayField (const XStructure s, const char name, void *dst, XType type, int count)
boolean	smaxGetBooleanField (const XStructure s, const char name, boolean defaultValue)
double	smaxGetDoubleField (const XStructure s, const char name, double defaultValue)
long long	smaxGetLongField (const XStructure s, const char name, long long defaultValue)
char *	smaxGetRawField (const XStructure s, const char name, char *defaultValue)
double	smaxPullDouble (const char table, const char key)
double	smaxPullDoubleDefault (const char table, const char key, double defaultValue)
double *	smaxPullDoubles (const char table, const char key, XMeta meta, int n)
XField *	smaxPullField (const char id, XMeta meta, int *status)
int	smaxPullInt (const char table, const char key, int defaultValue)
int *	smaxPullInts (const char table, const char key, XMeta meta, int n)
long long	smaxPullLong (const char table, const char key, long long defaultValue)
long long *	smaxPullLongs (const char table, const char key, XMeta meta, int n)
char *	smaxPullRaw (const char table, const char key, XMeta meta, int status)
char *	smaxPullString (const char table, const char key)
char **	smaxPullStrings (const char table, const char key, XMeta meta, int n)
XStructure *	smaxPullStruct (const char id, XMeta meta, int *status)
int	smaxShareBoolean (const char table, const char key, boolean value)
int	smaxShareBooleans (const char table, const char key, const boolean *values, int n)
int	smaxShareByte (const char table, const char key, signed char value)
int	smaxShareBytes (const char table, const char key, const signed char *values, int n)
int	smaxShareDouble (const char table, const char key, double value)
int	smaxShareDoubles (const char table, const char key, const double *values, int n)
int	smaxShareFloats (const char table, const char key, const float *values, int n)
int	smaxShareInt (const char table, const char key, int value)
int	smaxShareInts (const char table, const char key, const int *values, int n)
int	smaxShareLLongs (const char table, const char key, const long long *values, int n)
int	smaxShareLong (const char table, const char key, long long value)
int	smaxShareLongs (const char table, const char key, const long *values, int n)
int	smaxShareShort (const char table, const char key, short value)
int	smaxShareShorts (const char table, const char key, const short *values, int n)
int	smaxShareString (const char table, const char key, const char *sValue)
int	smaxShareStrings (const char table, const char key, const char **sValues, int n)

Detailed Description

A set of functions for simplified access to SMA-X for specific variable types.

Date: Apr 6, 2019

Author: Attila Kovacs

Function Documentation

◆ smaxCreate1DField()

XField * smaxCreate1DField	(	const char *	name,
		XType	type,
		int	size,
		const void *	value )

Creates a field for 1-D array of a given name and type using specified native values. It is like xCreate1DField() except that the field is created in serialized form.

Parameters

name	Field name
type	Storage type, e.g. X_INT.
size	Array size.
value	Pointer to the native array in memory.

Returns: A newly created field with the supplied data, or NULL if there was an error.

See also: xSetField()

References smaxCreateField().

◆ smaxCreateBooleanField()

XField * smaxCreateBooleanField	(	const char *	name,
		boolean	value )

Creates a field holding a single boolean value. It is like xCreateBooleanField() except that the field is created in serialized form.

Parameters

name	Field name
value	Associated value

Returns: A newly created field with the supplied data, or NULL if there was an error.

See also: xSetField()

References smaxCreateScalarField().

◆ smaxCreateDoubleField()

XField * smaxCreateDoubleField	(	const char *	name,
		double	value )

Creates a field holding a single double-precision value. It is like xCreateDoubleField() except that the field is created in serialized form.

Parameters

name	Field name
value	Associated value

Returns: A newly created field with the supplied data, or NULL if there was an error.

See also: xSetField()

References smaxCreateScalarField().

◆ smaxCreateIntField()

XField * smaxCreateIntField	(	const char *	name,
		int	value )

Creates a field holding a single integer value. It is like xCreateIntField() except that the field is created in serialized form.

Parameters

name	Field name
value	Associated value

Returns: A newly created field with the supplied data, or NULL if there was an error.

See also: xSetField()

References smaxCreateScalarField().

◆ smaxCreateLongField()

XField * smaxCreateLongField	(	const char *	name,
		long long	value )

Creates a field holding a single wide (64-bit) integer value. It is like xCreateLongField() except that the field is created in serialized form.

Parameters

name	Field name
value	Associated value

Returns: A newly created field with the supplied data, or NULL if there was an error.

See also: xSetField()

References smaxCreateScalarField().

◆ smaxCreateScalarField()

XField * smaxCreateScalarField	(	const char *	name,
		XType	type,
		const void *	value )

Creates a scalar field of a given name and type using the specified native value. It is like xCreateScalarField() except that the field is created in serialized form.

Parameters

name	Field name
type	Storage type, e.g. X_INT.
value	Pointer to the native data location in memory.

Returns: A newly created scalar field with the supplied data, or NULL if there was an error.

See also: xSetField()

References smaxCreate1DField().

◆ smaxCreateStringField()

XField * smaxCreateStringField	(	const char *	name,
		const char *	value )

Creates a field holding a single string value. It is like xCreateStringField() except that the field is created in serialized form.

Parameters

name	Field name
value	Associated value

Returns: A newly created field referencing the supplied string, or NULL if there was an error.

References smaxCreateScalarField().

◆ smaxGetArrayField()

int smaxGetArrayField	(	const XStructure *	s,
		const char *	name,
		void *	dst,
		XType	type,
		int	count )

Gets the data of an SMA-X structure field as an array of values of the specified type and element count. The field's data will be truncated or padded with zeroes to provide the requested element count always.

Parameters

	s	Pointer to SMA-X structure
	name	Field name
[out]	dst	Array to return values in.
	type	Type of data.
	count	Number of elements in return array. The field data will be truncated or padded as necessary.

Returns: X_SUCCESS (0) if successful, or X_STRUCT_INVALID if the input structure is NULL, X_NULL if dst is NULL, X_SIZE_INVALID if n is 0 or negative, X_NAME_INVALID if the structure does not have a field by the specified name, or else an error returned by smaxStringtoValues().

References smaxStringToValues().

◆ smaxGetBooleanField()

boolean smaxGetBooleanField	(	const XStructure *	s,
		const char *	name,
		boolean	defaultValue )

Returns the first value in a structure's field as an integer, or the specified default value if there is no such field in the structure, or the content cannot be parse into an integer.

Parameters

s	Pointer to the XStructure.
name	Field name
defaultValue	Value to return if no corresponding integer field value.

Returns: The (first) field value as a long long, or the default value if there is no such field.

See also: xGetField()

◆ smaxGetDoubleField()

double smaxGetDoubleField	(	const XStructure *	s,
		const char *	name,
		double	defaultValue )

Returns the first value in a structure's field as a double precision float, or the specified default value if there is no such field in the structure, or the content cannot be parse into an double.

Parameters

s	Pointer to the XStructure.
name	Field name
defaultValue	Value to return if no corresponding integer field value.

Returns: The (first) field value as a double, or the specified default if there is no such field.

See also: xGetField()

◆ smaxGetLongField()

long long smaxGetLongField	(	const XStructure *	s,
		const char *	name,
		long long	defaultValue )

Returns the first value in a structure's field as an integer, or the specified default value if there is no such field in the structure, or the content cannot be parse into an integer.

Parameters

s	Pointer to the XStructure.
name	Field name
defaultValue	Value to return if no corresponding integer field value.

Returns: The (first) field value as a long long, or the default value if there is no such field.

See also: xGetField()

◆ smaxGetRawField()

char * smaxGetRawField	(	const XStructure *	s,
		const char *	name,
		char *	defaultValue )

Returns the string value in a structure's field, or the specified default value if there is no such field in the structure.

Parameters

s	Pointer to the XStructure.
name	Field name
defaultValue	Value to return if no corresponding integer field value.

Returns: The field's string (raw) value, or the specified default if there is no such field.

See also: xGetField()

◆ smaxPullDouble()

double smaxPullDouble	(	const char *	table,
		const char *	key )

Returns a single floating-point value for a given SMA-X variable, or a NAN if the value could not be retrieved.

Parameters

table	Hash table name.
key	Variable name under which the data is stored.

Returns: The floating-point value stored in SMA-X, or NAN if the value could not be retrieved.

See also: smaxLazyPullDouble(); smaxPullDoubleDefault()

References smaxPullDoubleDefault().

◆ smaxPullDoubleDefault()

double smaxPullDoubleDefault	(	const char *	table,
		const char *	key,
		double	defaultValue )

Returns a single floating-point value for a given SMA-X variable, or a specified default value if the SMA-X value could not be retrieved.

Parameters

table	Hash table name.
key	Variable name under which the data is stored.
defaultValue	The value to return in case of an error.

Returns: The floating-point value stored in SMA-X, or the specified default if the value could not be retrieved.

See also: smaxLazyPullDoubleDefault(); smaxPullDouble()

References smaxPull().

◆ smaxPullDoubles()

double * smaxPullDoubles	(	const char *	table,
		const char *	key,
		XMeta *	meta,
		int *	n )

Returns a dynamically allocated array of doubles stored in an SMA-X variable.

Parameters

[in]	table	The hash table name.
[in]	key	The variable name under which the data is stored.
[out]	meta	(optional) Pointer to metadata to be filled or NULL if not required.
[out]	n	Pointer to which the number of double is returned (if *n > 0) or else an error code.

Returns: Pointer to C double[] array containing *n elements, or NULL.

See also: smaxPullDouble(); smaxPullFloats()

◆ smaxPullField()

XField * smaxPullField	(	const char *	id,
		XMeta *	meta,
		int *	status )

Returns a dynamically allocated deserialized XField for the specified node in SMA-X. You should use this function with great care, as it might retrieve very large data from SMA-X, and therefore block access to the database for a long time. It's OK to use to retrieve data for smaller sub-hierarchies, but you should probably stay away from using to to pull large hierarchies.

Parameters

	id	The aggregate SMA-X ID of the node
[out]	meta	Pointer to where to return metadata, or NULL if metadata is not required.
[out]	status	Pointer to integer in which to return status, or NULL if not required.

Returns: A field containing the data for the node, or NULL if there was an error.

See also: smaxShareField()

References smax2xField(), SMAX_DIMS, SMAX_TYPES, smaxGetRedis(), smaxPull(), and smaxTypeForString().

◆ smaxPullInt()

int smaxPullInt	(	const char *	table,
		const char *	key,
		int	defaultValue )

Returns a single integer value for a given SMA-X variable, or a default value if the value could not be retrieved.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
defaultValue	The value to return in case of an error.

Returns: The integer value stored in SMA-X, or the specified default if the value could not be retrieved.

See also: smaxLazyPullInt(); smaxPullInts(); smaPullLong()

References smaxPull().

◆ smaxPullInts()

int * smaxPullInts	(	const char *	table,
		const char *	key,
		XMeta *	meta,
		int *	n )

Returns a dynamically allocated array of integers stored in an SMA-X variable.

Parameters

[in]	table	The hash table name.
[in]	key	The variable name under which the data is stored.
[out]	meta	(optional) Pointer to metadata to be filled or NULL if not required.
[out]	n	Pointer to which the number of integers is returned (if *n > 0) or else an error code.

Returns: Pointer to C int[] array containing *n elements, or NULL.

See also: smaxPullShorts(); smaxPullLongs(); smaxPullInt()

◆ smaxPullLong()

long long smaxPullLong	(	const char *	table,
		const char *	key,
		long long	defaultValue )

Returns a single integer value for a given SMA-X variable, or a default value if the value could not be retrieved.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
defaultValue	The value to return in case of an error.

Returns: The integer value stored in SMA-X, or the specified default if the value could not be retrieved.

See also: smaxLazyPullLong(); smaxPullLongs(); smaxPullInt()

References smaxPull().

◆ smaxPullLongs()

long long * smaxPullLongs	(	const char *	table,
		const char *	key,
		XMeta *	meta,
		int *	n )

Returns a dynamically allocated array of long long (int64) integers stored in an SMA-X variable.

Parameters

[in]	table	The hash table name.
[in]	key	The variable name under which the data is stored.
[out]	meta	(optional) Pointer to metadata to be filled or NULL if not required.
[out]	n	Pointer to which the number of integers is returned (if *n > 0) or else an error code.

Returns: Pointer to C int[] array containing *n elements, or NULL.

See also: smaxPullInts(); smaxPullShorts(); smaxPullLong()

◆ smaxPullRaw()

char * smaxPullRaw	(	const char *	table,
		const char *	key,
		XMeta *	meta,
		int *	status )

Returns a dynamically allocated buffer with the raw string value stored in SMA-X. This call can also be used to get single string values from SMA-X, since for single string the stored raw value is simply the string itself. However, to properly retrieve string arrays, you want to use smaxPullStrings() instead.

Parameters

[in]	table	The hash table name.
[in]	key	The variable name under which the data is stored.
[out]	meta	(optional) Pointer to metadata to be filled or NULL if not required.
[out]	status	Pointer int which an error status is returned.

Returns: Pointer to C array containing the elements of the specified type, or NULL.

See also: smaxPullStrings()

References smaxPull().

◆ smaxPullString()

char * smaxPullString	(	const char *	table,
		const char *	key )

Returns a single string value for a given SMA-X variable, or a NULL if the value could not be retrieved.

Parameters

table	Hash table name.
key	Variable name under which the data is stored.

Returns: Pouinter to the string value stored in SMA-X, or NULL if the value could not be retrieved.

See also: smaxLazyPullString(); smaxPullStrings()

References smaxPull().

◆ smaxPullStrings()

char ** smaxPullStrings	(	const char *	table,
		const char *	key,
		XMeta *	meta,
		int *	n )

Returns an array of pointers to individuals strings inside the retrieved contiguous data buffer. Thus, to discard the returned data after use, you must first discard the underlying buffer (as pointed by the first element) before discarding the array of pointers themselves. E.g.:

char **array = smaxPullStrings("mygroup", "myfield", &meta); ... if(array != NULL) { free(array[0]); // discards the underlying contiguous buffer free(array); // discards the array of pointers. }

Parameters

[in]	table	The hash table name.
[in]	key	The variable name under which the data is stored.
[out]	meta	(optional) Pointer to metadata to be filled or NULL if not required.
[out]	n	Pointer to which the number of double is returned (if *n > 0) or else an error code.

Returns: Pointer to a an array of strings (char *) containing *n elements, or NULL.

See also: smaxPullString(); smaxPullRaw()

References smaxGetMetaCount(), smaxPullRaw(), XMeta::storeBytes, and X_META_INIT.

◆ smaxPullStruct()

XStructure * smaxPullStruct	(	const char *	id,
		XMeta *	meta,
		int *	status )

Returns a dynamically allocated XStrucure for the specified hashtable in SMA-X.

Parameters

[in]	id	Aggregated structure ID.
[out]	meta	(optional) Pointer to metadata to be filled or NULL if not required.
[out]	status	Pointer int which an error status is returned.

Returns: Pointer to an XStructure, or NULL.

See also: smaxLazyPullStruct(); xDestroyStruct(); smaxPullNode()

References smaxPull().

◆ smaxShareBoolean()

int smaxShareBoolean	(	const char *	table,
		const char *	key,
		boolean	value )

Shares a single boolean value to SMA-X. All non-zero values are mapped to "1".

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
value	A boolean value.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareBooleans()

References smaxShareBooleans().

◆ smaxShareBooleans()

int smaxShareBooleans	(	const char *	table,
		const char *	key,
		const boolean *	values,
		int	n )

Shares an array of boolean values to SMA-X. All non-zero values are mapped to "1".

Parameters

table	Hash table name.
key	Variable name under which the data is stored.
values	Pointer to boolean[] array.
n	Number of elements in array to share.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareBoolean()

References smaxShare().

◆ smaxShareByte()

int smaxShareByte	(	const char *	table,
		const char *	key,
		signed char	value )

Shares a single signed byte value to SMA-X.

Parameters

table	Hash table name.
key	Variable name under which the data is stored.
value	Integer value.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareShort(); smaxShareBytes()

References smaxShareBytes().

◆ smaxShareBytes()

int smaxShareBytes	(	const char *	table,
		const char *	key,
		const signed char *	values,
		int	n )

Shares a binary sequence to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
values	pointer to the byte buffer.
n	Number of bytes in buffer to share.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareShorts(); smaxShareInts(); smaxShareLongs(); smaxShareLLongs(); smaxShareInt()

References smaxShare().

◆ smaxShareDouble()

int smaxShareDouble	(	const char *	table,
		const char *	key,
		double	value )

Shares a single floating point value to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
value	floating-point value.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareDoubles(); smaxShareFloats()

References smaxShareDoubles().

◆ smaxShareDoubles()

int smaxShareDoubles	(	const char *	table,
		const char *	key,
		const double *	values,
		int	n )

Shares an array of doubles to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
values	Pointer to double[] array.
n	Number of elements in array to share.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareDouble(); smaxShareFloats()

References smaxShare().

◆ smaxShareFloats()

int smaxShareFloats	(	const char *	table,
		const char *	key,
		const float *	values,
		int	n )

Shares an array of floats to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
values	Pointer to float[] array.
n	Number of elements in array to share.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareDouble(); smaxShareDoubles()

References smaxShare().

◆ smaxShareInt()

int smaxShareInt	(	const char *	table,
		const char *	key,
		int	value )

Shares a single integer value to SMA-X.

Parameters

table	Hash table name.
key	Variable name under which the data is stored.
value	Integer value.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareShort(); smaxShareLong(); smaxShareHex(); smaxShareInts()

References smaxShareInts().

◆ smaxShareInts()

int smaxShareInts	(	const char *	table,
		const char *	key,
		const int *	values,
		int	n )

Shares an array of long integers to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
values	Pointer to int[] array.
n	Number of elements in array to share.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareLLongs(); smaxShareLongs(); smaxShareShorts(); smaxShareBytes(); smaxShareInt()

References smaxShare().

◆ smaxShareLLongs()

int smaxShareLLongs	(	const char *	table,
		const char *	key,
		const long long *	values,
		int	n )

Shares an array of long long integers to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
values	Pointer to long long[] array.
n	Number of elements in array to share.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareLongs(); smaxShareInts(); smaxShareShorts(); smaxShareBytes(); smaxShareInt()

References smaxShare().

◆ smaxShareLong()

int smaxShareLong	(	const char *	table,
		const char *	key,
		long long	value )

Shares a single 64-bit integer value to SMA-X.

Parameters

table	Hash table name.
key	Variable name under which the data is stored.
value	Integer value.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareInt(); smaxShareHex(); smaxShareInts()

References smaxShareLLongs().

◆ smaxShareLongs()

int smaxShareLongs	(	const char *	table,
		const char *	key,
		const long *	values,
		int	n )

Shares an array of long integers to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
values	Pointer to long[] array.
n	Number of elements in array to share.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareInt(); smaxShareLLongs(); smaxShareInts(); smaxShareShorts(); smaxShareBytes()

References smaxShare().

◆ smaxShareShort()

int smaxShareShort	(	const char *	table,
		const char *	key,
		short	value )

Shares a single short integer value to SMA-X.

Parameters

table	Hash table name.
key	Variable name under which the data is stored.
value	Integer value.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareByte(); smaxShareInt(); smaxShareShorts()

References smaxShareShorts().

◆ smaxShareShorts()

int smaxShareShorts	(	const char *	table,
		const char *	key,
		const short *	values,
		int	n )

Shares an array of shorts to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
values	Pointer to short[] array.
n	Number of elements in array to share.

Returns: X_SUCCESS(0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareInt(); smaxShareBytes(); smaxShareInts(); smaxShareLongs(); smaxShareLLongs()

References smaxShare().

◆ smaxShareString()

int smaxShareString	(	const char *	table,
		const char *	key,
		const char *	sValue )

Shares a single string value to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
sValue	Pointer to string.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareStrings()

References smaxShare().

◆ smaxShareStrings()

int smaxShareStrings	(	const char *	table,
		const char *	key,
		const char **	sValues,
		int	n )

Shares an array of strings to SMA-X.

Parameters

table	The hash table name.
key	The variable name under which the data is stored.
sValues	Pointer to array of string pointers.
n	Number of elements in array to share.

Returns: X_SUCCESS (0), or else an appropriate error code (<0) from smaxShare().

See also: smaxShareString()

References smaxShare().

Functions

Detailed Description

Function Documentation

◆ smaxCreate1DField()

◆ smaxCreateBooleanField()

◆ smaxCreateDoubleField()

◆ smaxCreateIntField()

◆ smaxCreateLongField()

◆ smaxCreateScalarField()

◆ smaxCreateStringField()

◆ smaxGetArrayField()

◆ smaxGetBooleanField()

◆ smaxGetDoubleField()

◆ smaxGetLongField()

◆ smaxGetRawField()

◆ smaxPullDouble()

◆ smaxPullDoubleDefault()

◆ smaxPullDoubles()

◆ smaxPullField()

◆ smaxPullInt()

◆ smaxPullInts()

◆ smaxPullLong()

◆ smaxPullLongs()

◆ smaxPullRaw()

◆ smaxPullString()

◆ smaxPullStrings()

◆ smaxPullStruct()

◆ smaxShareBoolean()

◆ smaxShareBooleans()

◆ smaxShareByte()

◆ smaxShareBytes()

◆ smaxShareDouble()

◆ smaxShareDoubles()

◆ smaxShareFloats()

◆ smaxShareInt()

◆ smaxShareInts()

◆ smaxShareLLongs()

◆ smaxShareLong()

◆ smaxShareLongs()

◆ smaxShareShort()

◆ smaxShareShorts()

◆ smaxShareString()

◆ smaxShareStrings()