future.h

Go to the documentation of this file.

#pragma once
 
 
#include "context.h"
#include "nodiscard.h"
#include "pointer.h"
#include "result.h"
#include "time.h"
#include "visibility.h"
 
#include <assert.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <time.h>
 
 
typedef struct udipe_future_s udipe_future_t;
 
//
// TODO: Implement, should probably start with
//       udipe_wait(future, UDIPE_DURATION_MAX)
// TODO: Make sure that even if some input futures have been canceled, this
//       function does not return until the pointer-based inputs of the original
//       async operation are known to be safe from any access and can therefore
//       be modified or liberated by the user.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
udipe_result_t udipe_finish(udipe_future_t* future);
 
//
// TODO: Implement
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
bool udipe_wait(udipe_future_t* future, udipe_duration_ns_t timeout);
 
//
// TODO: Implement
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
bool udipe_cancel(udipe_future_t* future, bool finish);
 
//
// TODO: Implement.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_join(udipe_context_t* context,
                                 udipe_future_t* const futures[],
                                 size_t num_futures);
 
UDIPE_PUBLIC
UDIPE_NON_NULL_ARGS
void udipe_join(udipe_context_t* context,
                udipe_future_t* const futures[],
                size_t num_futures);
 
//
// TODO: Implement.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_unordered(udipe_context_t* context,
                                      udipe_future_t* const futures[],
                                      size_t num_futures);
 
//
// TODO: Implement.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_timer_once(udipe_context_t* context,
                                       const struct timespec *ts);
 
//
// TODO: Implement.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_timer_repeat(udipe_context_t* context,
                                         const struct timespec *initial,
                                         udipe_duration_ns_t interval);
 
//
// TODO: Implement.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_custom(udipe_context_t* context);
 
//
// TODO: Implement.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
bool udipe_custom_cancelled(udipe_future_t* custom);
 
//
// TODO: Implement.
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
void udipe_custom_finish_cancel(udipe_future_t* custom);
 
//
// TODO: Implement.
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
bool udipe_custom_try_set_result(udipe_future_t* custom,
                                 bool successful,
                                 udipe_custom_payload_t payload);