Yuma Developer Manual - Revision history

Vladimir: /* val_value_t Extended Access Functions */

2018-12-11T10:21:30Z

val_value_t Extended Access Functions

Vladimir: /* val_value_t Access Functions */

2018-12-11T09:24:44Z

val_value_t Access Functions

Vladimir: /* val_value_t Access Functions */

2018-12-11T09:23:46Z

val_value_t Access Functions

Vladimir at 09:13, 11 December 2018

2018-12-11T09:13:15Z

Vladimir at 14:56, 8 October 2018

2018-10-08T14:56:56Z

Vladimir at 15:49, 27 September 2018

2018-09-27T15:49:01Z

Vladimir at 15:48, 27 September 2018

2018-09-27T15:48:44Z

Vladimir at 12:08, 12 December 2017

2017-12-12T12:08:01Z

Vladimir at 08:35, 14 April 2017

2017-04-14T08:35:42Z

Vladimir at 08:34, 14 April 2017

2017-04-14T08:34:58Z

@@ Line 2,546: / Line 2,546: @@
 |-
 | xpath_find_val_target
-| Follow the absolute-path instance-identifier (Xpath expression) and return the target value
+| Follow absolute or relative path instance-identifier (Xpath expression) and return the target value
 |}

@@ Line 2,149: / Line 2,149: @@
 === val_value_t Access Functions ===
 The file '''ncx/val.h''' contains many API functions so that object properties do not have to be accessed directly. In addition, the file ncx/val_util.h contains more (high-level) utility functions. The following table highlights the most commonly used functions. Refer to the H files for a complete definition of each API function.
 {| class="wikitable" border="1"
@@ Line 2,544: / Line 2,539: @@
 |}
-<center>'''val_value_t Extended Access Functions'''</center>
+=== val_value_t Extended Access Functions ===
 {| class="wikitable" border="1"
 ! <center>Function</center>

← Older revision		Revision as of 09:23, 11 December 2018
Line 2,542:		Line 2,542:
	\| Fill in a value node from an object template and a value string.		\| Fill in a value node from an object template and a value string.

		+	\|}
		+
		+	<center>'''val_value_t Extended Access Functions'''</center>
		+
		+
		+	{\| class="wikitable" border="1"
		+	! <center>Function</center>
		+	! <center>Description</center>
		+
		+	\|-
		+	\| xpath_find_val_target
		+	\| Follow the absolute-path instance-identifier (Xpath expression) and return the target value
	\|}		\|}

← Older revision		Revision as of 09:13, 11 December 2018
Line 8:		Line 8:


−	<center>Version yuma123-2.11</center>	+	<center>Version yuma123-2.12</center>

	= Preface =		= Preface =

@@ Line 171: / Line 171: @@
 The '''netconfd''' server handles all aspects of the NETCONF protocol operation, except data model semantics that are contained in description statements. The server uses YANG files directly, loaded at boot-time or run-time, to manage all NETCONF content, operations, and notifications.
