oc_stream.h

Go to the documentation of this file.

#ifndef INC_KERNEL_OC_STREAM_H_
#define INC_KERNEL_OC_STREAM_H_

#include <stdbool.h>
#include <oc_errors.h>
#include <oc_driver.h>
#include <oc_stdlib.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

typedef enum
{
    oC_Stream_Type_Input    = (1<<0),
    oC_Stream_Type_Output   = (1<<1)
} oC_Stream_Type_t;

typedef struct Stream_t * oC_Stream_t;

typedef struct
{
    oC_Stream_Type_t        Type;
    const char *            Name;
    oC_Driver_t             Driver;
    const void *            Config;
} oC_Stream_Cfg_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

extern oC_Stream_t      oC_Stream_New               ( Allocator_t Allocator , AllocationFlags_t Flags , oC_Stream_Type_t Type , const char * Name , oC_Driver_t Driver , const void * Config );
extern bool             oC_Stream_Delete            ( oC_Stream_t * Stream );
extern bool             oC_Stream_IsCorrect         ( oC_Stream_t Stream );
extern bool             oC_Stream_IsType            ( oC_Stream_t Stream , oC_Stream_Type_t Type );
extern oC_ErrorCode_t   oC_Stream_Write             ( oC_Stream_t Stream , const char * Buffer    , uint32_t * Size , oC_IoFlags_t IoFlags );
extern oC_ErrorCode_t   oC_Stream_Read              ( oC_Stream_t Stream , char * outBuffer       , uint32_t * Size , oC_IoFlags_t IoFlags );
extern oC_ErrorCode_t   oC_Stream_ClearReadBuffer   ( oC_Stream_t Stream );
extern const char *     oC_Stream_GetName           ( oC_Stream_t Stream );
extern oC_Driver_t      oC_Stream_GetDriver         ( oC_Stream_t Stream );

#undef  _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

#endif /* INC_KERNEL_OC_STREAM_H_ */