PowerMgr.h

Go to the documentation of this file.

/************************************************
*
*  CROSSCONTROL AUX API
*
*  PowerMgr.h
*
*  Version 2.7.2.0, 2014-08-25
*
*  (c) maximatecc 2013
*
*  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 (up to 20s may be okay). The computer will eventually 
*  be shut down forcibly if the application does not respond. 
*
*  This framework can be used with multiple applications at the same time.
*  Note that a shutdown initiated by the OS may not be caught by this framework. 
*  Applications may need to handle that case with a separate exit handler.
*
*  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 PowerMgrConf
  {
    Normal = 0,

    ApplicationControlled = 1, 

    BatterySuspend = 2
  }
  _PowerMgrConf;

  typedef enum PowerMgrStatus
  {
    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_ */