pacemaker  2.0.4-2deceaa
Scalable High-Availability cluster resource manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Typedefs | Functions
nvpair.h File Reference

Functionality for manipulating name/value pairs. More...

#include <sys/time.h>
#include <glib.h>
#include <libxml/tree.h>
#include <crm/crm.h>
Include dependency graph for nvpair.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  pcmk_nvpair_s
 

Typedefs

typedef struct pcmk_nvpair_s pcmk_nvpair_t
 

Functions

GSList * pcmk_prepend_nvpair (GSList *nvpairs, const char *name, const char *value)
 Prepend a name/value pair to a list. More...
 
void pcmk_free_nvpairs (GSList *nvpairs)
 Free a list of name/value pairs. More...
 
GSList * pcmk_sort_nvpairs (GSList *list)
 Sort a list of name/value pairs. More...
 
GSList * pcmk_xml_attrs2nvpairs (xmlNode *xml)
 Create a list of name/value pairs from an XML node's attributes. More...
 
void pcmk_nvpairs2xml_attrs (GSList *list, xmlNode *xml)
 Add XML attributes based on a list of name/value pairs. More...
 
xmlNode * crm_create_nvpair_xml (xmlNode *parent, const char *id, const char *name, const char *value)
 Create an XML name/value pair. More...
 
void hash2nvpair (gpointer key, gpointer value, gpointer user_data)
 Add XML nvpair element based on hash table entry. More...
 
void hash2field (gpointer key, gpointer value, gpointer user_data)
 Set XML attribute based on hash table entry. More...
 
void hash2metafield (gpointer key, gpointer value, gpointer user_data)
 Set XML attribute based on hash table entry, as meta-attribute name. More...
 
void hash2smartfield (gpointer key, gpointer value, gpointer user_data)
 Add hash table entry to XML as (possibly legacy) name/value. More...
 
GHashTable * xml2list (xmlNode *parent)
 Retrieve XML attributes as a hash table. More...
 
const char * crm_xml_add (xmlNode *node, const char *name, const char *value)
 Create an XML attribute with specified name and value. More...
 
const char * crm_xml_replace (xmlNode *node, const char *name, const char *value)
 Replace an XML attribute with specified name and (possibly NULL) value. More...
 
const char * crm_xml_add_int (xmlNode *node, const char *name, int value)
 Create an XML attribute with specified name and integer value. More...
 
const char * crm_xml_add_ll (xmlNode *node, const char *name, long long value)
 Create an XML attribute with specified name and long long int value. More...
 
const char * crm_xml_add_ms (xmlNode *node, const char *name, guint ms)
 Create an XML attribute with specified name and unsigned value. More...
 
const char * crm_xml_add_timeval (xmlNode *xml, const char *name_sec, const char *name_usec, const struct timeval *value)
 Create XML attributes for seconds and microseconds. More...
 
const char * crm_element_value (const xmlNode *data, const char *name)
 Retrieve the value of an XML attribute. More...
 
int crm_element_value_int (const xmlNode *data, const char *name, int *dest)
 Retrieve the integer value of an XML attribute. More...
 
int crm_element_value_ll (const xmlNode *data, const char *name, long long *dest)
 Retrieve the long long integer value of an XML attribute. More...
 
int crm_element_value_ms (const xmlNode *data, const char *name, guint *dest)
 Retrieve the millisecond value of an XML attribute. More...
 
int crm_element_value_epoch (const xmlNode *xml, const char *name, time_t *dest)
 Retrieve the seconds-since-epoch value of an XML attribute. More...
 
int crm_element_value_timeval (const xmlNode *data, const char *name_sec, const char *name_usec, struct timeval *dest)
 Retrieve the value of XML second/microsecond attributes as time. More...
 
char * crm_element_value_copy (const xmlNode *data, const char *name)
 Retrieve a copy of the value of an XML attribute. More...
 

Detailed Description

Functionality for manipulating name/value pairs.

Definition in file nvpair.h.

Typedef Documentation

typedef struct pcmk_nvpair_s pcmk_nvpair_t

Function Documentation

xmlNode* crm_create_nvpair_xml ( xmlNode *  parent,
const char *  id,
const char *  name,
const char *  value 
)

Create an XML name/value pair.

Parameters
[in]parentIf not NULL, make new XML node a child of this one
[in]idIf not NULL, use this as ID (otherwise auto-generate)
[in]nameName to use
[in]valueValue to use
Returns
New XML object on success, NULL otherwise

Definition at line 847 of file nvpair.c.

const char* crm_element_value ( const xmlNode *  data,
const char *  name 
)

Retrieve the value of an XML attribute.

Parameters
[in]dataXML node to check
[in]nameAttribute name to check
Returns
Value of specified attribute (may be NULL)

