delivery.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_DELIVERY_H
#define MAPLIBRE_NATIVE_C_DELIVERY_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "base.h"        // IWYU pragma: export
#include "completion.h"  // IWYU pragma: export
#include "logging.h"     // IWYU pragma: export
#include "map.h"         // IWYU pragma: export
#include "runtime.h"     // IWYU pragma: export
#include "style.h"       // IWYU pragma: export
#include "wake.h"        // IWYU pragma: export
 
#ifdef __cplusplus
extern "C" {
#endif
 
// NOLINTBEGIN(modernize-use-using,modernize-use-trailing-return-type)

typedef enum mln_delivery_type : uint32_t {
  MLN_DELIVERY_TYPE_COMPLETION = 1,
  MLN_DELIVERY_TYPE_LOG_RECORD = 2,
  MLN_DELIVERY_TYPE_RESOURCE_REQUEST = 3,
  MLN_DELIVERY_TYPE_RETIRED = 4,
  MLN_DELIVERY_TYPE_RESOURCE_REQUEST_CANCEL = 5,
  MLN_DELIVERY_TYPE_CAMERA_TRANSITION_END = 6,
  MLN_DELIVERY_TYPE_CUSTOM_SOURCE_FETCH_TILE = 7,
  MLN_DELIVERY_TYPE_CUSTOM_SOURCE_CANCEL_TILE = 8,
  MLN_DELIVERY_TYPE_RUNTIME_EVENTS = 9,
  MLN_DELIVERY_TYPE_RESOURCE_TRANSFORM = 10,
} mln_delivery_type;

typedef struct mln_runtime_event_delivery {
  const mln_event_batch_view* events MLN_BINDING("lifetime=owner");
} mln_runtime_event_delivery MLN_BINDING("capture=manual");

typedef struct mln_log_delivery {
  uint32_t severity MLN_BINDING("enum=mln_log_severity");
  uint32_t event MLN_BINDING("enum=mln_log_event");
  int64_t code;
  const char* message MLN_BINDING("lifetime=owner");
} mln_log_delivery;

typedef struct mln_resource_request_delivery {
  const mln_resource_request_info* request MLN_BINDING("lifetime=owner");
  mln_resource_request handle MLN_BINDING("ownership=owned");
} mln_resource_request_delivery;

typedef struct mln_resource_request_cancel_delivery {
  mln_resource_request handle;
} mln_resource_request_cancel_delivery;

typedef struct mln_resource_transform_delivery {
  uint32_t kind MLN_BINDING("enum=mln_resource_kind");
  const char* url MLN_BINDING("lifetime=owner");
  mln_resource_transform_request request MLN_BINDING("ownership=owned");
} mln_resource_transform_delivery;

typedef struct mln_camera_transition_end_delivery {
  const mln_camera_transition_end* end MLN_BINDING("lifetime=owner");
} mln_camera_transition_end_delivery;

typedef struct mln_custom_source_tile_delivery {
  mln_canonical_tile_id tile_id;
} mln_custom_source_tile_delivery;

typedef union mln_delivery_payload {
  mln_completion_result completion
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_COMPLETION");
  mln_log_delivery log_record
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_LOG_RECORD");
  mln_resource_request_delivery resource_request
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_RESOURCE_REQUEST");
  mln_resource_request_cancel_delivery resource_request_cancel
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_RESOURCE_REQUEST_CANCEL");
  mln_camera_transition_end_delivery camera_transition_end
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_CAMERA_TRANSITION_END");
  mln_custom_source_tile_delivery custom_source_fetch_tile
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_CUSTOM_SOURCE_FETCH_TILE");
  mln_custom_source_tile_delivery custom_source_cancel_tile
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_CUSTOM_SOURCE_CANCEL_TILE");
  mln_runtime_event_delivery runtime_events
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_RUNTIME_EVENTS");
  mln_resource_transform_delivery resource_transform
    MLN_BINDING("variant=MLN_DELIVERY_TYPE_RESOURCE_TRANSFORM");
} mln_delivery_payload;

typedef struct mln_delivery {
  uint32_t type MLN_BINDING("enum=mln_delivery_type");
  uint32_t reserved MLN_BINDING("kind=reserved");
  void* user_data MLN_BINDING("kind=context");
  mln_delivery_payload payload
    MLN_BINDING("tag=type;empty_variant=MLN_DELIVERY_TYPE_RETIRED");
} mln_delivery;

typedef struct mln_delivery_batch_view {
  uint32_t size;
  uint32_t delivery_size;
  const mln_delivery* deliveries
    MLN_BINDING("length=delivery_count;stride=delivery_size");
  size_t delivery_count;
} mln_delivery_batch_view;

typedef struct mln_delivery_queue_options {
  uint32_t size;
  mln_wake wake;
} mln_delivery_queue_options;

MLN_API mln_status mln_delivery_queue_create(
  const mln_delivery_queue_options* options,
  mln_delivery_queue* out_queue MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API void mln_delivery_queue_release(mln_delivery_queue queue) MLN_NOEXCEPT;

MLN_API mln_status mln_delivery_queue_drain(
  mln_delivery_queue queue,
  mln_delivery_batch* out_batch MLN_BINDING("direction=out"),
  mln_delivery_batch_view* out_view MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_delivery_batch_take(
  mln_delivery_batch batch, size_t index, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API void mln_delivery_batch_release(mln_delivery_batch batch) MLN_NOEXCEPT;
 
// NOLINTEND(modernize-use-using,modernize-use-trailing-return-type)
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_DELIVERY_H