
***INDEX Liblupin 0.1.2 alpha***

*What 'the library lupin
*Types of functions
*Installation and use
*Documentation
*Contact

***What 'the library lupin***

Lupin and 'library for linux written in C that implements useful functions for communication
abstracting the network is part of routine functions used for the management of the socket,
buffers, strings, IP addresses, MAC address, etc. .. in the most challenging tasks that serve to make
simple implementation of communication tools without knowing the internal structures
used by these functions, or the implementation of functions that perform an operation
more 'complex as sending a particular message to a server.
The library uses a programming model "evolutionary"in order to make it easy to author
the evolution of library to suit your needs.
Warning! this library 'was created only for scientific purposes and the author does not assume
no responsibility 'to use this tool.

***Types of functions***

The library functions are of three types:

1) utility functions': implemented to manage the library of primitive structures
(buffer, connections, output, strings, etc.)..
2) complex functions: performing a complex operation (such as a complete communication
with a server).
3) thread functions: to carry out an infinite loop and were written to be used by the thread easily. 
The thread functions are implemented in groups of four:
 * function init (void * l_ {name} _init (args)): This function creates and initializes the input 
   data structure. Returns a pointer to be passed to the function and err exec as an argument;
 * function err (l_bool l_ {name} _err (void *)): This feature can 'be called after init and before
   exec to create a thread to see if there was an error in the init;
 * function exec (void * l_ {name} _execute_ (void *)): This function performs an infinite loop.
   To use more 'these functions simultaneously, we recommend using the thread view
   the preparation of the exec function.
 * Function close (l_out * l_ {name} _close (void **)): serves to terminate the function and returns the output.
   This function is used by the signal to close the program, to receive the output
   termination of the exec function. Also frees all allocated structures.

***Installation and use***

DEPENDENCIES
 *glib-2.0
 *libpcap
 *libcrypto(openssl package)

INSTALLATION
 * tar -xvzf liblupin-0.1.2.tar.gz
 * cd liblupin-0.1.2
 * ./configure
 * make
 * make install(root)
 * ldconfig(root)

REMOVAL
 * make uninstall(root)
 * ldconfig(root)
 * make clean

COMPILATION
 * gcc -llupin -o file file.c

HEADER
 * #include <lupin/lupin.h >

***Documentation***
The documentation can 'be created by positioning itself in the folder liblupin-0.1.2 doxygen
doxygen liblupindoxy.conf and typing. Documentation and 'created in html format
liblupin-0.1.2/doc/html subdirectory.

***Contact***

Home Page:http://www.ragnu.it
mail : vasta@ragnu.it





