Scroll to navigation

FUTURE_POLL(3) MINIASYNC Programmer's Manual FUTURE_POLL(3)

NAME

future_poll() - poll the future

SYNOPSIS

#include <libminiasync.h>
enum future_state;
struct future;
struct future_notifier;
enum future_state future_poll(struct future *fut,

struct future_notifier *notifier);

For general description of future API, see miniasync_future(7).

DESCRIPTION

The future_poll() function makes implementation-defined operation towards completion of the task associated with the future pointed by fut.

Additionally, the future_poll() function can accept future notifier. Future notifier notifier is an optional parameter that is passed to the future task function. Future notifiers can be used to notify the caller that some progress can be made and the future should be polled again. This can be used to avoid busy polling.

RETURN VALUE

The future_poll() function returns current state of the future.

Future can be in one of the following states:

FUTURE_STATE_IDLE - future task has yet to begin execution
FUTURE_STATE_RUNNING - future task is in progress
FUTURE_STATE_COMPLETE - future task was completed

SEE ALSO

miniasync(7), miniasync_future(7) and <https://pmem.io>

2022-06-04 MINIASYNC - miniasync version 0.1.0