libjuno/async__io__api_8h_source.html

/*

    MIT License


    Copyright (c) 2025 Robin A. Onsay


    Permission is hereby granted, free of charge, to any person obtaining

    a copy of this software and associated documentation files

    (the "Software"), to deal in the Software without restriction,

    including without limitation the rights to use, copy, modify, merge,

    publish, distribute, sublicense, and/or sell copies of the Software,

    and to permit persons to whom the Software is furnished to do so,

    subject to the following conditions:


    The above copyright notice and this permission notice shall be

    included in all copies or substantial portions of the Software.

*/


#ifndef JUNO_ASYNC_IO_API_H

#define JUNO_ASYNC_IO_API_H

#include "juno/status.h"

#include "juno/module.h"

#include "juno/time/time_api.h"

#include <stdbool.h>

#ifdef __cplusplus

extern "C"

{

#endif


typedef struct JUNO_ASYNC_IO_API_TAG JUNO_ASYNC_IO_API_T;


typedef struct JUNO_ASYNC_IO_ROOT_TAG JUNO_ASYNC_IO_ROOT_T;


// @{"req": ["REQ-IO-001"]}

struct JUNO_ASYNC_IO_ROOT_TAG JUNO_MODULE_ROOT(JUNO_ASYNC_IO_API_T, JUNO_MODULE_EMPTY);


struct JUNO_ASYNC_IO_API_TAG

{

    // @{"req": ["REQ-IO-002"]}

    JUNO_STATUS_T (*Read)(JUNO_ASYNC_IO_ROOT_T *ptIo, char *pcBuff, size_t *pzBuffSize);

    // @{"req": ["REQ-IO-003"]}

    JUNO_STATUS_T (*TryRead)(JUNO_ASYNC_IO_ROOT_T *ptIo, char *pcBuff, size_t *pzBuffSize, JUNO_TIME_MICROS_T iTimeoutUs);

    // @{"req": ["REQ-IO-004"]}

    JUNO_STATUS_T (*ReadUntil)(JUNO_ASYNC_IO_ROOT_T *ptIo, char *pcBuff, size_t *pzBuffSize, const char *pcStopChars, size_t zSizeStopChars);

    // @{"req": ["REQ-IO-005"]}

    JUNO_STATUS_T (*TryReadUntil)(JUNO_ASYNC_IO_ROOT_T *ptIo, char *pcBuff, size_t *pzBuffSize, const char *pcStopChars, size_t zSizeStopChars, JUNO_TIME_MICROS_T iTimeoutUs);

    // @{"req": ["REQ-IO-006"]}

    JUNO_STATUS_T (*Write)(JUNO_ASYNC_IO_ROOT_T *ptIo, const void *pvBuff, size_t *pzBuffSize);

    // @{"req": ["REQ-IO-007"]}

    JUNO_STATUS_T (*TryWrite)(JUNO_ASYNC_IO_ROOT_T *ptIo, const void *pvBuff, size_t *pzBuffSize, JUNO_TIME_MICROS_T iTimeoutUs);

    // @{"req": ["REQ-IO-008"]}

    JUNO_STATUS_T (*Poll)(JUNO_ASYNC_IO_ROOT_T *ptIo, JUNO_TIME_MICROS_T iTimeoutUs, bool *pbHasData);

};


#ifdef __cplusplus

}

#endif

#endif // JUNO_ASYNC_IO_API_H

JUNO_ASYNC_IO_ROOT_T
struct JUNO_ASYNC_IO_ROOT_TAG JUNO_ASYNC_IO_ROOT_T
Definition async_io_api.h:45

JUNO_MODULE_EMPTY
#define JUNO_MODULE_EMPTY
Helper for module definitions with no additional members.
Definition module.h:87

JUNO_MODULE_ROOT
#define JUNO_MODULE_ROOT(API_T,...)
Implement a module root struct containing ptApi and failure fields.
Definition module.h:129

JUNO_STATUS_T
int32_t JUNO_STATUS_T
Canonical status type for LibJuno functions.
Definition status.h:51

JUNO_TIME_MICROS_T
uint64_t JUNO_TIME_MICROS_T
Microseconds count type.
Definition time_api.h:77

module.h
Module system and dependency injection primitives for LibJuno.

status.h
Status codes and failure-handling helpers for LibJuno.

JUNO_ASYNC_IO_API_TAG
Definition async_io_api.h:51

JUNO_ASYNC_IO_API_TAG::Poll
JUNO_STATUS_T(* Poll)(JUNO_ASYNC_IO_ROOT_T *ptIo, JUNO_TIME_MICROS_T iTimeoutUs, bool *pbHasData)
Poll for input readiness within timeout; sets pbHasData.
Definition async_io_api.h:72

JUNO_ASYNC_IO_API_TAG::Read
JUNO_STATUS_T(* Read)(JUNO_ASYNC_IO_ROOT_T *ptIo, char *pcBuff, size_t *pzBuffSize)
Read up to *pzBuffSize bytes; updates size with bytes read.
Definition async_io_api.h:54

JUNO_ASYNC_IO_API_TAG::ReadUntil
JUNO_STATUS_T(* ReadUntil)(JUNO_ASYNC_IO_ROOT_T *ptIo, char *pcBuff, size_t *pzBuffSize, const char *pcStopChars, size_t zSizeStopChars)
Read until any stop character is received (size updated).
Definition async_io_api.h:60

JUNO_ASYNC_IO_API_TAG::TryReadUntil
JUNO_STATUS_T(* TryReadUntil)(JUNO_ASYNC_IO_ROOT_T *ptIo, char *pcBuff, size_t *pzBuffSize, const char *pcStopChars, size_t zSizeStopChars, JUNO_TIME_MICROS_T iTimeoutUs)
Try to read until stop character or timeout.
Definition async_io_api.h:63

JUNO_ASYNC_IO_API_TAG::TryWrite
JUNO_STATUS_T(* TryWrite)(JUNO_ASYNC_IO_ROOT_T *ptIo, const void *pvBuff, size_t *pzBuffSize, JUNO_TIME_MICROS_T iTimeoutUs)
Try to write with timeout; updates size with bytes written.
Definition async_io_api.h:69

JUNO_ASYNC_IO_API_TAG::Write
JUNO_STATUS_T(* Write)(JUNO_ASYNC_IO_ROOT_T *ptIo, const void *pvBuff, size_t *pzBuffSize)
Write up to *pzBuffSize bytes; updates size with bytes written.
Definition async_io_api.h:66

JUNO_ASYNC_IO_API_TAG::TryRead
JUNO_STATUS_T(* TryRead)(JUNO_ASYNC_IO_ROOT_T *ptIo, char *pcBuff, size_t *pzBuffSize, JUNO_TIME_MICROS_T iTimeoutUs)
Try to read with timeout; returns when data available or timeout.
Definition async_io_api.h:57

time_api.h
Juno Time module API and common time math helpers.