Typedefs | Enumerations | Functions

Ecore is aware of some system events that one may be interested, they are described below: More...

Typedefs

typedef enum _Ecore_Memory_State Ecore_Memory_State
 
typedef enum _Ecore_Power_State Ecore_Power_State
 

Enumerations

enum  _Ecore_Memory_State {
  ECORE_MEMORY_STATE_NORMAL ,
  ECORE_MEMORY_STATE_LOW
}
 Indicates current system memory state. More...
 
enum  _Ecore_Power_State {
  ECORE_POWER_STATE_MAINS ,
  ECORE_POWER_STATE_BATTERY ,
  ECORE_POWER_STATE_LOW
}
 Indicates current system memory state. More...
 

Functions

Ecore_Memory_State ecore_memory_state_get (void)
 Gets the current status of memory on the system. More...
 
void ecore_memory_state_set (Ecore_Memory_State state)
 Sets the memory state. More...
 
Ecore_Power_State ecore_power_state_get (void)
 Gets the current power state. More...
 
void ecore_power_state_set (Ecore_Power_State state)
 Sets the power state. More...
 

Detailed Description

Ecore is aware of some system events that one may be interested, they are described below:

Enumeration Type Documentation

◆ _Ecore_Memory_State

Indicates current system memory state.

Since
1.8
Enumerator
ECORE_MEMORY_STATE_NORMAL 

The normal memory usage state.

No need to do anything special here - operation as normal.

ECORE_MEMORY_STATE_LOW 

The system is low on memory resources.

This would indicate that it may be a good idea to free memory you don't need and minimize footprint to avoid general system problems.

◆ _Ecore_Power_State

Indicates current system memory state.

Since
1.8
Enumerator
ECORE_POWER_STATE_MAINS 

The system is connected to a mains supply of power, thus there is no need to limit processing to save battery life at all.

ECORE_POWER_STATE_BATTERY 

The system is running off battery power, but is otherwise running normally.

ECORE_POWER_STATE_LOW 

The system is low on power (on battery) and the process should do its best to conserve power.

For example it may reduce or suspend polling of network resources, turn off animations or reduce framerate etc.

Function Documentation

◆ ecore_memory_state_get()

Ecore_Memory_State ecore_memory_state_get ( void  )

Gets the current status of memory on the system.

Returns
The current memory state for the system as a whole.
Since
1.8

◆ ecore_memory_state_set()

void ecore_memory_state_set ( Ecore_Memory_State  state)

Sets the memory state.

Parameters
stateThe memory state to set.

This function will store information about the current memory state and if it changed will automatically create an ECORE_EVENT_MEMORY_STATE event.

Note
This function should not be called by user, instead a monitoring entity that is system dependent. Usually an ecore module that is platform-specific.
Since
1.8

References ecore_event_add(), and ECORE_EVENT_MEMORY_STATE.

◆ ecore_power_state_get()

Ecore_Power_State ecore_power_state_get ( void  )

Gets the current power state.

Returns
The current power state for the system.
Since
1.8

◆ ecore_power_state_set()

void ecore_power_state_set ( Ecore_Power_State  state)

Sets the power state.

Parameters
stateThe power state to set.

This function will store information about the current power state and if it changed will automatically create an ECORE_EVENT_POWER_STATE event.

Note
This function should not be called by user, instead a monitoring entity that is system dependent. Usually an ecore module that is platform-specific.
Since
1.8

References ecore_event_add(), and ECORE_EVENT_POWER_STATE.