Public Member Functions
int	callNalpLibOpen (boolean NSAEnable, boolean NSLEnable, int LogLevel, String WorkDir, String clientName, int LogQLen, int CacheQLen, int NetThMin, int NetThMax, int OfflineMode, String ProxyIP, String ProxyPort, String ProxyUsername, String ProxyPass, String DaemonIP, String DaemonPort, String DaemonUser, String DaemonPass, int security) throws nalpError
	Initializes the Nalpeiron C library for use. See NalpLibOpen(). More...

int	callNalpLibClose () throws nalpError
	Shuts down the library. THIS FUNCTION MUST BE CALLED IMMEDIATELY BEFORE CLOSING THE LIBRARY (ie with dlclose). If this function is not called before the library is closed, information may be lost and memory corruption could occur. More...

String	callNalpGetErrorMsg (int nalpErrorNo) throws nalpError
	Get a descriptive string for nalpeiron error codes. More...

Member Function Documentation

String com.nalpeiron.nalplibrary.NALP.callNalpGetErrorMsg ( int nalpErrorNo ) throws nalpError

inline

Get a descriptive string for nalpeiron error codes.

Parameters

nalpErrorNo is a negative return value from one of the Nalpeiron functions

Returns: a descriptive string explaining that error.

int com.nalpeiron.nalplibrary.NALP.callNalpLibClose ( ) throws nalpError

inline

Shuts down the library. THIS FUNCTION MUST BE CALLED IMMEDIATELY BEFORE CLOSING THE LIBRARY (ie with dlclose). If this function is not called before the library is closed, information may be lost and memory corruption could occur.

Exceptions

nalpError If there was a problem calling the NSA function, this error will be thrown

Returns: = 0 If the call succeeded

Exceptions

nalpError If there was a problem calling the NSL function, this error will be thrown. (Nalpeiron V10 error returns)

int com.nalpeiron.nalplibrary.NALP.callNalpLibOpen	(	boolean	NSAEnable,
		boolean	NSLEnable,
		int	LogLevel,
		String	WorkDir,
		String	clientName,
		int	LogQLen,
		int	CacheQLen,
		int	NetThMin,
		int	NetThMax,
		int	OfflineMode,
		String	ProxyIP,
		String	ProxyPort,
		String	ProxyUsername,
		String	ProxyPass,
		String	DaemonIP,
		String	DaemonPort,
		String	DaemonUser,
		String	DaemonPass,
		int	security
	)		throws nalpError

inline

Initializes the Nalpeiron C library for use. See NalpLibOpen().

Parameters

NSAEnable	If TRUE NSA (analytics) library is enabled for use.
NSLEnable	If TRUE NSL (licensing) library is enabled for use.
LogLevel	is an integer 0 to 6. If loglevel is not specified it will default to level 0 (off). You should not use log level higher than 4. The higher levels do not provide any useful end user debugging.
WorkDir	is the location where the library will store all its working files (ie log file, cache file, license files, etc). If this value is not specified the files will be stored in the default Nalpeiron directory (cwd, or current working directory) on Linux and Mac, in a publically accessible directory selected by the OS on Windows).
clientName	an optional string that can be used to identify the client system. This string will appear in DataStream data.
LogQLen	the maximum length of the logging queue.
CacheQLen	is the maximum length of the cache queue. Used only by the NSA section of the library.
NetThMin	The minimum number of threads in the networking thread pool.
NetThMax	The maximum number of threads in the networking thread pool.
OfflineMode	Used only by the NSA library. See NSA.USAGE for details.
ProxyIP	The IP address of any intervening proxy that is to be used by the library.
ProxyPort	The port number of any intervening proxy that is to be used by the library.
ProxyUsername	The username for any intervening proxy that is to be used by the library.
ProxyPass	The password for any intervening proxy that is to be used by the library.
DaemonIP	The IP address of the daemon.
DaemonPort	The Port number of the daemon.
DaemonUser	Daemon username
DaemonPass	Daemon password
security	is used along with the authentication values stamped into the library to create a unique offset that is added to all returns. The default is 0 (ie returns from the library will NOT be modified).

Exceptions

nalpError If there was a problem initializing the library this error will be thrown

Returns: = 0 If the call succeeded; < 0 A negative error value is returned (Nalpeiron V10 error returns)

Public Member Functions

Member Function Documentation