#include <include/crm/cib/cib_types.h>

Data Fields
int(*	signon )(cib_t cib, const char name, enum cib_conn_type type)

int(*	signoff )(cib_t *cib)

int(*	free )(cib_t *cib)

int(*	add_notify_callback )(cib_t cib, const char event, void(callback)(const char event, xmlNode *msg))

int(*	del_notify_callback )(cib_t cib, const char event, void(callback)(const char event, xmlNode *msg))

int(*	set_connection_dnotify )(cib_t cib, void(dnotify)(gpointer user_data))

int(*	noop )(cib_t *cib, int call_options)

int(*	ping )(cib_t cib, xmlNode *output_data, int call_options)

int(*	query )(cib_t cib, const char section, xmlNode **output_data, int call_options)

int(*	query_from )(cib_t cib, const char host, const char section, xmlNode *output_data, int call_options)

int(*	sync )(cib_t cib, const char section, int call_options)

int(*	sync_from )(cib_t cib, const char host, const char *section, int call_options)

int(*	upgrade )(cib_t *cib, int call_options)

int(*	bump_epoch )(cib_t *cib, int call_options)

int(*	create )(cib_t cib, const char section, xmlNode *data, int call_options)

int(*	modify )(cib_t cib, const char section, xmlNode *data, int call_options)

int(*	replace )(cib_t cib, const char section, xmlNode *data, int call_options)

int(*	remove )(cib_t cib, const char section, xmlNode *data, int call_options)

int(*	erase )(cib_t cib, xmlNode *output_data, int call_options)

int(*	register_notification )(cib_t cib, const char callback, int enabled)

gboolean(*	register_callback )(cib_t cib, int call_id, int timeout, gboolean only_success, void user_data, const char callback_name, void(callback)(xmlNode , int, int, xmlNode , void *))

gboolean(*	register_callback_full )(cib_t cib, int call_id, int timeout, gboolean only_success, void user_data, const char callback_name, void(callback)(xmlNode , int, int, xmlNode , void ), void(free_func)(void *))

int(*	set_primary )(cib_t *cib, int call_options)
	Set the local CIB manager as the cluster's primary instance. More...

int(*	set_secondary )(cib_t *cib, int call_options)
	Set the local CIB manager as a secondary instance. More...

int(*	client_id )(const cib_t cib, const char async_id, const char *sync_id)
	Get the given CIB connection's unique client identifier(s) More...

int(*	init_transaction )(cib_t *cib)
	Initiate an atomic CIB transaction for this client. More...

int(*	end_transaction )(cib_t *cib, bool commit, int call_options)
	End and optionally commit this client's CIB transaction. More...

void(*	set_user )(cib_t cib, const char user)
	Set the user as whom all CIB requests via methods will be executed. More...

int(*	fetch_schemas )(cib_t cib, xmlNode output_data, const char after_ver, int call_options)

Detailed Description

Definition at line 121 of file cib_types.h.

Field Documentation

◆ add_notify_callback

int(* cib_api_operations_s::add_notify_callback) (cib_t *cib, const char *event, void(*callback)(const char *event, xmlNode *msg))

Definition at line 132 of file cib_types.h.

◆ bump_epoch

int(* cib_api_operations_s::bump_epoch) (cib_t *cib, int call_options)

Definition at line 161 of file cib_types.h.

◆ client_id

int(* cib_api_operations_s::client_id) (const cib_t *cib, const char **async_id, const char **sync_id)

Get the given CIB connection's unique client identifier(s)

These can be used to check whether this client requested the action that triggered a CIB notification.

Parameters

[in]	cib	CIB connection
[out]	async_id	If not `NULL`, where to store asynchronous client ID
[out]	sync_id	If not `NULL`, where to store synchronous client ID

Returns: Legacy Pacemaker return code

Note: Some variants may have only one client for both asynchronous and synchronous requests.

Definition at line 229 of file cib_types.h.

◆ create

int(* cib_api_operations_s::create) (cib_t *cib, const char *section, xmlNode *data, int call_options)

The <failed> element in the reply to a failed creation call is deprecated since 2.1.8.

Definition at line 167 of file cib_types.h.

◆ del_notify_callback

int(* cib_api_operations_s::del_notify_callback) (cib_t *cib, const char *event, void(*callback)(const char *event, xmlNode *msg))

Definition at line 137 of file cib_types.h.

◆ end_transaction

int(* cib_api_operations_s::end_transaction) (cib_t *cib, bool commit, int call_options)

End and optionally commit this client's CIB transaction.

When a client commits a transaction, all requests in the transaction are processed in a FIFO manner until either a request fails or all requests have been processed. Changes are applied to a working copy of the CIB. If a request fails, the transaction and working CIB copy are discarded, and an error is returned. If all requests succeed, the working CIB copy replaces the initial CIB copy.

Callbacks and notifications can be triggered by the commit request itself but not by the individual requests in a transaction.

An end_transaction() call with commit set to false is always synchronous.

Parameters

[in,out]	cib	CIB connection
[in]	commit	If `true`, commit transaction; otherwise, discard it
[in]	call_options	Group of `enum cib_call_options` flags

Returns: Legacy Pacemaker return code

Definition at line 292 of file cib_types.h.

◆ erase

int(* cib_api_operations_s::erase) (cib_t *cib, xmlNode **output_data, int call_options)

Definition at line 176 of file cib_types.h.

◆ fetch_schemas

int(* cib_api_operations_s::fetch_schemas) (cib_t *cib, xmlNode **output_data, const char *after_ver, int call_options)

Definition at line 306 of file cib_types.h.

◆ free

int(* cib_api_operations_s::free) (cib_t *cib)

