Diffusion C API 6.11.5
Loading...
Searching...
No Matches
Typedefs | Functions
update-constraint-value.h File Reference

A constraint value defines a datatype and associated value to be used in a topic update constraint. More...

Typedefs

typedef struct DIFFUSION_UPDATE_CONSTRAINT_VALUE_T DIFFUSION_UPDATE_CONSTRAINT_VALUE_T
 Opaque topic update constraint value struct.
 

Functions

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_string (char *value)
 Creates an update constraint value from a string value.
 
DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_int64 (int64_t value)
 Creates an update constraint value from an Int64 value.
 
DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_double (double value)
 Creates an update constraint value from a double value.
 
DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_binary (char *value, size_t len)
 Creates an update constraint value from a binary value.
 
DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_json_string (char *value)
 Creates an update constraint value from a json string.
 
DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_recordv2_string (char *value)
 Creates an update constraint value from a recordV2 string.
 
DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_bool (bool value)
 Creates an update constraint value from a boolean value.
 
void diffusion_update_constraint_value_free (DIFFUSION_UPDATE_CONSTRAINT_VALUE_T *value)
 Frees an update constraint value.
 
DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_dup (DIFFUSION_UPDATE_CONSTRAINT_VALUE_T *value)
 Creates a duplicate of an update constraint value.
 

Detailed Description

A constraint value defines a datatype and associated value to be used in a topic update constraint.

Since
6.10

Function Documentation

◆ diffusion_update_constraint_value_dup()

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_dup ( DIFFUSION_UPDATE_CONSTRAINT_VALUE_T *  value)

Creates a duplicate of an update constraint value.

diffusion_update_constraint_value_free should be called on the pointer when no longer needed.

Parameters
valuethe update constraint value
Returns
a duplicate of the original update constraint value
Since
6.10

◆ diffusion_update_constraint_value_free()

void diffusion_update_constraint_value_free ( DIFFUSION_UPDATE_CONSTRAINT_VALUE_T *  value)

Frees an update constraint value.

Parameters
valuethe update constraint value
Since
6.10

◆ diffusion_update_constraint_value_from_binary()

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_binary ( char *  value,
size_t  len 
)

Creates an update constraint value from a binary value.

diffusion_update_constraint_value_free should be called on the pointer when no longer needed.

Parameters
valuethe binary value
lenthe length of the binary value
Returns
an update constraint value or NULL if an error has occurred.
Since
6.10

◆ diffusion_update_constraint_value_from_bool()

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_bool ( bool  value)

Creates an update constraint value from a boolean value.

diffusion_update_constraint_value_free should be called on the pointer when no longer needed.

Parameters
valuethe boolean value
Returns
an update constraint value or NULL if an error has occurred.
Since
6.10

◆ diffusion_update_constraint_value_from_double()

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_double ( double  value)

Creates an update constraint value from a double value.

diffusion_update_constraint_value_free should be called on the pointer when no longer needed.

Parameters
valuethe double value
Returns
an update constraint value or NULL if an error has occurred.
Since
6.10

◆ diffusion_update_constraint_value_from_int64()

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_int64 ( int64_t  value)

Creates an update constraint value from an Int64 value.

diffusion_update_constraint_value_free should be called on the pointer when no longer needed.

Parameters
valuethe Int64 value
Returns
an update constraint value or NULL if an error has occurred.
Since
6.10

◆ diffusion_update_constraint_value_from_json_string()

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_json_string ( char *  value)

Creates an update constraint value from a json string.

diffusion_update_constraint_value_free should be called on the pointer when no longer needed.

Parameters
valuethe json string
Returns
an update constraint value or NULL if an error has occurred.
Since
6.10

◆ diffusion_update_constraint_value_from_recordv2_string()

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_recordv2_string ( char *  value)

Creates an update constraint value from a recordV2 string.

diffusion_update_constraint_value_free should be called on the pointer when no longer needed.

Parameters
valuethe recordV2 string
Returns
an update constraint value or NULL if an error has occurred.
Since
6.10

◆ diffusion_update_constraint_value_from_string()

DIFFUSION_UPDATE_CONSTRAINT_VALUE_T * diffusion_update_constraint_value_from_string ( char *  value)

Creates an update constraint value from a string value.

diffusion_update_constraint_value_free should be called on the pointer when no longer needed.

Parameters
valuethe string value
Returns
an update constraint value or NULL if an error has occurred.
Since
6.10