fp_set_debug ()

void
fp_set_debug (int level);

This call does nothing, see fp_init() for details.

fp_init ()

int
fp_init (void);

Initialise libfprint. This function must be called before you attempt to use the library in any way.

To enable debug output of libfprint specifically, use GLib's G_MESSAGES_DEBUG environment variable as explained in Running and debugging GLib Applications.

The log domains used in libfprint are either libfprint or libfprint-FP_COMPONENT where FP_COMPONENT is defined in the source code for each driver, or component of the library. Starting with all and trimming down is advised.

To enable debugging of libusb, for USB-based fingerprint reader drivers, use libusb's LIBUSB_DEBUG environment variable as explained in the libusb-1.0 API Reference.

Example:

LIBUSB_DEBUG=4 G_MESSAGES_DEBUG=all my-libfprint-application

fp_exit ()

void
fp_exit (void);

Deinitialise libfprint. This function should be called during your program exit sequence. You must not use any libfprint functions after calling this function, unless you call fp_init() again.

fp_handle_events_timeout ()

int
fp_handle_events_timeout (struct timeval *timeout);

Handle any pending events. If a non-zero timeout is specified, the function will potentially block for the specified amount of time, although it may return sooner if events have been handled. The function acts as non-blocking for a zero timeout.

fp_handle_events ()

int
fp_handle_events (void);

Convenience function for calling fp_handle_events_timeout() with a sensible default timeout value of two seconds (subject to change if we decide another value is more sensible).

fp_get_next_timeout ()

int
fp_get_next_timeout (struct timeval *tv);

A zero filled tv timeout means events are to be handled immediately

fp_get_pollfds ()

ssize_t
fp_get_pollfds (struct fp_pollfd **pollfds);

Retrieve a list of file descriptors that should be polled for events interesting to libfprint. This function is only for users who wish to combine libfprint's file descriptor set with other event sources – more simplistic users will be able to call fp_handle_events() or a variant directly.

fp_pollfd_added_cb ()

void
(*fp_pollfd_added_cb) (int fd,
                       short int events);

Type definition for a function that will be called when a new event source is added. The events argument is a flag as defined in <poll.h> such as POLLIN, or POLLOUT. See fp_set_pollfd_notifiers().

fp_pollfd_removed_cb ()

void
(*fp_pollfd_removed_cb) (int fd);

Type definition for a function that will be called when an event source is removed. See fp_set_pollfd_notifiers().

fp_set_pollfd_notifiers ()

void
fp_set_pollfd_notifiers (fp_pollfd_added_cb added_cb,
                         fp_pollfd_removed_cb removed_cb);

This sets the callback functions to call for every new or removed file descriptor used as an event source.

LIBFPRINT_DEPRECATED

#define LIBFPRINT_DEPRECATED __attribute__((__deprecated__))

Expands to the GNU C deprecated attribute if the compiler is gcc. When called with the -Wdeprecated-declarations option, gcc will generate warnings when deprecated interfaces are used.

struct fp_pollfd

struct fp_pollfd {
	int fd;
	short int events;
};

A structure representing a file descriptor and the events to poll for, as returned by fp_get_pollfds().