LibJuno 1.0.1
LibJuno is a lightweight C11 library designed specifically for embedded systems.
Loading...
Searching...
No Matches
JUNO_ASYNC_IO_API_TAG Struct Reference

#include <async_io_api.h>

Data Fields

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.
 
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.
 
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).
 
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.
 
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.
 
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.
 
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.
 

Field Documentation

◆ Poll

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

Poll for input readiness within timeout; sets pbHasData.

◆ Read

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

Read up to *pzBuffSize bytes; updates size with bytes read.

◆ ReadUntil

JUNO_STATUS_T(* JUNO_ASYNC_IO_API_TAG::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).

◆ TryRead

JUNO_STATUS_T(* JUNO_ASYNC_IO_API_TAG::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.

◆ TryReadUntil

JUNO_STATUS_T(* JUNO_ASYNC_IO_API_TAG::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.

◆ TryWrite

JUNO_STATUS_T(* JUNO_ASYNC_IO_API_TAG::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.

◆ Write

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

Write up to *pzBuffSize bytes; updates size with bytes written.


The documentation for this struct was generated from the following file: