NodeBrain Manual Page

nb.lib(3)

NodeBrain Administrator Guide
Version 0.9.02 - August 2014

nb.lib(3)

NAME

nb.lib - NodeBrain Library

SYNOPSIS

#include <nb/nb.h>

gcc main_pgm.c -lnb [ -lm -ldl ]

DESCRIPTION

The NodeBrain library, libnb.so, makes the NodeBrain C API available to main routines. This is the same API provided to node modules (plug-ins).

EXAMPLE

If you want to experiment with embedding the NodeBrain interpreter in your own program, you can use nb.c and various modules in the source distribution as sample code. Here's a trivial example.

  #include <nb/nb.h>
  int main(int argc,char *argv[]){
    nbCELL context;

    printf("hello\n");

    // Start the NodeBrain interpreter
    context=nbStart(argc,argv);

    // Issue some commands 
    nbCmd(context,"assert a==x+y;",NB_CMDOPT_ECHO);
    nbCmd(context,"define r1 on(a>4):show -cells",NB_CMDOPT_ECHO);
    nbCmd(context,"assert x=2,y=3;",NB_CMDOPT_ECHO);

    // Stop the interpreter
    nbStop(context);
    }

The NodeBrain Library manual describing the API needs a lot of work, and the API will be unstable prior to a 1.0 release. So consider it experimental only.

FILES

nb.h    Header file for NodeBrain C API.

libnb.so    NodeBrain C API library - dynamic.

libnb.a    NodeBrain C API library - static.

ENVIRONMENT

NB_MODULE_PATH See nb.mod(3).

BUGS

The NodeBrain library is untested except for the API functions that are exercised by nb(1) and the distributed node modules.

AUTHOR

Ed Trettevik <eat@nodebrain.org>