Definition at line 522 of file nvpair.c.

char* crm_element_value_copy ( const xmlNode *  data,
const char *  name 
)

Retrieve a copy of the value of an XML attribute.

This is like crm_element_value() but allocating new memory for the result.

Parameters
[in]dataXML node to check
[in]nameAttribute name to check
Returns
Value of specified attribute (may be NULL)
Note
The caller is responsible for freeing the result.

Definition at line 725 of file nvpair.c.

int crm_element_value_epoch ( const xmlNode *  xml,
const char *  name,
time_t *  dest 
)

Retrieve the seconds-since-epoch value of an XML attribute.

This is like crm_element_value() but returning the value as a time_t.

Parameters
[in]xmlXML node to check
[in]nameAttribute name to check
[out]destWhere to store attribute value
Returns
pcmk_ok on success, -1 otherwise

Definition at line 649 of file nvpair.c.

int crm_element_value_int ( const xmlNode *  data,
const char *  name,
int *  dest 
)

Retrieve the integer value of an XML attribute.

This is like crm_element_value() but getting the value as an integer.

Parameters
[in]dataXML node to check
[in]nameAttribute name to check
[in]destWhere to store element value
Returns
0 on success, -1 otherwise

Definition at line 558 of file nvpair.c.

int crm_element_value_ll ( const xmlNode *  data,
const char *  name,
long long *  dest 
)

Retrieve the long long integer value of an XML attribute.

This is like crm_element_value() but getting the value as a long long int.

Parameters
[in]dataXML node to check
[in]nameAttribute name to check
[in]destWhere to store element value
Returns
0 on success, -1 otherwise

Definition at line 586 of file nvpair.c.

int crm_element_value_ms ( const xmlNode *  data,
const char *  name,
guint *  dest 
)

Retrieve the millisecond value of an XML attribute.

This is like crm_element_value() but returning the value as a guint.

Parameters
[in]dataXML node to check
[in]nameAttribute name to check
[out]destWhere to store attribute value
Returns
pcmk_ok on success, -1 otherwise

Definition at line 614 of file nvpair.c.

int crm_element_value_timeval ( const xmlNode *  xml,
const char *  name_sec,
const char *  name_usec,
struct timeval *  dest 
)

Retrieve the value of XML second/microsecond attributes as time.

This is like crm_element_value() but returning value as a struct timeval.

Parameters
[in]xmlXML to parse
[in]name_secName of XML attribute for seconds
[in]name_usecName of XML attribute for microseconds
[out]destWhere to store result
Returns
pcmk_ok on success, -errno on error
Note
Values default to 0 if XML or XML attribute does not exist

Definition at line 678 of file nvpair.c.

const char* crm_xml_add ( xmlNode *  node,
const char *  name,
const char *  value 
)

Create an XML attribute with specified name and value.

Parameters
[in,out]nodeXML node to modify
[in]nameAttribute name to set
[in]valueAttribute value to set
Returns
New value on success, NULL otherwise
Note
This does nothing if node, name, or value are NULL or empty.

Definition at line 316 of file nvpair.c.

const char* crm_xml_add_int ( xmlNode *  node,
const char *  name,
int  value 
)

Create an XML attribute with specified name and integer value.

This is like crm_xml_add() but taking an integer value.

Parameters
[in,out]nodeXML node to modify
[in]nameAttribute name to set
[in]valueAttribute value to set
Returns
New value as string on success, NULL otherwise
Note
This does nothing if node or name are NULL or empty.

Definition at line 424 of file nvpair.c.

const char* crm_xml_add_ll ( xmlNode *  xml,
const char *  name,
long long  value 
)

Create an XML attribute with specified name and long long int value.

This is like crm_xml_add() but taking a long long int value. It is a useful equivalent for defined types like time_t, etc.

Parameters
[in,out]xmlXML node to modify
[in]nameAttribute name to set
[in]valueAttribute value to set
Returns
New value as string on success, NULL otherwise
Note
This does nothing if xml or name are NULL or empty. This does not support greater than 64-bit values.

Definition at line 474 of file nvpair.c.

const char* crm_xml_add_ms ( xmlNode *  node,
const char *  name,
guint  ms 
)

Create an XML attribute with specified name and unsigned value.

This is like crm_xml_add() but taking a guint value.

Parameters
[in,out]nodeXML node to modify
[in]nameAttribute name to set
[in]msAttribute value to set
Returns
New value as string on success, NULL otherwise
Note
This does nothing if node or name are NULL or empty.

Definition at line 446 of file nvpair.c.

const char* crm_xml_add_timeval ( xmlNode *  xml,
const char *  name_sec,
const char *  name_usec,
const struct timeval *  value 
)

Create XML attributes for seconds and microseconds.

This is like crm_xml_add() but taking a struct timeval.

