pacemaker  2.0.2-debe490
Scalable High-Availability cluster resource manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvpair.h
Go to the documentation of this file.
1 /*
2  * Copyright 2004-2019 the Pacemaker project contributors
3  *
4  * The version control history for this file may have further details.
5  *
6  * This source code is licensed under the GNU Lesser General Public License
7  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
8  */
9 
10 #ifndef CRM_COMMON_NVPAIR__H
11 # define CRM_COMMON_NVPAIR__H
12 
13 # ifdef __cplusplus
14 extern "C" {
15 # endif
16 
23 # include <sys/time.h> // struct timeval
24 # include <glib.h> // gpointer, gboolean, guint
25 # include <libxml/tree.h> // xmlNode
26 # include <crm/crm.h>
27 
28 typedef struct pcmk_nvpair_s {
29  char *name;
30  char *value;
32 
33 GSList *pcmk_prepend_nvpair(GSList *nvpairs, const char *name, const char *value);
34 void pcmk_free_nvpairs(GSList *nvpairs);
35 GSList *pcmk_sort_nvpairs(GSList *list);
36 GSList *pcmk_xml_attrs2nvpairs(xmlNode *xml);
37 void pcmk_nvpairs2xml_attrs(GSList *list, xmlNode *xml);
38 
39 xmlNode *crm_create_nvpair_xml(xmlNode *parent, const char *id,
40  const char *name, const char *value);
41 void hash2nvpair(gpointer key, gpointer value, gpointer user_data);
42 void hash2field(gpointer key, gpointer value, gpointer user_data);
43 void hash2metafield(gpointer key, gpointer value, gpointer user_data);
44 void hash2smartfield(gpointer key, gpointer value, gpointer user_data);
45 GHashTable *xml2list(xmlNode *parent);
46 
47 const char *crm_xml_add(xmlNode *node, const char *name, const char *value);
48 const char *crm_xml_replace(xmlNode *node, const char *name, const char *value);
49 const char *crm_xml_add_int(xmlNode *node, const char *name, int value);
50 const char *crm_xml_add_ms(xmlNode *node, const char *name, guint ms);
51 
52 const char *crm_element_value(const xmlNode *data, const char *name);
53 int crm_element_value_int(const xmlNode *data, const char *name, int *dest);
54 int crm_element_value_ms(const xmlNode *data, const char *name, guint *dest);
55 int crm_element_value_timeval(const xmlNode *data, const char *name_sec,
56  const char *name_usec, struct timeval *dest);
57 char *crm_element_value_copy(const xmlNode *data, const char *name);
58 
68 static inline const char *
69 crm_copy_xml_element(xmlNode *obj1, xmlNode *obj2, const char *element)
70 {
71  const char *value = crm_element_value(obj1, element);
72 
73  crm_xml_add(obj2, element, value);
74  return value;
75 }
76 
89 static inline const char *
90 crm_xml_add_boolean(xmlNode *node, const char *name, gboolean value)
91 {
92  return crm_xml_add(node, name, (value? "true" : "false"));
93 }
94 
95 # ifdef __cplusplus
96 }
97 # endif
98 
99 #endif // CRM_COMMON_NVPAIR__H
A dumping ground.
GSList * pcmk_sort_nvpairs(GSList *list)
Sort a list of name/value pairs.
Definition: nvpair.c:143
char * name
Definition: nvpair.h:29
void hash2field(gpointer key, gpointer value, gpointer user_data)
Set XML attribute based on hash table entry.
Definition: nvpair.c:615
void pcmk_free_nvpairs(GSList *nvpairs)
Free a list of name/value pairs.
Definition: nvpair.c:99
const char * crm_xml_add_ms(xmlNode *node, const char *name, guint ms)
Create an XML attribute with specified name and unsigned value.
Definition: nvpair.c:405
char * value
Definition: nvpair.h:30
const char * crm_xml_add_int(xmlNode *node, const char *name, int value)
Create an XML attribute with specified name and integer value.
Definition: nvpair.c:383
const char * crm_xml_add(xmlNode *node, const char *name, const char *value)
Create an XML attribute with specified name and value.
Definition: nvpair.c:275
GSList * pcmk_prepend_nvpair(GSList *nvpairs, const char *name, const char *value)
Prepend a name/value pair to a list.
Definition: nvpair.c:88
GSList * pcmk_xml_attrs2nvpairs(xmlNode *xml)
Create a list of name/value pairs from an XML node&#39;s attributes.
Definition: nvpair.c:158
int crm_element_value_int(const xmlNode *data, const char *name, int *dest)
Retrieve the integer value of an XML attribute.
Definition: nvpair.c:459
void hash2smartfield(gpointer key, gpointer value, gpointer user_data)
Add hash table entry to XML as (possibly legacy) name/value.
Definition: nvpair.c:581
void hash2nvpair(gpointer key, gpointer value, gpointer user_data)
Add XML nvpair element based on hash table entry.
Definition: nvpair.c:716
int crm_element_value_ms(const xmlNode *data, const char *name, guint *dest)
Retrieve the millisecond value of an XML attribute.
Definition: nvpair.c:484
char * crm_element_value_copy(const xmlNode *data, const char *name)
Retrieve a copy of the value of an XML attribute.
Definition: nvpair.c:556
const char * crm_element_value(const xmlNode *data, const char *name)
Retrieve the value of an XML attribute.
Definition: nvpair.c:423
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.
Definition: nvpair.c:508
const char * crm_xml_replace(xmlNode *node, const char *name, const char *value)
Replace an XML attribute with specified name and (possibly NULL) value.
Definition: nvpair.c:332
void hash2metafield(gpointer key, gpointer value, gpointer user_data)
Set XML attribute based on hash table entry, as meta-attribute name.
Definition: nvpair.c:643
char data[0]
Definition: internal.h:92
GHashTable * xml2list(xmlNode *parent)
Retrieve XML attributes as a hash table.
Definition: nvpair.c:741
void pcmk_nvpairs2xml_attrs(GSList *list, xmlNode *xml)
Add XML attributes based on a list of name/value pairs.
Definition: nvpair.c:198
xmlNode * crm_create_nvpair_xml(xmlNode *parent, const char *id, const char *name, const char *value)
Create an XML name/value pair.
Definition: nvpair.c:678
struct pcmk_nvpair_s pcmk_nvpair_t