InfinotedParameterConvertFunc ()

gboolean
(*InfinotedParameterConvertFunc) (gpointer out,
                                  gpointer in,
                                  GError **error);

Definition of a parameter conversion function. A parameter conversion function transforms the value of a read which is one of the InfinotedParameterValue enumeration to its final internal representation. It can change the C type of the parameter, and it can also validate the input and produce an error if the input value is invalid.

While plugin developers can write their own conversion functions, many are already provided by libinfinoted-plugin-manager that cover the most basic usecases. These functions are infinoted_parameter_convert_string(), infinoted_parameter_convert_string_list(), infinoted_parameter_convert_filename(), infinoted_parameter_convert_boolean(), infinoted_parameter_convert_port(), infinoted_parameter_convert_nonnegative(), infinoted_parameter_convert_positive(), infinoted_parameter_convert_security_policy() and infinoted_parameter_convert_ip_address().

infinoted_parameter_typed_value_new ()

InfinotedParameterTypedValue *
infinoted_parameter_typed_value_new (void);

Creates a new instance of a InfinotedParameterTypedValue . The new instance will be uninitialized. Its type and value members need to be set before the object can be used or given to infinoted_parameter_typed_value_free().

infinoted_parameter_typed_value_copy ()

InfinotedParameterTypedValue *
infinoted_parameter_typed_value_copy (const InfinotedParameterTypedValue *val);

Makes a dynamically allocated copy of val .

infinoted_parameter_typed_value_free ()

void
infinoted_parameter_typed_value_free (gpointer data);

Frees an instance of InfinotedParameterTypedValue. Formally the argument is kept as a generic pointer so that this function can be used as a GDestroyNotify callback.

Note that the InfinotedParameterTypedValue needs to be correctly initialized, i.e. its type must be set, before it can be freed.

infinoted_parameter_error_quark ()

GQuark
infinoted_parameter_error_quark (void);

Returns the GQuark for errors from the InfinotedParameter module.

infinoted_parameter_load_from_key_file ()

gboolean
infinoted_parameter_load_from_key_file
                               (const InfinotedParameterInfo *infos,
                                GKeyFile *key_file,
                                const gchar *group,
                                gpointer base,
                                GError **error);

Attempts to read each parameter in infos from key_file and store them in a user-specified structure base . The offset field of InfinotedParameterInfo specifies where inside base the read parameter value will be written, and the convert field specifies a function which converts the parameter type (integer, string or string list) into the type of the field in the target structure.

If the key file does not have an entry for one of the entries in infos , then the current value in the base structure is untouched. This allows setting default values prior to calling this function.

If the function fails, for example because the conversion into the target type failed (which, in turn, might be due to invalid user input), FALSE is returned and error is set.

infinoted_parameter_convert_boolean ()

gboolean
infinoted_parameter_convert_boolean (gpointer out,
                                     gpointer in,
                                     GError **error);

This function simply writes the boolean value from in to out without any further validation.

This is a InfinotedParameterConvertFunc function that can be used for boolean values.

infinoted_parameter_convert_filename ()

gboolean
infinoted_parameter_convert_filename (gpointer out,
                                      gpointer in,
                                      GError **error);

This function converts the input string from UTF-8 to the Glib file name encoding.

This is a InfinotedParameterConvertFunc function that can be used for strings that should be in Glib file name encoding format instead of UTF-8.

infinoted_parameter_convert_nonnegative ()

gboolean
infinoted_parameter_convert_nonnegative
                               (gpointer out,
                                gpointer in,
                                GError **error);

This function validates the input number to be non-negative, and converts it into an unsigned integer.

This is a InfinotedParameterConvertFunc function that can be used for any non-negative numbers.

infinoted_parameter_convert_port ()

gboolean
infinoted_parameter_convert_port (gpointer out,
                                  gpointer in,
                                  GError **error);

This function validates the input number to be in the valid range for TCP or UDP ports between 1 and 65535, and converts it to an unsigned integer.

This is a InfinotedParameterConvertFunc function that can be used for TCP or UDP port numbers.

infinoted_parameter_convert_positive ()

gboolean
infinoted_parameter_convert_positive (gpointer out,
                                      gpointer in,
                                      GError **error);

This function validates the input number to be positve, i.e. greater than zero, and converts it into an unsigned integer.

This is a InfinotedParameterConvertFunc function that can be used for any non-negative numbers.

infinoted_parameter_convert_security_policy ()

gboolean
infinoted_parameter_convert_security_policy
                               (gpointer out,
                                gpointer in,
                                GError **error);

Converts the string that in points to to an InfXmppConnectionSecurityPolicy value, by requiring that it is either "no-tls", "allow-tls" or "require-tls". If the string is none of these three the function fails and error is set.

This is a InfinotedParameterConvertFunc function that can be used for fields of type InfXmppConnectionSecurityPolicy.

infinoted_parameter_convert_string ()

gboolean
infinoted_parameter_convert_string (gpointer out,
                                    gpointer in,
                                    GError **error);

This is basically a no-op, moving the string from the in location to the out location. In case in points to the empty string, it is freed and the output string is set to be NULL.

This is a InfinotedParameterConvertFunc function that can be used for strings that should not be processed further or validated.

infinoted_parameter_convert_string_list ()

gboolean
infinoted_parameter_convert_string_list
                               (gpointer out,
                                gpointer in,
                                GError **error);

This is basically a no-op, moving the string list from the in location to the out location. In case in points to an empty string list, or to a string list with only one entry which is the empty string, then the string list is freed and the output string list is set to be NULL.

This is a InfinotedParameterConvertFunc function that can be used for string lists that should not be processed further or validated.

infinoted_parameter_convert_flags ()

gboolean
infinoted_parameter_convert_flags (gpointer out,
                                   gpointer in,
                                   const GFlagsValue *values,
                                   GError **error);

Converts the string list that in points to to a bitmask. This function can not directly be used as a convert function as expected by InfinotedParameterInfo since it has an additional argument. However, an actual convert function can make use of this function.

Each string entry is interpreted as a value of a bitmask. The values list specifies which string constant corresponds to which flag value.

infinoted_parameter_convert_ip_address ()

gboolean
infinoted_parameter_convert_ip_address
                               (gpointer out,
                                gpointer in,
                                GError **error);

enum InfinotedParameterType

Allowed types for a parameter that can be given to a infinoted plugin.

enum InfinotedParameterFlags

Additional flags for parameters that can be given to infinoted plugins.

union InfinotedParameterValue

Holds the value of a infinoted parameter. The type of the parameter must be known. See also InfinotedParameterTypedValue.

struct InfinotedParameterTypedValue

struct InfinotedParameterTypedValue {
  InfinotedParameterType type;
  InfinotedParameterValue value;
};

Holds the type and value of a parameter that can be passed to an infinoted plugin.

struct InfinotedParameterInfo

struct InfinotedParameterInfo {
  const char* name;
  InfinotedParameterType type;
  InfinotedParameterFlags flags;
  size_t offset;
  InfinotedParameterConvertFunc convert;
  char short_name;
  const char* description;
  const char* arg_description;
};

This structure contains generic information about a parameter that can be passed to an infinoted plugin.

enum InfinotedParameterError

Specifies the possible error conditions for errors in the INFINOTED_PARAMETER_ERROR domain. These typically occur when parsing and processing input parameters for plugins.