help | logout
RSP_moduleBackend

RSP_moduleBackend

Name

RSP_moduleBackend -- Creates a new module object.

Synopsis

$mod = new rspmod::RSP_moduleBackend($name);

Description

This creates a module object and must be called before any other RSP Module API function can be called. It sets up internal data structures and attempts to establish a connection with the RSPD. Because the RSPD communicates with its modules via pipes, this function sets up those communications channels and prepares them to be used again later.

Returns

The module object, from which all other module functions are referenced. In case of error, the program will croak() with an appriopriate message.