future.h 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. /******************************************************************************
  2. *
  3. * Copyright 2014 Google, Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at:
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. *
  17. ******************************************************************************/
  18. #pragma once
  19. typedef struct future_t future_t;
  20. #define FUTURE_SUCCESS ((void*)1)
  21. #define FUTURE_FAIL ((void*)0)
  22. // Constructs a new future_t object. Returns NULL on failure.
  23. future_t* future_new(void);
  24. // Constructs a new future_t object with an immediate |value|. No waiting will
  25. // occur in the call to |future_await| because the value is already present.
  26. // Returns NULL on failure.
  27. future_t* future_new_immediate(void* value);
  28. // Signals that the |future| is ready, passing |value| back to the context
  29. // waiting for the result. Must only be called once for every future.
  30. // |future| may not be NULL.
  31. void future_ready(future_t* future, void* value);
  32. // Waits for the |future| to be ready. Returns the value set in |future_ready|.
  33. // Frees the future before return. |future| may not be NULL.
  34. void* future_await(future_t* async_result);