Definition at line 129 of file cib_types.h.

◆ init_transaction

int(* cib_api_operations_s::init_transaction) (cib_t *cib)

Initiate an atomic CIB transaction for this client.

If the client has initiated a transaction and a new request's call options contain cib_transaction, the new request is appended to the transaction for later processing.

Supported requests are those that meet the following conditions:

can be processed synchronously (with any changes applied to a working CIB copy)
are not queries
do not involve other nodes
do not affect the state of the CIB manager itself

Currently supported CIB API functions include:

Because the transaction is atomic, individual requests do not trigger callbacks or notifications when they are processed, and they do not receive output XML. The commit request itself can trigger callbacks and notifications if any are registered.

An init_transaction() call is always synchronous.

Parameters

[in,out] cib CIB connection

Returns: Legacy Pacemaker return code

Definition at line 266 of file cib_types.h.

◆ modify

int(* cib_api_operations_s::modify) (cib_t *cib, const char *section, xmlNode *data, int call_options)

Definition at line 169 of file cib_types.h.

◆ noop

int(* cib_api_operations_s::noop) (cib_t *cib, int call_options)

Deprecated:: This method will be removed and should not be used

Definition at line 146 of file cib_types.h.

◆ ping

int(* cib_api_operations_s::ping) (cib_t *cib, xmlNode **output_data, int call_options)

Definition at line 148 of file cib_types.h.

◆ query

int(* cib_api_operations_s::query) (cib_t *cib, const char *section, xmlNode **output_data, int call_options)

Definition at line 151 of file cib_types.h.

◆ query_from

int(* cib_api_operations_s::query_from) (cib_t *cib, const char *host, const char *section, xmlNode **output_data, int call_options)

Definition at line 154 of file cib_types.h.

◆ register_callback

gboolean(* cib_api_operations_s::register_callback) (cib_t *cib, int call_id, int timeout, gboolean only_success, void *user_data, const char *callback_name, void(*callback)(xmlNode *, int, int, xmlNode *, void *))

Definition at line 180 of file cib_types.h.

◆ register_callback_full

gboolean(* cib_api_operations_s::register_callback_full) (cib_t *cib, int call_id, int timeout, gboolean only_success, void *user_data, const char *callback_name, void(*callback)(xmlNode *, int, int, xmlNode *, void *), void(*free_func)(void *))

Definition at line 185 of file cib_types.h.

◆ register_notification

int(* cib_api_operations_s::register_notification) (cib_t *cib, const char *callback, int enabled)

Definition at line 178 of file cib_types.h.

◆ remove

int(* cib_api_operations_s::remove) (cib_t *cib, const char *section, xmlNode *data, int call_options)

Definition at line 174 of file cib_types.h.

◆ replace

int(* cib_api_operations_s::replace) (cib_t *cib, const char *section, xmlNode *data, int call_options)

Definition at line 172 of file cib_types.h.

◆ set_connection_dnotify

int(* cib_api_operations_s::set_connection_dnotify) (cib_t *cib, void(*dnotify)(gpointer user_data))

Definition at line 141 of file cib_types.h.

◆ set_primary

int(* cib_api_operations_s::set_primary) (cib_t *cib, int call_options)

Set the local CIB manager as the cluster's primary instance.

Parameters

[in,out]	cib	CIB connection
[in]	call_options	Group of enum cib_call_options flags

Returns: Legacy Pacemaker return code (in particular, pcmk_ok on success)

Definition at line 200 of file cib_types.h.

◆ set_secondary

int(* cib_api_operations_s::set_secondary) (cib_t *cib, int call_options)

Set the local CIB manager as a secondary instance.

Parameters

[in,out]	cib	CIB connection
[in]	call_options	Group of enum cib_call_options flags

Returns: Legacy Pacemaker return code (in particular, pcmk_ok on success)

Definition at line 210 of file cib_types.h.

◆ set_user

void(* cib_api_operations_s::set_user) (cib_t *cib, const char *user)

Set the user as whom all CIB requests via methods will be executed.

By default, the value of the CIB_user environment variable is used if set. Otherwise, the current effective user is used.

Parameters

[in,out]	cib	CIB connection
[in]	user	Name of user whose permissions to use when processing requests

Definition at line 304 of file cib_types.h.

◆ signoff

int(* cib_api_operations_s::signoff) (cib_t *cib)

Definition at line 127 of file cib_types.h.

◆ signon

int(* cib_api_operations_s::signon) (cib_t *cib, const char *name, enum cib_conn_type type)

Definition at line 124 of file cib_types.h.

◆ sync

int(* cib_api_operations_s::sync) (cib_t *cib, const char *section, int call_options)

Definition at line 157 of file cib_types.h.

◆ sync_from

int(* cib_api_operations_s::sync_from) (cib_t *cib, const char *host, const char *section, int call_options)

Definition at line 158 of file cib_types.h.

◆ upgrade

int(* cib_api_operations_s::upgrade) (cib_t *cib, int call_options)

Definition at line 160 of file cib_types.h.

The documentation for this struct was generated from the following file:

include/crm/cib/cib_types.h

Data Fields

Detailed Description

Field Documentation

◆ add_notify_callback

◆ bump_epoch

◆ client_id

◆ create

◆ del_notify_callback

◆ end_transaction

◆ erase

◆ fetch_schemas

◆ free

◆ init_transaction

◆ modify

◆ noop

◆ ping

◆ query

◆ query_from

◆ register_callback

◆ register_callback_full

◆ register_notification

◆ remove

◆ replace

◆ set_connection_dnotify

◆ set_primary

◆ set_secondary

◆ set_user

◆ signoff

◆ signon

◆ sync

◆ sync_from

◆ upgrade