PowerMgr.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Access functions for managing application shutdown/cleanup
 *  when suspend or shutdown events occur. An application can use this framework
 *  to delay a suspend/shutdown until it is ready with any tasks it needs to do.
 *  It is also possible to use existing OS functions to achieve the same result.
 *
 *  Note that applications should not use these functions to delay a suspend/shutdown
 *  request for a long time (more than 20-30s depending on platform). The computer will
 *  eventually be shut down forcibly if the application does not respond.
 *
 *  It is not recommended for multiple applications to access the PowerMgr
 *  functionality simultaneously, although it is supported on some platforms.
 *
 *  Note that a shutdown initiated by the OS will not be caught by this framework.
 *
 *  Example Usage:
 *  @include powermgr_example.cpp
 *
 ************************************************/
 
#ifndef CC_POWERMGR_H_
#define CC_POWERMGR_H_
 
#include "CCAuxErrors.h"
#include "CCAuxTypes.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef enum
{
    Normal = 0,
 
    ApplicationControlled = 1,
 
    BatterySuspend = 2
} PowerMgrConf;
 
typedef enum
{
    NoRequestsPending = 0,
    SuspendPending = 1,
    ShutdownPending = 2
} PowerMgrStatus;
 
typedef void *POWERMGRHANDLE;
 
EXTERN_C
CCAUXDLL_API
POWERMGRHANDLE
CCAUXDLL_CALLING_CONV
GetPowerMgr(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV PowerMgr_release(POWERMGRHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PowerMgr_registerControlledSuspendOrShutDown(POWERMGRHANDLE, PowerMgrConf conf);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PowerMgr_getConfiguration(POWERMGRHANDLE, PowerMgrConf *conf);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PowerMgr_getPowerMgrStatus(POWERMGRHANDLE, PowerMgrStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PowerMgr_setAppReadyForSuspendOrShutdown(POWERMGRHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PowerMgr_hasResumed(POWERMGRHANDLE, bool *resumed);
 
#ifdef __cplusplus
}
#endif
 
#endif /* CC_POWERMGR_H_ */