Parameters
[in,out]xmlXML node to modify
[in]name_secName of XML attribute for seconds
[in]name_usecName of XML attribute for microseconds (or NULL)
[in]valueTime value to set
Returns
New seconds value as string on success, NULL otherwise
Note
This does nothing if xml, name_sec, or value is NULL.

Definition at line 498 of file nvpair.c.

const char* crm_xml_replace ( xmlNode *  node,
const char *  name,
const char *  value 
)

Replace an XML attribute with specified name and (possibly NULL) value.

Parameters
[in,out]nodeXML node to modify
[in]nameAttribute name to set
[in]valueAttribute value to set
Returns
New value on success, NULL otherwise
Note
This does nothing if node or name is NULL or empty.

Definition at line 373 of file nvpair.c.

void hash2field ( gpointer  key,
gpointer  value,
gpointer  user_data 
)

Set XML attribute based on hash table entry.

Suitable for g_hash_table_foreach(), this function takes a hash table key and value, with an XML node passed as user data, and adds an XML attribute with the specified name and value if it does not already exist.

Parameters
[in]keyKey of hash table entry
[in]valueValue of hash table entry
[in]user_dataXML node

Definition at line 784 of file nvpair.c.

void hash2metafield ( gpointer  key,
gpointer  value,
gpointer  user_data 
)

Set XML attribute based on hash table entry, as meta-attribute name.

Suitable for g_hash_table_foreach(), this function takes a hash table key and value, with an XML node passed as user data, and adds an XML attribute with the meta-attribute version of the specified name and value if it does not already exist and if the name does not appear to be cluster-internal.

Parameters
[in]keyKey of hash table entry
[in]valueValue of hash table entry
[in]user_dataXML node

Definition at line 812 of file nvpair.c.

void hash2nvpair ( gpointer  key,
gpointer  value,
gpointer  user_data 
)

Add XML nvpair element based on hash table entry.

Suitable for g_hash_table_foreach(), this function takes a hash table key and value, with an XML node passed as the user data, and adds an nvpair XML element with the specified name and value.

Parameters
[in]keyKey of hash table entry
[in]valueValue of hash table entry
[in]user_dataXML node

Definition at line 885 of file nvpair.c.

void hash2smartfield ( gpointer  key,
gpointer  value,
gpointer  user_data 
)

Add hash table entry to XML as (possibly legacy) name/value.

Suitable for g_hash_table_foreach(), this function takes a hash table key and value, with an XML node passed as user data, and adds an XML attribute with the specified name and value if it does not already exist. If the key name starts with a digit, this will instead add a <param name=NAME value=VALUE/> child to the XML (for legacy compatibility with heartbeat).

Parameters
[in]keyKey of hash table entry
[in]valueValue of hash table entry
[in]user_dataXML node

Definition at line 750 of file nvpair.c.

void pcmk_free_nvpairs ( GSList *  nvpairs)

Free a list of name/value pairs.

Parameters
[in]listList to free

Definition at line 102 of file nvpair.c.

void pcmk_nvpairs2xml_attrs ( GSList *  list,
xmlNode *  xml 
)

Add XML attributes based on a list of name/value pairs.

Parameters
[in]listList of name/value pairs
[in,out]xmlXML node to add attributes to

Definition at line 201 of file nvpair.c.

GSList* pcmk_prepend_nvpair ( GSList *  nvpairs,
const char *  name,
const char *  value 
)

Prepend a name/value pair to a list.

Parameters
[in,out]nvpairsList to modify
[in]nameNew entry's name
[in]valueNew entry's value
Returns
New head of list
Note
The caller is responsible for freeing the list with pcmk_free_nvpairs().

Definition at line 91 of file nvpair.c.

GSList* pcmk_sort_nvpairs ( GSList *  list)

Sort a list of name/value pairs.

Parameters
[in,out]listList to sort
Returns
New head of list

Definition at line 146 of file nvpair.c.

GSList* pcmk_xml_attrs2nvpairs ( xmlNode *  xml)

Create a list of name/value pairs from an XML node's attributes.

Parameters
[in]XMLto parse
Returns
New list of name/value pairs
Note
It is the caller's responsibility to free the list with pcmk_free_nvpairs().

Definition at line 161 of file nvpair.c.

GHashTable* xml2list ( xmlNode *  parent)

Retrieve XML attributes as a hash table.

Given an XML element, this will look for any <attributes> element child, creating a hash table of (newly allocated string) name/value pairs taken first from the attributes element's NAME=VALUE XML attributes, and then from any <param name=NAME value=VALUE> children of attributes.

Parameters
[in]XMLnode to parse
Returns
Hash table with name/value pairs
Note
It is the caller's responsibility to free the result using g_hash_table_destroy().

Definition at line 910 of file nvpair.c.