ustream_base.h

Go to the documentation of this file.

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

#ifndef AZ_USTREAM_BASE_H
#define AZ_USTREAM_BASE_H

#include "ulib_config.h"
#include "ulib_result.h"
#include "az_pal_os.h"
#include "azure_macro_utils/macro_utils.h"
#include "umock_c/umock_c_prod.h"

#ifdef __cplusplus
#include <cstdint>
#include <cstddef>
extern "C" {
#else
#include <stdint.h>
#include <stddef.h>
#endif /* __cplusplus */

typedef size_t offset_t;

typedef struct AZ_USTREAM_TAG AZ_USTREAM;

typedef struct AZ_USTREAM_INTERFACE_TAG
{
    AZ_ULIB_RESULT(*set_position)(AZ_USTREAM* ustream_instance, offset_t position);         
    AZ_ULIB_RESULT(*reset)(AZ_USTREAM* ustream_instance);                                   
    AZ_ULIB_RESULT(*read)(AZ_USTREAM* ustream_instance, uint8_t* const buffer, 
                                            size_t buffer_length, size_t* const size);      
    AZ_ULIB_RESULT(*get_remaining_size)(AZ_USTREAM* ustream_instance, size_t* const size);  
    AZ_ULIB_RESULT(*get_position)(AZ_USTREAM* ustream_instance, offset_t* const position);  
    AZ_ULIB_RESULT(*release)(AZ_USTREAM* ustream_instance, offset_t position);              
    AZ_ULIB_RESULT(*clone)(AZ_USTREAM* ustream_instance_clone, 
                                            AZ_USTREAM* ustream_instance, offset_t offset); 
    AZ_ULIB_RESULT(*dispose)(AZ_USTREAM* ustream_instance);                                 
} AZ_USTREAM_INTERFACE;

typedef void (*AZ_RELEASE_CALLBACK)(void*);

typedef void* AZ_USTREAM_DATA;

typedef struct AZ_USTREAM_DATA_CB_TAG
{
    const AZ_USTREAM_INTERFACE* api;             
    AZ_USTREAM_DATA* ptr;                        
    volatile uint32_t ref_count;                
    AZ_RELEASE_CALLBACK data_release;           
    AZ_RELEASE_CALLBACK control_block_release;   
} AZ_USTREAM_DATA_CB;

struct AZ_USTREAM_TAG
{
    /* Control Block */
    AZ_USTREAM_DATA_CB* control_block;          
    /* Instance controls */
    offset_t offset_diff;                       
    offset_t inner_current_position;            
    offset_t inner_first_valid_position;        
    size_t length;                              
};

typedef struct AZ_USTREAM_MULTI_DATA_CB_TAG
{
    AZ_USTREAM_DATA_CB control_block;           
    AZ_USTREAM ustream_one;                     
    AZ_USTREAM ustream_two;                     
    volatile uint32_t ustream_one_ref_count;    
    volatile uint32_t ustream_two_ref_count;    
    AZ_PAL_OS_LOCK lock;                        
} AZ_USTREAM_MULTI_DATA_CB;

#define AZ_USTREAM_IS_NOT_TYPE_OF(handle, type_api)   ((handle == NULL) || (handle->control_block == NULL) || (handle->control_block->api == NULL) || (handle->control_block->api != &type_api))

static inline AZ_ULIB_RESULT az_ustream_set_position(AZ_USTREAM* ustream_instance, offset_t position)
{
    return ustream_instance->control_block->api->set_position(ustream_instance, position);
}

static inline AZ_ULIB_RESULT az_ustream_reset(AZ_USTREAM* ustream_instance)
{
    return ustream_instance->control_block->api->reset(ustream_instance);
}

static inline AZ_ULIB_RESULT az_ustream_read(AZ_USTREAM* ustream_instance, uint8_t* const buffer, size_t buffer_length, size_t* const size)
{
    return ustream_instance->control_block->api->read(ustream_instance, buffer, buffer_length, size);
}

static inline AZ_ULIB_RESULT az_ustream_get_remaining_size(AZ_USTREAM* ustream_instance, size_t* const size)
{
    return ustream_instance->control_block->api->get_remaining_size(ustream_instance, size);
}

static inline AZ_ULIB_RESULT az_ustream_get_position(AZ_USTREAM* ustream_instance, offset_t* const position)
{
    return ustream_instance->control_block->api->get_position(ustream_instance, position);
}

static inline AZ_ULIB_RESULT az_ustream_release(AZ_USTREAM* ustream_instance, offset_t position)
{
    return ustream_instance->control_block->api->release(ustream_instance, position);
}

static inline AZ_ULIB_RESULT az_ustream_clone(AZ_USTREAM* ustream_instance_clone, AZ_USTREAM* ustream_instance, offset_t offset)
{
    return ustream_instance->control_block->api->clone(ustream_instance_clone, ustream_instance, offset);
}

static inline AZ_ULIB_RESULT az_ustream_dispose(AZ_USTREAM* ustream_instance)
{
    return ustream_instance->control_block->api->dispose(ustream_instance);
}


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* AZ_USTREAM_BASE_H */