
Directory: /usr/share/yumapro/src
Last Updated: 2021-10-27

This directory contains some example source code for use with
various YumaPro SDK programs.

You can copy this directory to some directory with writeable
permissions such as within your HOME directory.  E.g., this
command will create a dir called $HOME/yumasrc if needed, and
copy all the source sub-directories

  > cp -R /usr/share/yumapro/src/ ~/yumasrc/

Some application makefiles rely on files located in the
src/platform directory. Make sure this directory is available
if the application directories are moved.

The source examples might need command line flags used
during compilation.  If a "make" command fails with missing
libraries, then try adding the make flags EVERYTHING=1.
The flag PTHREADS=1 should be used if the YumaPro libraries
are compiled with that flag (e.g., yumapro-pthreads package).


yumapro-sdk-basic, yumapro-sdk, and yumapro-pthreads
----------------------------------------------------

  libietf-interfaces: SIL implementation for the ietf-interfaces
      module. This module is loaded if "module ietf-interfaces"
      is used in the server configuration.

  libif-stats-linux: SIL implementation for Linux interface
      statistics, used by the libietf-interfaces library.
      This library must be built before the libietf-interfaces
      directory.

  libshow: Example external show commands for yp-shell and
      yangcli-pro.

  libsystem: Example yp-system library for use with the
      netconfd-pro server. This library is used for hooking
      various system-wide callbacks. It also allows a vendor
      detailed access to the initialization and cleanup procedures.

  libtoaster: Example SIL code for toaster.yang

  sil-error: Example SIL code used in testing to force user
      errors during edit transaction processing. This will cause
      the server rollback and cleanup produres to be invoked.


yumapro-sdk and yumapro-pthreads
---------------------------------

It is important to use the PTHREADS=1 make flag if the
yumapro-pthreads package is installed. This flag must not be present
if the yumapro-sdk package is used instead.

  combo-app: Example application combining the SIL-SA and DB-API
      subsystems. Use "man combo-app" for details.

  db-api-app: Example application for a SIL-SA subsystem. This example
      application is not intended to be used as-is for complete access
      to all the APIs in the db-api library. Use "man db-api-app" for
      details.

  sil-sa-app: Example application for SIL-SA subsystem. This example
      application can be used as a completed application for a
      SIL-SA subsystem. Use "man sil-sa-app" for details.

  support-save-app: Example application for unpacking the data
      returned from the <get-support-save> operation. Use
      "man support-save-app" for details.

  yp-ha-app: Example application for YP-HA subsystem. This example
      application can be used as a completed application for a
      YP-HA subsystem. Use "man yp-ha-app" for details.

yumapro-pthreads
-----------------

  yp-client: Example C++ programs using the yp-client library.
      These example programs require PTHREADS=1 support so they
      are not included in the yumapro-sdk package.
