SE050 Driver
API reference
Loading...
Searching...
No Matches
Public Member Functions | List of all members
se050::Session< TransportT > Class Template Reference

Transport-facing session (no owned buffers). More...

#include <se050_session.hpp>

Public Member Functions

 Session (TransportT &transport) noexcept
 
bool EnsureReady () noexcept
 Propagates to the transport’s EnsureInitialized().
 
Error TransceiveRaw (const std::uint8_t *tx, std::size_t tx_len, std::uint8_t *rx, std::size_t rx_cap, std::size_t *rx_len_out, std::uint32_t timeout_ms) noexcept
 Raw transceive used for early bring-up (not a substitute for se050::T1Session).
 
Error PulseReset () noexcept
 Optional GPIO / power-style reset routed through the transport.
 
TransportT & Transport () noexcept
 
const TransportT & Transport () const noexcept
 

Detailed Description

template<typename TransportT>
class se050::Session< TransportT >

Transport-facing session (no owned buffers).

Template Parameters
TransportTConcrete type implementing I2cTransceiveInterface.

Constructor & Destructor Documentation

◆ Session()

template<typename TransportT >
se050::Session< TransportT >::Session ( TransportT &  transport)
inlineexplicitnoexcept

Member Function Documentation

◆ EnsureReady()

template<typename TransportT >
bool se050::Session< TransportT >::EnsureReady ( )
inlinenoexcept

Propagates to the transport’s EnsureInitialized().

◆ PulseReset()

template<typename TransportT >
Error se050::Session< TransportT >::PulseReset ( )
inlinenoexcept

Optional GPIO / power-style reset routed through the transport.

◆ TransceiveRaw()

template<typename TransportT >
Error se050::Session< TransportT >::TransceiveRaw ( const std::uint8_t *  tx,
std::size_t  tx_len,
std::uint8_t *  rx,
std::size_t  rx_cap,
std::size_t *  rx_len_out,
std::uint32_t  timeout_ms 
)
inlinenoexcept

Raw transceive used for early bring-up (not a substitute for se050::T1Session).

Parameters
tx_lenMust be non-zero (SE050 I²C errata).

◆ Transport() [1/2]

template<typename TransportT >
const TransportT & se050::Session< TransportT >::Transport ( ) const
inlinenoexcept

◆ Transport() [2/2]

template<typename TransportT >
TransportT & se050::Session< TransportT >::Transport ( )
inlinenoexcept

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