az_context.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#ifndef _az_CONTEXT_H
#define _az_CONTEXT_H
 
#include <azure/core/az_result.h>
 
#include <stddef.h>
#include <stdint.h>
 
#include <azure/core/_az_cfg_prefix.h>
 
// Definition is below. Defining the typedef first is necessary here since there is a cycle.
typedef struct az_context az_context;
 
struct az_context
{
  struct
  {
    az_context const* parent; // Pointer to parent context (or NULL); immutable after creation
    int64_t expiration; // Time when context expires
    void const* key; // Pointers to the key & value (usually NULL)
    void const* value;
  } _internal;
};
 
#define _az_CONTEXT_MAX_EXPIRATION 0x7FFFFFFFFFFFFFFF
 
extern az_context az_context_application;
 
AZ_NODISCARD az_context
az_context_create_with_expiration(az_context const* parent, int64_t expiration);
 
AZ_NODISCARD az_context
az_context_create_with_value(az_context const* parent, void const* key, void const* value);
 
void az_context_cancel(az_context* ref_context);
 
AZ_NODISCARD int64_t az_context_get_expiration(az_context const* context);
 
AZ_NODISCARD bool az_context_has_expired(az_context const* context, int64_t current_time);
 
AZ_NODISCARD az_result
az_context_get_value(az_context const* context, void const* key, void const** out_value);
 
#include <azure/core/_az_cfg_suffix.h>
 
#endif // _az_CONTEXT_H