transapi.h File Reference

Functions implementing libnetconf TransAPI mechanism. More...

#include <sys/inotify.h>
#include <libxml/tree.h>
#include "netconf.h"
#include "error.h"

Include dependency graph for transapi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	clbk
	Structure describing callback - path + function. More...
struct	ns_pair
struct	transapi
	Structure to describe transAPI module and connect it statically with libnetconf using ncds_new_transapi_static(). More...
struct	transapi_data_callbacks
	Same as transapi_data_callbacks. Using libxml2 structures for callbacks parameters. More...
struct	transapi_file_callbacks
	Functions to call if the specified file is modified. More...
struct	transapi_rpc_callbacks
	Same as transapi_rpc_callbacks. Using libxml2 structures for callbacks parameters. More...

Macros
#define	MAX_RPC_INPUT_ARGS   64
#define	TRANSAPI_VERSION   6

Enumerations
enum	CLBCKS_APPLIED {   CLBCKS_APPLIED_NONE, CLBCKS_APPLYING_CHILDREN, CLBCKS_APPLIED_ERROR, CLBCKS_APPLIED_NO_ERROR,   CLBCKS_APPLIED_CHILDREN_ERROR, CLBCKS_APPLIED_CHILDREN_NO_ERROR, CLBCKS_APPLIED_NOT_FULLY, CLBCKS_APPLIED_FULLY }
enum	TRANSAPI_CLBCKS_ORDER_TYPE { TRANSAPI_CLBCKS_LEAF_TO_ROOT, TRANSAPI_CLBCKS_ROOT_TO_LEAF, TRANSAPI_CLBCKS_ORDER_DEFAULT = TRANSAPI_CLBCKS_LEAF_TO_ROOT }
enum	XMLDIFF_OP {   XMLDIFF_ERR = -1, XMLDIFF_NONE = 0, XMLDIFF_ADD = 1, XMLDIFF_REM = 2,   XMLDIFF_MOD = 4, XMLDIFF_CHAIN = 8, XMLDIFF_SIBLING = 16, XMLDIFF_REORDER = 32 }
	Enum specifying states of node in document. More...

Detailed Description

Functions implementing libnetconf TransAPI mechanism.

Author

Radek Krejci rkrej.nosp@m.ci@c.nosp@m.esnet.nosp@m..cz

David Kupka david.nosp@m..kup.nosp@m.ka@ce.nosp@m.sent.nosp@m..cz

Michal Vasko mvask.nosp@m.o@ce.nosp@m.snet..nosp@m.cz Copyright (c) 2012-2014 CESNET, z.s.p.o.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the Company nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

ALTERNATIVELY, provided that this notice is retained in full, this product may be distributed under the terms of the GNU General Public License (GPL) version 2 or later, in which case the provisions of the GPL apply INSTEAD OF those given above.

This software is provided ``as is, and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the company or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

Macro Definition Documentation

#define MAX_RPC_INPUT_ARGS   64

#define TRANSAPI_VERSION   6

Enumeration Type Documentation

enum CLBCKS_APPLIED

Enumerator
CLBCKS_APPLIED_NONE
CLBCKS_APPLYING_CHILDREN
CLBCKS_APPLIED_ERROR
CLBCKS_APPLIED_NO_ERROR
CLBCKS_APPLIED_CHILDREN_ERROR
CLBCKS_APPLIED_CHILDREN_NO_ERROR
CLBCKS_APPLIED_NOT_FULLY
CLBCKS_APPLIED_FULLY

enum TRANSAPI_CLBCKS_ORDER_TYPE

Enumerator
TRANSAPI_CLBCKS_LEAF_TO_ROOT
TRANSAPI_CLBCKS_ROOT_TO_LEAF
TRANSAPI_CLBCKS_ORDER_DEFAULT