Data object

It provides a set of methods to handle the web service data directory. A data directory aims to provide a local storage point for specific files and directories handled by the web services. A data directory can be set manually in the virtual host configuration using the DataDir key under the [WEB_SERVICE] section or through the API exposed in this documentation.

Usage

data->method(...);

get_path()

It returns the data directory being used by the web service.

Prototype

const char *get_path();

Parameters None

Return: Upon successful completion it returns the directory path, on error or if the path is not set returns NULL.

locate()

It compose the absolute path for a given file or directory name using as reference the web service data directory. This method can be used only inside a callback context. The resulting memory buffer is freed by the garbage collector once the callback finish it works.

Prototype

char *locate(const char *filename);

Parameters

filename: the name of the file or directory entry

Return: Upon successful completion it returns the location path, on error or if the path is not set returns NULL.

set_path()

It specify a new data directory for the web service. It must be a valid path. If it fails it will continue using the configuration directory set on the web server virtual host definition.

Prototype

int set_path(const char *dir);

Parameters

dir: directory path where the configuration files are located.

Return: Upon successful completion it returns 0, on error returns -1.