latest/html/libncx_8h_source.html

/*

 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.

 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.

 *

 * Unless required by applicable law or agreed to in writing,

 * software distributed under the License is distributed on an

 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

 * KIND, either express or implied.  See the License for the

 * specific language governing permissions and limitations

 * under the License.

 */

#ifndef _H_libncx

#define _H_libncx


/*  FILE: libncx.h

*********************************************************************

*                                                                   *

*                        P U R P O S E                              *

*                                                                   *

*********************************************************************/


/*

    *** THIS FILE IS OBSOLETE AND OUT OF DATE ***

    *** DO NOT USE ***


    This is a wrapper for all NCX Library functions.

    Include individual H files instead to save compile time.


    NCX Module Library Utility Functions


                      Container of Definitions

                        +-----------------+

                        |   ncx_module_t  |

                        |   ncxtypes.h    |

                        +-----------------+


            Template/Schema

          +-----------------+

          | obj_template_t  |

          |     obj.h       |

          +-----------------+

             ^          |

             |          |       Value Instances

             |          |     +-----------------+

             |          +---->|   val_value_t   |

             |                |      val.h      |

             |                +-----------------+

             |

             |       Data Types

             |   +--------------------+

             +---|   typ_template_t   |

                 |       typ.h        |

                 +--------------------+


*********************************************************************

*                                                                   *

*                  C H A N G E   H I S T O R Y                      *

*                                                                   *

*********************************************************************


date         init     comment

----------------------------------------------------------------------

29-oct-05    abb      Begun

20-jul-08    abb      Start YANG rewrite; remove PSD and PS

23-aug-09    abb      Update diagram in header

29-may-10    abb      Make libncx wrapper for all H files

                      in libncx.so

18-may-13    abb      updated.

*/


#ifdef __cplusplus

extern "C" {

#endif


#include <xmlstring.h>


#ifndef _H_procdefs

#include "procdefs.h"

#endif


#ifndef _H_b64

#include "b64.h"

#endif


#ifndef _H_blob

#include "blob.h"

#endif


#ifndef _H_bobhash

#include "bobhash.h"

#endif


#ifndef _H_cap

#include "cap.h"

#endif


#ifndef _H_cfg

#include "cfg.h"

#endif


#ifndef _H_cli

#include "cli.h"

#endif


#ifndef _H_conf

#include "conf.h"

#endif


#ifndef _H_def_reg

#include "def_reg.h"

#endif


#ifndef _H_dlq

#include "dlq.h"

#endif


#ifndef _H_ext

#include "ext.h"

#endif


#ifndef _H_getcb

#include "getcb.h"

#endif


#ifndef _H_grp

#include "grp.h"

#endif


#ifndef _H_heapchk

#include "heapchk.h"

#endif


#ifndef _H_help

#include "help.h"

#endif


#ifndef _H_json_wr

#include "json_wr.h"

#endif


#ifndef _H_log

#include "log.h"

#endif


#ifndef _H_log_syslog

#include "log_syslog.h"

#endif


#ifndef _H_log_util

#include "log_util.h"

#endif


#ifndef _H_log_vendor_extern

#include "log_vendor_extern.h"

#endif


#ifndef _H_log_vendor

#include "log_vendor.h"

#endif


#ifndef _H_ncx_appinfo

#include "ncx_appinfo.h"

#endif


#ifndef _H_ncxconst

#include "ncxconst.h"

#endif


#ifndef _H_ncx_feature

#include "ncx_feature.h"

#endif


#ifndef _H_ncx

#include "ncx.h"

#endif


#ifndef _H_ncx_list

#include "ncx_list.h"

#endif


#ifndef _H_ncxmod

#include "ncxmod.h"

#endif


#ifndef _H_ncx_num

#include "ncx_num.h"

#endif


#ifndef _H_ncx_str

#include "ncx_str.h"

#endif


#ifndef _H_ncxtypes

#include "ncxtypes.h"

#endif


#ifndef _H_obj

#include "obj.h"

#endif


#ifndef _H_obj_help

#include "obj_help.h"

#endif


#ifndef _H_op

#include "op.h"

#endif


#ifndef _H_plock_cb

#include "plock_cb.h"

#endif


#ifndef _H_plock

#include "plock.h"

#endif


#ifndef _H_rpc_err

#include "rpc_err.h"

#endif


#ifndef _H_rpc

#include "rpc.h"

#endif


#ifndef _H_runstack

#include "runstack.h"

#endif


#ifndef _H_send_buff

#include "send_buff.h"

#endif


#ifndef _H_ses

#include "ses.h"

#endif


#ifndef _H_ses_msg

#include "ses_msg.h"

#endif


#ifndef _H_status_enum

#include "status_enum.h"

#endif


#ifndef _H_status

#include "status.h"

#endif


#ifndef _H_thd

#include "thd.h"

#endif


#ifndef _H_tk

#include "tk.h"

#endif


#ifndef _H_top

#include "top.h"

#endif


#ifndef _H_tstamp

#include "tstamp.h"

#endif


#ifndef _H_typ

#include "typ.h"

#endif


#ifndef _H_val

#include "val.h"

#endif


#ifndef _H_val_util

#include "val_util.h"

#endif


#ifndef _H_var

#include "var.h"

#endif


#ifndef _H_version

#include "version.h"

#endif


#ifndef _H_xml_msg

#include "xml_msg.h"

#endif


#ifndef _H_xmlns

#include "xmlns.h"

#endif


#ifndef _H_xml_util

#include "xml_util.h"

#endif


#ifndef _H_xml_val

#include "xml_val.h"

#endif


#ifndef _H_xml_wr

#include "xml_wr.h"

#endif


#ifndef _H_xpath1

#include "xpath1.h"

#endif


#ifndef _H_xpath

#include "xpath.h"

#endif


#ifndef _H_xpath_wr

#include "xpath_wr.h"

#endif


#ifndef _H_xpath_yang

#include "xpath_yang.h"

#endif


#ifndef _H_yangapi

#include "yangapi.h"

#endif


#ifndef _H_yangconst

#include "yangconst.h"

#endif


#ifndef _H_yang_ext

#include "yang_ext.h"

#endif


#ifndef _H_yang_grp

#include "yang_grp.h"

#endif


#ifndef _H_yang

#include "yang.h"

#endif


#ifndef _H_yang_obj

#include "yang_obj.h"

#endif


#ifndef _H_yang_parse

#include "yang_parse.h"

#endif


#ifndef _H_yang_patch

#include "yang_patch.h"

#endif


#ifndef _H_yang_typ

#include "yang_typ.h"

#endif


#ifndef _H_yin

#include "yin.h"

#endif


#ifndef _H_yinyang

#include "yinyang.h"

#endif


#ifdef __cplusplus

}   /* end extern 'C' */