-Callback functions are used to hook device and data model specific behavior to database objects and RPC operations. The [https://sourceforge.net/p/yuma123/git/ci/master/tree/example-modules/helloworld/helloworld.c helloworld.c] is a minimalistic example implementing [https://sourceforge.net/p/yuma123/git/ci/master/tree/example-modules/helloworld/helloworld.yang?format=raw helloworld.yang] model. The '''yangdump''' program can be used to generate the initialization, cleanup, and 'empty' callback functions for a particular YANG module. The callback functions are then completed (by you), as required by the YANG module semantics. This code is then compiled as a shared library and made available to the '''netconfd''' server. The SIL module can be either loaded during startup or later on when the 'load' command (via CLI, configuration file, protocol operation) is used (by the operator) to activate the YANG module and its SIL.
+Callback functions are used to hook device and data model specific behavior to database objects and RPC operations. The [https://sourceforge.net/p/yuma123/git/ci/master/tree/example-modules/helloworld/helloworld.c helloworld.c] is a minimalistic example implementing [https://sourceforge.net/p/yuma123/git/ci/master/tree/example-modules/helloworld/helloworld.yang?format=raw helloworld.yang] model.
 == Yuma Source Files ==

@@ Line 14: / Line 14: @@
 Copyright 2009 - 2012, Andy Bierman, All Rights Reserved.
-Copyright 2013 - 2017, Vladimir Vassilev, All Rights Reserved.
+Copyright 2013 - 2018, Vladimir Vassilev, All Rights Reserved.
 == Additional Resources ==

← Older revision		Revision as of 15:48, 27 September 2018
Line 8:		Line 8:


−	<center>Version yuma123-2.10</center>	+	<center>Version yuma123-2.11</center>

	= Preface =		= Preface =

@@ Line 64: / Line 64: @@
 * '''Transpacket'''
 ** [http://www.transpacket.com/ http://www.transpacket.com]
-** Offers Linux based embedded operating system distribution which uses Yuma for configuration and monitoring.
+** Uses Yuma for configuration and monitoring of its products.
 === Mailing Lists ===

@@ Line 489: / Line 489: @@
 === src/agt Directory ===
-This directory contains the NETCONF server implementation and built-in module SIL code. A library called '''libagt.so''' is  built and loaded by the '''netconfd''' program.
+This directory contains the NETCONF server implementation and built-in module SIL code. A library called '''libyumaagt.so''' is  built and loaded by the '''netconfd''' program.
 The following table describes the C modules contained in this directory:
@@ Line 607: / Line 607: @@
 === src/mgr Directory ===
-This directory contains the NETCONF server implementation and built-in module SIL code. A library called '''libagt.so''' is  built and loaded by the '''netconfd''' program.
+This directory contains the NETCONF server implementation and built-in module SIL code. A library called '''libyumaagt.so''' is  built and loaded by the '''netconfd''' program.
 The following table describes the C modules contained in this directory:
-This directory contains the NETCONF client support code. It handles all the basic NETCONF details so a simple internal API can be used by NETCONF applications such as '''yangcli'''. A library called '''libmgr.so''' is built and installed. The '''yangcli''' program uses this library.
+This directory contains the NETCONF client support code. It handles all the basic NETCONF details so a simple internal API can be used by NETCONF applications such as '''yangcli'''. A library called '''libyumamgr.so''' is built and installed. The '''yangcli''' program uses this library.
 The following table describes the C modules contained in this directory:

@@ Line 244: / Line 244: @@
 === src/ncx Directory ===
-This directory contains the code that is used to build the''' libncx.so''' binary shared library that is used by all Yuma Tools programs. It handles many of the core NETCONF/YANG data structure support, including all of the YANG/YIN, XML, and XPath processing. The following table describes the purpose of each file. Refer to the actual include file (e.g., ncx.h in /usr/include/yuma) for more details on each external function in each C source module.
+This directory contains the code that is used to build the''' libyumancx.so''' binary shared library that is used by all Yuma Tools programs. It handles many of the core NETCONF/YANG data structure support, including all of the YANG/YIN, XML, and XPath processing. The following table describes the purpose of each file. Refer to the actual include file (e.g., ncx.h in /usr/include/yuma) for more details on each external function in each C source module.
 <center>'''src/ncx C Modules'''</center>
@@ Line 807: / Line 807: @@
 [[Image:yang-to-internal-data.png]]
-Yuma uses YANG source modules directly to implement NETCONF protocol operations automatically within the server. The same YANG parser is used by all Yuma programs. It is located in the 'ncx' source directory (libncx.so). There are several different parsing modes, which is set by the application.
+Yuma uses YANG source modules directly to implement NETCONF protocol operations automatically within the server. The same YANG parser is used by all Yuma programs. It is located in the 'ncx' source directory (libyumancx.so). There are several different parsing modes, which is set by the application.
 In the 'server mode', the descriptive statements, such as 'description' and 'reference' are discarded upon input. Only the machine-readable statements are saved. All possible database validation, filtering, processing, initialization, NV-storage, and error processing is done, based on these machine readable statements.
@@ Line 940: / Line 940: @@
 The file '''netconfd/netconfd.c''' contains the initial 'main' function that is used to start the server.
-* The common services support for most core data structures is located in 'libncx.so'. The ''''ncx_init'''' function is called to setup these data structures. This function also calls the bootstrap_cli function in ncx/ncx.c, which processes some key configuration parameters that need to be set right away, such as the logging parameters and the module search path.
+* The common services support for most core data structures is located in 'libyumancx.so'. The ''''ncx_init'''' function is called to setup these data structures. This function also calls the bootstrap_cli function in ncx/ncx.c, which processes some key configuration parameters that need to be set right away, such as the logging parameters and the module search path.
 * Most of the actual server code is located in the 'agt' directory. The ''''agt_init1'''' function is called to initialize core server functions. The configuration parameters are processed, and the server profile is completed.
 ** The''' agt_profile_t '''data structure in agt/agt.h is used to contain all the vendor-related boot-time options, such as the database target (candidate or running). The''' init_server_profile''' function can be edited if the Yuma default values are not desired. This will insure the proper factory defaults for server behavior are used, even if no configuration parameters are provided.
@@ Line 2,608: / Line 2,608: @@
 === SIL Utility Functions ===
-There are some high-level SIL callback utilities in '''agt/agt_util.h'''. These functions access the lower-level functions in libncx to provide simpler functions for common SIL tasks.
+There are some high-level SIL callback utilities in '''agt/agt_util.h'''. These functions access the lower-level functions in libyumancx to provide simpler functions for common SIL tasks.
 The following table highlights the functions available in this module:
@@ Line 4,601: / Line 4,601: @@
 ====GCC command line====
 This will build the libtoaster.so SIL from toaster.c:
- gcc -shared  -fPIC -DPIC  -I. -I/usr/include/yuma/agt -I/usr/include/yuma/ncx -I/usr/include/yuma/platform -I/usr/include/libxml2 -I/usr/include/libxml2/libxml -rdynamic toaster.c /usr/lib/libncx.so /usr/lib/libagt.so /usr/lib/i386-linux-gnu/libxml2.so -lz -ldl -O0 -o libtoaster.so
+ gcc -shared  -fPIC -DPIC  -I. -I/usr/include/yuma/agt -I/usr/include/yuma/ncx -I/usr/include/yuma/platform -I/usr/include/libxml2 -I/usr/include/libxml2/libxml -rdynamic toaster.c /usr/lib/libyumancx.so /usr/lib/libyumaagt.so /usr/lib/i386-linux-gnu/libxml2.so -lz -ldl -O0 -o libtoaster.so
 This will install it .. and the module is ready to be used:
  sudo cp libtoaster.so /usr/lib/yuma/