i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ > Class Template Reference

Abstract asynchronous I2C Manager. More...

#include <fastarduino/i2c_handler_atmega.h>

Inheritance diagram for i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >:

Public Types
using	ABSTRACT_FUTURE = future::AbstractFuture
	The abstract base class of all futures to be defined for this I2C Manager. More...
template<typename OUT , typename IN >
using	FUTURE = future::Future< OUT, IN >
	The template base class of all futures to be defined for this I2C Manager. More...
using	I2CCOMMAND = I2CCommand< ABSTRACT_FUTURE >
	The type of I2CCommand to use in the buffer passed to the constructor of this AbstractI2CAsyncManager. More...

Public Member Functions
void	begin ()
	Prepare and enable the MCU for I2C transmission. More...
void	end ()
	Disable MCU I2C transmission. More...
void	begin_ ()
	Prepare and enable the MCU for I2C transmission. More...
void	end_ ()
	Disable MCU I2C transmission. More...

Friends
template<typename >
class	I2CDevice
struct	isr_handler

Detailed Description

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_, bool HAS_DEBUG_, typename DEBUG_HOOK_>
class i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >

Abstract asynchronous I2C Manager.

It is specifically subclassed for ATmega architecture. You should never need to subclass AbstractI2CAsyncManager yourself.

Template Parameters

MODE_	the I2C mode for this manager
POLICY_	the policy to use in case of an error during I2C transaction
HAS_STATUS_	tells this I2C Manager to call a status hook at each step of an I2C transaction; using false will generate smaller code.
STATUS_HOOK_	the type of the hook to be called when HAS_STATUS_ is true. This can be a simple function pointer (of type I2C_STATUS_HOOK) or a Functor class (or Functor class reference). Using a Functor class will generate smaller code.
HAS_DEBUG_	tells this I2C Manager to call a debugging hook at each step of an I2C transaction; this is useful for debugging support for a new I2C device; using false will generate smaller code.
DEBUG_HOOK_	the type of the hook to be called when IS_DEBUG is true. This can be a simple function pointer (of type I2C_DEBUG_HOOK) or a Functor class (or Functor class reference). Using a Functor class will generate smaller code.

See also

I2CMode

I2C_STATUS_HOOK

I2C_DEBUG_HOOK

i2c::debug

i2c::status

Definition at line 358 of file i2c_handler_atmega.h.

Member Typedef Documentation

ABSTRACT_FUTURE

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

using i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >::ABSTRACT_FUTURE = future::AbstractFuture

The abstract base class of all futures to be defined for this I2C Manager.

For an asynchronous manager, it is always future::AbstractFuture.

Definition at line 373 of file i2c_handler_atmega.h.

FUTURE

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

template<typename OUT , typename IN >

using i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >::FUTURE = future::Future<OUT, IN>

The template base class of all futures to be defined for this I2C Manager.

For an asynchronous manager, it is always future::Future.

Definition at line 379 of file i2c_handler_atmega.h.

I2CCOMMAND

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

using i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >::I2CCOMMAND = I2CCommand<ABSTRACT_FUTURE>

The type of I2CCommand to use in the buffer passed to the constructor of this AbstractI2CAsyncManager.

Definition at line 385 of file i2c_handler_atmega.h.

Member Function Documentation

begin()

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

void i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >::begin ( )

inline

Prepare and enable the MCU for I2C transmission.

Preparation includes setup of I2C pins (SDA and SCL). This method is synchronized.

See also

end()

begin_()

Definition at line 394 of file i2c_handler_atmega.h.

end()

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

void i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >::end ( )

inline

Disable MCU I2C transmission.

This method is synchronized.

See also

begin()

end_()

Definition at line 405 of file i2c_handler_atmega.h.

begin_()

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

void i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >::begin_ ( )

inline

Prepare and enable the MCU for I2C transmission.

Preparation includes setup of I2C pins (SDA and SCL). This method is NOT synchronized.

See also

end_()

begin()

Definition at line 417 of file i2c_handler_atmega.h.

end_()

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

void i2c::AbstractI2CAsyncManager< MODE_, POLICY_, HAS_STATUS_, STATUS_HOOK_, HAS_DEBUG_, DEBUG_HOOK_ >::end_ ( )

inline

Disable MCU I2C transmission.

This method is NOT synchronized.

See also

begin_()

end()

Definition at line 434 of file i2c_handler_atmega.h.

Friends And Related Function Documentation

I2CDevice

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

template<typename >

friend class I2CDevice

friend

Definition at line 748 of file i2c_handler_atmega.h.

isr_handler

template<I2CMode MODE_, I2CErrorPolicy POLICY_, bool HAS_STATUS_, typename STATUS_HOOK_ , bool HAS_DEBUG_, typename DEBUG_HOOK_ >

friend struct isr_handler

friend

Definition at line 749 of file i2c_handler_atmega.h.

---

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

• fastarduino/i2c_handler_atmega.h