#endif


#endif      /* _H_libncx */

b64.h
Base64 Utilities.

blob.h
binary to string conversion for database storage

bobhash.h
BOB hash function.

cap.h
NETCONF protocol capabilities.

cfg.h
@ brief NCX configuration database manager

cli.h
command line interpreter parsing to internal val_value_t format

conf.h
NCX Text Config file parser.

def_reg.h
Definition Registry module.

dlq.h
dlq provides general double-linked list and queue support:

ext.h
YANG Extension Handler.

getcb.h
GET1 and GET2 Callback Support.

grp.h
YANG Grouping Statement Handler.

heapchk.h
Internal Heap Checking Utilities.

help.h
YANG help text support for CLI Print help text for various templates.

json_wr.h
JSON Write functions.

log.h
NCX System Logging Manager.

log_syslog.h
Syslog logging manager API.

log_util.h
Internal SYSLOG Logging support.

log_vendor.h
Logging manager vendor API.

log_vendor_extern.h
Logging manager vendor API registration.

ncx.h
YANG module utility functions.

ncx_appinfo.h
NCX Module Library Extension (Application Info) Utility Functions.

ncx_feature.h
NCX Module Library YANG Feature Utility Functions.

ncx_list.h
NCX Module Library List Utility Functions.

ncx_num.h
NCX Module Library Number Utility Functions.

ncx_str.h
NCX Module Library String Utility Functions.

ncxconst.h
Contains NCX constants.

ncxmod.h
NCX Module Load Manager.

ncxtypes.h
YANG module data structures Many internal representations of YANG module constructs.

obj.h
Data Object Support.

obj_help.h
Help command support for obj_template_t.

op.h
NETCONF protocol operations.

plock.h
RFC 57517 partial lock support.

plock_cb.h
RFC 57517 partial lock support Data structure definition.

rpc.h
NETCONF protocol remote procedure call common definitions.

rpc_err.h
NETCONF protocol standard error definitions.

runstack.h
CLI run stack manager.

send_buff.h
Send buffer utility.

ses.h
NETCONF Session Common definitions module.

ses_msg.h
NETCONF Session Message Common definitions module.

status.h
Global error messages for status code enumerations.

status_enum.h
global error status code enumerations

thd.h
Thread support (for now limited to netconfd)

tk.h
NCX Syntax Token Handler.

top.h
NCX Common Top Element module.

tstamp.h
Timestamp utilities.

typ.h
Parameter Type Handler.

val.h
Value Node Basic Support.

val_util.h
Value Node Utilities.

var.h
NCX Variable Support.

version.h
NCX Release Train Version.

xml_msg.h
XML and JSON Message send and receive support.

xml_util.h
XML Utilities.

xml_val.h
Utility functions for creating value structs.

xml_wr.h
XML Write functions.

xmlns.h
XML namespace support.

xpath1.h
XPath 1.0 expression support.

xpath.h
Schema and data model Xpath search support.

xpath_wr.h
Write an XPath expression to a session output in normalized format.

xpath_yang.h
YANG-specific Xpath support.

yang.h
YANG Module parser utilities.

yang_ext.h
YANG Module parser extension statement support.

yang_grp.h
YANG Module parser grouping statement support.

yang_obj.h
YANG Module parser support for data-def-stmt.

yang_parse.h
YANG Module parser module.

yang_patch.h
YANG Patch Media Type.

yang_typ.h
YANG Module parser typedef and type statement support.

yangapi.h
YANG-API definitions (pre-RESTCONF)

yangconst.h
Contains YANG constants separated to prevent H file include loops.

yin.h
YIN Language Format.

yinyang.h
Convert YIN format to YANG format for input.