#include <AppContext.h>

Collaboration diagram for AppContext:

Public Member Functions
template<typename T >
void	registerService (T *service)

template<typename T >
T *	getService () const

void	initFrameworkServices ()

Static Public Member Functions
static AppContext &	getInstance ()

template<typename T >
static T *	get ()
	Get a service of type T from the application context.

template<typename T >
static bool	has ()

Private Member Functions
	AppContext ()=default

Static Private Member Functions
template<typename T >
static constexpr std::uintptr_t	getTypeKey ()

Private Attributes
std::unordered_map< std::uintptr_t, void * >	services

Static Private Attributes
static SemaphoreHandle_t	mutex = xSemaphoreCreateMutex()

Detailed Description

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Definition at line 9 of file AppContext.h.

Constructor & Destructor Documentation

◆ AppContext()

AppContext::AppContext ( )

privatedefault

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Member Function Documentation

◆ get()

template<typename T >

static T * AppContext::get ( )

inlinestatic

This is a convenience method that allows you to get a service without needing to call getService<T>() explicitly.

Template Parameters

T	The type of the service to retrieve. Must be a complete type.

Returns: Pointer to the service instance if found, nullptr otherwise.

Note: If the service is not registered, this will return nullptr.

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Definition at line 63 of file AppContext.h.

                    {
        return getInstance().getService<T>();
    }

References getInstance(), getService(), and getTypeKey().

Here is the call graph for this function:

◆ getInstance()

AppContext & AppContext::getInstance ( )

static

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Definition at line 22 of file AppContext.cpp.

                                    {
    static AppContext instance;
    return instance;
}

Referenced by get(), getFormattedTimestamp(), FrameworkManager::onStart(), and traceLog().

Here is the caller graph for this function:

◆ getService()

template<typename T >

T * AppContext::getService ( ) const

inline

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Definition at line 45 of file AppContext.h.

                          {
        xSemaphoreTake(mutex, portMAX_DELAY);
        auto it = services.find(getTypeKey<T>());
        xSemaphoreGive(mutex);
        if (it != services.end()) {
            return reinterpret_cast<T*>(it->second);
        }
        return nullptr;
    }

References getTypeKey(), mutex, and services.

Referenced by get(), getFormattedTimestamp(), and traceLog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeKey()

template<typename T >

static constexpr std::uintptr_t AppContext::getTypeKey ( )

inlinestaticconstexprprivate

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Definition at line 91 of file AppContext.h.

                                               {
        return reinterpret_cast<std::uintptr_t>(&getTypeKey<T>); // unique per T
    }

References getTypeKey().

Referenced by TimeManager::applyFixedTimezoneOffset(), DashboardController::deleteFile(), MultipartParser::extractFilename(), MultipartParser::file_exists(), Logger::forEachLine(), get(), getService(), getTypeKey(), FrameworkModel::getValue(), GpioEventManager::gpio_event_handler(), has(), FileHandler::init(), initFrameworkServices(), HttpServer::initListener(), App::initRoutes(), FileHandler::listDirectory(), FrameworkModel::load(), Logger::log(), App::onEvent(), FrameworkManager::onEvent(), FrameworkManager::onStart(), App::onStart(), FrameworkManager::poll(), App::poll(), MultipartParser::processFileData(), registerService(), HtmlTemplateView::render(), HttpServer::run(), FrameworkModel::save(), FrameworkModel::saveAll(), TimerService::scheduleAt(), TimerService::scheduleDailyAt(), TimerService::scheduleDuration(), TimerService::scheduleEvery(), FileHandler::serveFile(), TimeManager::setTime(), TimeManager::setTimeFromEpoch(), FrameworkManager::setupTraceFromConfig(), FrameworkModel::setValue(), sntp_set_system_time(), TimeManager::start(), and TimeManager::syncTimeWithNtp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ has()

template<typename T >

static bool AppContext::has ( )

inlinestatic

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Definition at line 68 of file AppContext.h.

                      {
        return get<T>() != nullptr;
    }

References getTypeKey().

Here is the call graph for this function:

◆ initFrameworkServices()

void AppContext::initFrameworkServices ( )

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Definition at line 27 of file AppContext.cpp.

                                       {
    printf("[AppContext] Initializing framework services...\n");
    #if PICO_HTTP_ENABLE_LITTLEFS
        TRACE("[AppContext] Initializing LittleFS storage manager.\n");
        static LittleFsStorageManager littlefs;
        registerService<StorageManager>(&littlefs);
        TRACE("[AppContext] LittleFS storage manager registered.\n");
        static JsonService jsonService(&littlefs);
        registerService<JsonService>(&jsonService);
        TRACE("[AppContext] Registered JsonService.\n");
        
    #else
        static FatFsStorageManager fatfs;
        registerService<StorageManager>(&fatfs);
        static JsonService jsonService(&fatfs);
        registerService<JsonService>(&jsonService);
        TRACE("[AppContext] Registered FatFsStorageManager.\n");
    #endif
        // Time manager (always present)
        static TimeManager timeMgr;
        registerService<TimeManager>(&timeMgr);
        TRACE("[AppContext] Registered TimeManager.\n");
        // Event manager (always present)
        static EventManager eventMgr;
        registerService<EventManager>(&eventMgr);
        TRACE("[AppContext] Registered EventManager.\n");
        // Timer service (always present)
        static TimerService timerService;
        registerService<TimerService>(&timerService);
        TRACE("[AppContext] Registered TimerService.\n");
        static Logger logger;
        registerService<Logger>(&logger);
        TRACE("[AppContext] Registered Logger.\n");
    #if defined(ENABLE_GPIO_EVENTS)
        static GpioEventManager gpioEventManager = GpioEventManager::getInstance();
        AppContext::registerService<GpioEventManager>(&gpioEventManager);
        TRACE("[AppContext] Registered GpioEventManager.\n");
    #endif
    
    #if PICO_HTTP_ENABLE_JWT
        static JwtAuthenticator jwt;
        registerService<JwtAuthenticator>(&jwt);
        TRACE("[AppContext] Registered JwtAuthenticator.\n");
    #endif
    }

References GpioEventManager::getInstance(), getTypeKey(), and TRACE.

Referenced by FrameworkManager::onStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerService()

template<typename T >

void AppContext::registerService ( T * service )

inline

Examples: /home/runner/work/pico-framework-docs/pico-framework-docs/pico-framework/framework/include/framework/AppContext.h.

Definition at line 27 of file AppContext.h.

                                     {
        xSemaphoreTake(mutex, portMAX_DELAY);
        services[getTypeKey<T>()] = reinterpret_cast<void*>(service);
        xSemaphoreGive(mutex);
    }