-/*
+/**
* Copyright (c) 2011 - 2015 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
{
#endif
- /**
- * @addtogroup CAPI_SYSTEM_RUNTIME_INFO_MODULE
+
+/**
+ * @addtogroup CAPI_SYSTEM_RUNTIME_INFO_MODULE
* @{
*/
+
/**
- * @brief Enumeration for error codes for runtime information.
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Enumeration for error codes for runtime information.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
- RUNTIME_INFO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
- RUNTIME_INFO_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
- RUNTIME_INFO_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
- RUNTIME_INFO_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< An input/output error occurred when read value from system */
- RUNTIME_INFO_ERROR_REMOTE_IO = TIZEN_ERROR_REMOTE_IO, /**< Remote I/O error occured */
- RUNTIME_INFO_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< No permission to use the api */
- RUNTIME_INFO_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported parameter */
- RUNTIME_INFO_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA /**< No data available (Since 3.0) */
+ RUNTIME_INFO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
+ RUNTIME_INFO_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
+ RUNTIME_INFO_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
+ RUNTIME_INFO_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< An input/output error occurred when read value from system */
+ RUNTIME_INFO_ERROR_REMOTE_IO = TIZEN_ERROR_REMOTE_IO, /**< Remote I/O error occurred */
+ RUNTIME_INFO_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< No permission to use the api */
+ RUNTIME_INFO_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported parameter */
+ RUNTIME_INFO_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA /**< No data available (Since 3.0) */
} runtime_info_error_e;
+
/**
- * @brief Enumeration for keys for runtime information..
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Enumeration for keys for runtime information.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
- RUNTIME_INFO_KEY_BLUETOOTH_ENABLED = 2, /**<Indicates whether Bluetooth is enabled. */
- RUNTIME_INFO_KEY_WIFI_HOTSPOT_ENABLED = 3, /**<Indicates whether Wi-Fi hotspot is enabled. */
- RUNTIME_INFO_KEY_BLUETOOTH_TETHERING_ENABLED = 4, /**<Indicates whether Bluetooth tethering is enabled. */
- RUNTIME_INFO_KEY_USB_TETHERING_ENABLED = 5, /**<Indicates whether USB tethering is enabled. */
- RUNTIME_INFO_KEY_LOCATION_SERVICE_ENABLED = 6, /**<Indicates whether the location service is allowed to use location data from GPS satellites. */
- RUNTIME_INFO_KEY_LOCATION_NETWORK_POSITION_ENABLED = 8, /**<Indicates whether the location service is allowed to use location data from cellular and Wi-Fi. */
- RUNTIME_INFO_KEY_PACKET_DATA_ENABLED = 9, /**<Indicates Whether the packet data through 3G network is enabled. */
- RUNTIME_INFO_KEY_DATA_ROAMING_ENABLED = 10, /**<Indicates whether data roaming is enabled. */
- RUNTIME_INFO_KEY_VIBRATION_ENABLED = 12, /**<Indicates whether vibration is enabled. */
- RUNTIME_INFO_KEY_AUDIO_JACK_CONNECTED = 17, /**<Indicates whether audio jack is connected. */
- RUNTIME_INFO_KEY_GPS_STATUS = 18, /**<Indicates the current status of GPS. */
- RUNTIME_INFO_KEY_BATTERY_IS_CHARGING = 19, /**<Indicates the battery is currently charging. */
- RUNTIME_INFO_KEY_TV_OUT_CONNECTED = 20, /**<Indicates whether TV out is connected. */
- RUNTIME_INFO_KEY_AUDIO_JACK_STATUS = 21, /**<Indicates the current status of audio jack. */
- RUNTIME_INFO_KEY_USB_CONNECTED = 23, /**<Indicates whether USB is connected. */
- RUNTIME_INFO_KEY_CHARGER_CONNECTED = 24, /**<Indicates whether charger is connected. */
- RUNTIME_INFO_KEY_AUTO_ROTATION_ENABLED = 26, /**<Indicates whether auto rotation is enabled. */
+ RUNTIME_INFO_KEY_BLUETOOTH_ENABLED = 2, /**<Indicates whether Bluetooth is enabled. */
+ RUNTIME_INFO_KEY_WIFI_HOTSPOT_ENABLED = 3, /**<Indicates whether Wi-Fi hotspot is enabled. */
+ RUNTIME_INFO_KEY_BLUETOOTH_TETHERING_ENABLED = 4, /**<Indicates whether Bluetooth tethering is enabled. */
+ RUNTIME_INFO_KEY_USB_TETHERING_ENABLED = 5, /**<Indicates whether USB tethering is enabled. */
+ RUNTIME_INFO_KEY_PACKET_DATA_ENABLED = 9, /**<Indicates Whether the packet data through 3G network is enabled. */
+ RUNTIME_INFO_KEY_DATA_ROAMING_ENABLED = 10, /**<Indicates whether data roaming is enabled. */
+ RUNTIME_INFO_KEY_VIBRATION_ENABLED = 12, /**<Indicates whether vibration is enabled. */
+ RUNTIME_INFO_KEY_AUDIO_JACK_CONNECTED = 17, /**<Indicates whether audio jack is connected. */
+ RUNTIME_INFO_KEY_GPS_STATUS = 18, /**<Indicates the current status of GPS. */
+ RUNTIME_INFO_KEY_BATTERY_IS_CHARGING = 19, /**<Indicates the battery is currently charging. */
+ RUNTIME_INFO_KEY_TV_OUT_CONNECTED = 20, /**<Indicates whether TV out is connected. */
+ RUNTIME_INFO_KEY_AUDIO_JACK_STATUS = 21, /**<Indicates the current status of audio jack. */
+ RUNTIME_INFO_KEY_USB_CONNECTED = 23, /**<Indicates whether USB is connected. */
+ RUNTIME_INFO_KEY_CHARGER_CONNECTED = 24, /**<Indicates whether charger is connected. */
+ RUNTIME_INFO_KEY_AUTO_ROTATION_ENABLED = 26, /**<Indicates whether auto rotation is enabled. */
} runtime_info_key_e;
/**
- * @brief Enumeration for Wi-Fi status.
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Enumeration for Wi-Fi status.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
- RUNTIME_INFO_WIFI_STATUS_DISABLED, /**< GPS is disabled. */
- RUNTIME_INFO_WIFI_STATUS_UNCONNECTED, /**< Wi-Fi is enabled and network connection is not established. */
- RUNTIME_INFO_WIFI_STATUS_CONNECTED, /**< Network connection is established in Wi-Fi network. */
+ RUNTIME_INFO_WIFI_STATUS_DISABLED, /**< Wi-Fi is disabled. */
+ RUNTIME_INFO_WIFI_STATUS_UNCONNECTED, /**< Wi-Fi is enabled and network connection is not established. */
+ RUNTIME_INFO_WIFI_STATUS_CONNECTED, /**< Network connection is established in Wi-Fi network. */
} runtime_info_wifi_status_e;
+
/**
- * @brief Enumeration for GPS status.
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Enumeration for GPS status.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
- RUNTIME_INFO_GPS_STATUS_DISABLED, /**< GPS is disabled. */
- RUNTIME_INFO_GPS_STATUS_SEARCHING, /**< GPS is searching for satellites. */
- RUNTIME_INFO_GPS_STATUS_CONNECTED, /**< GPS connection is established. */
+ RUNTIME_INFO_GPS_STATUS_DISABLED, /**< GPS is disabled. */
+ RUNTIME_INFO_GPS_STATUS_SEARCHING, /**< GPS is searching for satellites. */
+ RUNTIME_INFO_GPS_STATUS_CONNECTED, /**< GPS connection is established. */
} runtime_info_gps_status_e;
/**
- * @brief Enumeration for audio jack status.
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Enumeration for audio jack status.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*/
typedef enum {
- RUNTIME_INFO_AUDIO_JACK_STATUS_UNCONNECTED, /**< Audio jack is not connected */
- RUNTIME_INFO_AUDIO_JACK_STATUS_CONNECTED_3WIRE, /**< 3-conductor wire is connected. */
- RUNTIME_INFO_AUDIO_JACK_STATUS_CONNECTED_4WIRE, /**< 4-conductor wire is connected. */
+ RUNTIME_INFO_AUDIO_JACK_STATUS_UNCONNECTED, /**< Audio jack is not connected */
+ RUNTIME_INFO_AUDIO_JACK_STATUS_CONNECTED_3WIRE, /**< 3-conductor wire is connected. */
+ RUNTIME_INFO_AUDIO_JACK_STATUS_CONNECTED_4WIRE, /**< 4-conductor wire is connected. */
} runtime_info_audio_jack_status_e;
/**
- * @brief Called when the runtime information changes
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Called when the runtime information changes.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
- * @param[in] key The type of notification
- * @param[in] user_data The user data passed from the callback registration function
+ * @param[in] key The type of notification
+ * @param[in] user_data The user data passed from the callback registration function
*
- * @pre runtime_info_set_changed_cb() will invoke this callback function.
- *
- * @see runtime_info_set_changed_cb()
- * @see runtime_info_unset_changed_cb()
+ * @pre runtime_info_set_changed_cb() will invoke this callback function.
+ * @see runtime_info_set_changed_cb()
+ * @see runtime_info_unset_changed_cb()
*/
typedef void (*runtime_info_changed_cb)(runtime_info_key_e key, void *user_data);
+
/**
- * @brief Gets the integer value of the runtime information.
- * @details This function gets current state of the given key which represents specific runtime information.
+ * @brief Gets the integer value of the runtime information.
+ * @details This function gets current state of the given key which represents specific runtime information.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
- *
- * @param[in] key The runtime information status key from which data should be read
- * @param[out] value The current value of the given key
+ * @param[in] key The runtime information status key from which data should be read
+ * @param[out] value The current value of the given key
*
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
- * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
- * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
+ * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
*/
int runtime_info_get_value_int(runtime_info_key_e key, int *value);
+
/**
- * @brief Gets the boolean value from the runtime information.
- * @details This function gets current state of the given key which represents specific runtime information.
- *
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Gets the boolean value from the runtime information.
+ * @details This function gets current state of the given key which represents specific runtime information.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
- * @param[in] key The runtime information key from which data should be read
- * @param[out] value The current value of the given key
+ * @param[in] key The runtime information key from which data should be read
+ * @param[out] value The current value of the given key
*
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
- * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
- * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
+ * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
*/
int runtime_info_get_value_bool(runtime_info_key_e key, bool *value);
+
/**
- * @brief Gets the double value from the runtime information.
- * @details This function gets current state of the given key which represents specific runtime information.
- *
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Gets the double value from the runtime information.
+ * @details This function gets current state of the given key which represents specific runtime information.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
- * @param[in] key The runtime information key from which data should be read
- * @param[out] value The current value of the given key
+ * @param[in] key The runtime information key from which data should be read
+ * @param[out] value The current value of the given key
*
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
- * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
- * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
+ * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
*/
int runtime_info_get_value_double(runtime_info_key_e key, double *value);
+
/**
- * @brief Gets the string value for specified runtime information.
- * @details This function gets current state of the given key which represents specific runtime information.
- *
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Gets the string value for specified runtime information.
+ * @details This function gets current state of the given key which represents specific runtime information.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
* @remarks You must release @a value using free().
*
- * @param[in] key The runtime information key from which data should be read
- * @param[out] value The current value of the given key
+ * @param[in] key The runtime information key from which data should be read
+ * @param[out] value The current value of the given key
*
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
- * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
- * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
+ * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
+ * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
*/
int runtime_info_get_value_string(runtime_info_key_e key, char **value);
/**
- * @brief Registers a change event callback for given runtime information key.
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Registers a change event callback for given runtime information key.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
- * @param[in] key The runtime information type
- * @param[in] callback The callback function to invoke
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] key The runtime information type
+ * @param[in] callback The callback function to invoke
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
- * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
- * @post runtime_info_changed_cb() will be invoked.
- *
- * @see runtime_info_unset_changed_cb()
- * @see runtime_info_changed_cb()
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED No permission to use the api
+ * @retval #RUNTIME_INFO_ERROR_NOT_SUPPORTED Not supported parameter
+ *
+ * @post runtime_info_changed_cb() will be invoked.
+ * @see runtime_info_unset_changed_cb()
+ * @see runtime_info_changed_cb()
*/
int runtime_info_set_changed_cb(runtime_info_key_e key, runtime_info_changed_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
- * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @brief Unregisters the callback function.
+ * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
*
- * @param[in] key The runtime information type
+ * @param[in] key The runtime information type
*
* @return @c 0 on success,
* otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- *
- * @see runtime_info_set_changed_cb()
+ * @see runtime_info_set_changed_cb()
*/
int runtime_info_unset_changed_cb(runtime_info_key_e key);
+
/**
- * @brief Structure for memory information.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @brief Structure for memory information.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef struct {
- int total; /**< Total memory (KiB) */
- int used; /**< Used memory (KiB) */
- int free; /**< Free memory (KiB) */
- int cache; /**< Cache memory (KiB) */
- int swap; /**< Swap memory (KiB) */
+ int total; /**< Total memory (KiB) */
+ int used; /**< Used memory (KiB) */
+ int free; /**< Free memory (KiB) */
+ int cache; /**< Cache memory (KiB) */
+ int swap; /**< Swap memory (KiB) */
} runtime_memory_info_s;
+
/**
- * @brief Gets system memory information
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @brief Gets system memory information.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*
- * @param[out] info The system memory information structure
+ * @param[out] info The system memory information structure
*
* @return @c 0 on success,
* otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An Input/Output error occurred while reading from system
*
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An Input/Output error occured while reading from system
- *
- * @see runtime_info_get_process_memory_info()
+ * @see runtime_info_get_process_memory_info()
*/
int runtime_info_get_system_memory_info(runtime_memory_info_s *info);
+
/**
- * @brief Structure for memory information per processes.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @brief Structure for memory information per process.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef struct {
- int vsz; /**< Virtual memory size (KiB) */
- int rss; /**< Resident set size (KiB) */
- int pss; /**< Proportional set size (KiB) */
- int shared_clean; /**< Not modified and mapped by other processes (KiB) */
- int shared_dirty; /**< Modified and mapped by other processes (KiB) */
- int private_clean; /**< Not modified and available only to that process (KiB) */
- int private_dirty; /**< Modified and available only to that process (KiB) */
+ int vsz; /**< Virtual memory size (KiB) */
+ int rss; /**< Resident set size (KiB) */
+ int pss; /**< Proportional set size (KiB) */
+ int shared_clean; /**< Not modified and mapped by other processes (KiB) */
+ int shared_dirty; /**< Modified and mapped by other processes (KiB) */
+ int private_clean; /**< Not modified and available only to that process (KiB) */
+ int private_dirty; /**< Modified and available only to that process (KiB) */
} process_memory_info_s;
+
/**
- * @brief Gets memory information per processes
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
- * @privlevel public
- * @privilege %http://tizen.org/privilege/systemmonitor
+ * @brief Gets memory information per process.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*
- * @remarks You must release @a s value using free(). \n
- * The size of @a s is the same with @a size.
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/systemmonitor
+ * @remarks You must release @a s value using free(). \n
+ * The size of @a s is the same with @a size.
*
- * @param[in] pid The process unique id array
- * @param[in] size The size of pid array
- * @param[out] info The memory information structure array of the processes
+ * @param[in] pid The process unique id array
+ * @param[in] size The size of pid array
+ * @param[out] info The memory information structure array of the processes
*
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Not able to allocate memory (for output param/other operations)
- * @retval #RUNTIME_INFO_ERROR_REMOTE_IO Call to resource daemon failed (dbus errors/resource daemon errors)
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error during dbus message operations
- * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED Process not authorized to request process usage info
- *
- * @see runtime_info_get_system_memory_info()
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Not able to allocate memory (for output param/other operations)
+ * @retval #RUNTIME_INFO_ERROR_REMOTE_IO Call to resource daemon failed (dbus errors/resource daemon errors)
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error during dbus message operations
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED Process not authorized to request process usage info
+ *
+ * @see runtime_info_get_system_memory_info()
*/
int runtime_info_get_process_memory_info(int *pid, int size, process_memory_info_s **info);
+
/**
- * @brief Structure for cpu usage.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @brief Structure for CPU usage.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef struct {
double user; /**< Time running un-niced user processes (Percent) */
double iowait; /**< Time waiting for I/O completion (Percent) */
} runtime_cpu_usage_s;
+
/**
- * @brief Gets cpu information
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @brief Gets CPU information.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*
- * @param[out] usage The cpu usage structure
+ * @param[out] usage The CPU usage structure
*
* @return @c 0 on success,
* otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occurred while reading from system
*
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An input/output error occured while reading from system
- *
- * @see runtime_info_get_process_cpu_usage()
+ * @see runtime_info_get_process_cpu_usage()
*/
int runtime_info_get_cpu_usage(runtime_cpu_usage_s *usage);
+
/**
- * @brief Structure for cpu usage per processes.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @brief Structure for CPU usage per process.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*/
typedef struct {
- int utime; /**< Amount of time that this process has been scheduled in user mode (clock ticks) */
- int stime; /**< Amount of time that this process has been scheduled in kernel mode (clock ticks) */
+ int utime; /**< Amount of time that this process has been scheduled in user mode (clock ticks) */
+ int stime; /**< Amount of time that this process has been scheduled in kernel mode (clock ticks) */
} process_cpu_usage_s;
+
/**
- * @brief Gets cpu usage per processes
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
- * @privlevel public
- * @privilege %http://tizen.org/privilege/systemmonitor
+ * @brief Gets CPU usage per process.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
*
- * @remarks You must release @a s value using free(). \n
- * The size of @a s is the same with @a size.
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/systemmonitor
+ * @remarks You must release @a s value using free(). \n
+ * The size of @a s is the same with @a size.
*
- * @param[in] pid The process unique id array
- * @param[in] size The size of pid array
- * @param[out] usage The cpu usage structure array of the processes
+ * @param[in] pid The process unique id array
+ * @param[in] size The size of pid array
+ * @param[out] usage The CPU usage structure array of the processes
*
* @return @c 0 on success,
* otherwise a negative error value
- *
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Not able to allocate memory (for output param/other operations)
- * @retval #RUNTIME_INFO_ERROR_REMOTE_IO Call to resource daemon failed (dbus errors/resource daemon errors)
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occured (during dbus message operations/other IO operations)
- * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED Process not authorized to request process usage info
- *
- * @see runtime_info_get_cpu_usage()
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Not able to allocate memory (for output param/other operations)
+ * @retval #RUNTIME_INFO_ERROR_REMOTE_IO Call to resource daemon failed (dbus errors/resource daemon errors)
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occurred (during dbus message operations/other IO operations)
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED Process not authorized to request process usage info
+ *
+ * @see runtime_info_get_cpu_usage()
*/
int runtime_info_get_process_cpu_usage(int *pid, int size, process_cpu_usage_s **usage);
+
/**
- * @brief Gets the number of processors
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @brief Gets the number of processors.
+ * @since_tizen 3.0
*
- * @param[out] num_core The number of whole processors
+ * @param[out] num_core The number of whole processors
*
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occurred (during file open operation)
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occurred (during file open operation)
*/
int runtime_info_get_processor_count(int *num_core);
+
/**
- * @brief Gets the current frequency of processor
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @brief Gets the current frequency of processor.
+ * @since_tizen 3.0
*
- * @param[in] core_idx The index (from 0) of CPU core that you want to know the frequency
- * @param[out] cpu_freq The current frequency(MHz) of processor
+ * @param[in] core_idx The index (from 0) of CPU core that you want to know the frequency
+ * @param[out] cpu_freq The current frequency(MHz) of processor
*
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occurred (during file open operation)
- * @retval #RUNTIME_INFO_ERROR_NO_DATA No data available (Since 3.0)
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occurred (during file open operation)
+ * @retval #RUNTIME_INFO_ERROR_NO_DATA No data available (Since 3.0)
*/
int runtime_info_get_processor_current_frequency(int core_idx, int *cpu_freq);
+
/**
- * @brief Gets the max frequency of processor
- * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ * @brief Gets the max frequency of processor.
+ * @since_tizen 3.0
*
- * @param[in] core_idx The index (from 0) of CPU core that you want to know the frequency
- * @param[out] cpu_freq The max frequency(MHz) of processor
+ * @param[in] core_idx The index (from 0) of CPU core that you want to know the frequency
+ * @param[out] cpu_freq The max frequency(MHz) of processor
*
- * @retval #RUNTIME_INFO_ERROR_NONE Successful
- * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occurred (during file open operation)
- * @retval #RUNTIME_INFO_ERROR_NO_DATA No data available (Since 3.0)
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occurred (during file open operation)
+ * @retval #RUNTIME_INFO_ERROR_NO_DATA No data available (Since 3.0)
*/
int runtime_info_get_processor_max_frequency(int core_idx, int *cpu_freq);
+
+/**
+ * @brief Gets the physical memory size.
+ * @since_tizen 4.0
+ *
+ * @param[out] size Physical memory size (KiB)
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error occurred (during file open operation)
+ */
+int runtime_info_get_physical_memory_size(int *size);
+
+
+/**
+ * @brief Handle for app usage information.
+ * @since_tizen 4.0
+ */
+typedef struct app_usages_s *app_usage_h;
+
+
+/**
+ * @brief Frees an app usage handle.
+ * @since_tizen 4.0
+ *
+ * @param[in] handle App usage handle to free
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ */
+int runtime_info_app_usage_destroy(app_usage_h handle);
+
+
+/**
+ * @brief Gets the app count from an app usage handle.
+ * @since_tizen 4.0
+ *
+ * @param[in] handle The app usage handle
+ * @param[out] count The number of apps on the app list
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ *
+ * @see runtime_info_get_all_apps_memory_usage()
+ * @see runtime_info_get_all_apps_cpu_rate()
+ */
+int runtime_info_app_usage_get_count(app_usage_h handle, int *count);
+
+
+/**
+ * @brief Gets the app ID from an app usage handle.
+ * @since_tizen 4.0
+ *
+ * @remarks You must release @a appid using free().
+ *
+ * @param[in] handle The app usage handle
+ * @param[in] index The index in the app list; should be between 0 and @a count - 1 (inclusive), \n
+ * where @a count is provided by runtime_info_app_usage_get_count()
+ * @param[out] appid The app ID
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ *
+ * @see runtime_info_get_all_apps_memory_usage()
+ * @see runtime_info_get_all_apps_cpu_rate()
+ */
+int runtime_info_app_usage_get_appid(app_usage_h handle, int index, char **appid);
+
+
+/**
+ * @brief Gets resource usage from an app usage handle.
+ * @since_tizen 4.0
+ *
+ * @remarks The meaning of @a usage depends on which function was used to create @a handle.
+ *
+ * @param[in] handle The app usage handle
+ * @param[in] index The index in the app list; should be between 0 and @a count - 1 (inclusive), \n
+ * where @a count is provided by runtime_info_app_usage_get_count()
+ * @param[out] usage Resource usage
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ *
+ * @see runtime_info_get_all_apps_memory_usage()
+ * @see runtime_info_get_all_apps_cpu_rate()
+ */
+int runtime_info_app_usage_get_usage(app_usage_h handle, int index, unsigned int *usage);
+
+
+/**
+ * @brief Gets memory usage of all apps.
+ * @since_tizen 4.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/systemmonitor
+ * @remarks You must release @a usage using runtime_info_app_usage_destroy().
+ *
+ * @param[out] usage An array of each app's memory usage (KB)
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Not able to allocate memory (for output param/other operations)
+ * @retval #RUNTIME_INFO_ERROR_REMOTE_IO Call to resource daemon failed (dbus errors/resource daemon errors)
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error during dbus message operations
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED Process not authorized to request app usage info
+ * @retval #RUNTIME_INFO_ERROR_NO_DATA No app running
+ *
+ * @code
+ * #include <runtime_info.h>
+ *
+ * void print_memory_usage(void)
+ * {
+ * int i;
+ * int count;
+ * app_usage_h mem_usage_handle;
+ * char *appid;
+ * unsigned int usage;
+ *
+ * runtime_info_get_all_apps_memory_usage(&mem_usage_handle);
+ * runtime_info_app_usage_get_count(mem_usage_handle, &count);
+ *
+ * for (i = 0; i < count; i++) {
+ * runtime_info_app_usage_get_appid(mem_usage_handle, i, &appid);
+ * runtime_info_app_usage_get_usage(mem_usage_handle, i, &usage);
+ * printf("appid = %s, usage = %u KB\n", appid, usage);
+ * free(appid);
+ * }
+ *
+ * runtime_info_app_usage_destroy(mem_usage_handle);
+ *
+ * }
+ * @endcode
+ */
+int runtime_info_get_all_apps_memory_usage(app_usage_h *usage);
+
+
+/**
+ * @brief Gets CPU rate of all apps.
+ * @since_tizen 4.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/systemmonitor
+ * @remarks You must release @a rate using runtime_info_app_usage_destroy().
+ *
+ * @param[out] rate An array of each app's CPU usage rate (%), the values are rounded down.
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #RUNTIME_INFO_ERROR_NONE Successful
+ * @retval #RUNTIME_INFO_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #RUNTIME_INFO_ERROR_OUT_OF_MEMORY Not able to allocate memory (for output param/other operations)
+ * @retval #RUNTIME_INFO_ERROR_REMOTE_IO Call to resource daemon failed (dbus errors/resource daemon errors)
+ * @retval #RUNTIME_INFO_ERROR_IO_ERROR An I/O error during dbus message operations
+ * @retval #RUNTIME_INFO_ERROR_PERMISSION_DENIED Process not authorized to request app usage info
+ * @retval #RUNTIME_INFO_ERROR_NO_DATA No app running
+ *
+ * @code
+ * #include <runtime_info.h>
+ *
+ * void print_cpu_usage(void)
+ * {
+ * int i;
+ * int count;
+ * app_usage_h cpu_rate_handle;
+ * char *appid;
+ * unsigned int rate;
+ *
+ * runtime_info_get_all_apps_cpu_rate(&cpu_rate_handle);
+ * runtime_info_app_usage_get_count(cpu_rate_handle, &count);
+ *
+ * for (i = 0; i < count; i++) {
+ * runtime_info_app_usage_get_appid(cpu_rate_handle, i, &appid);
+ * runtime_info_app_usage_get_usage(cpu_rate_handle, i, &rate);
+ * printf("appid = %s, rate = %u %%\n", appid, rate);
+ * free(appid);
+ * }
+ *
+ * runtime_info_app_usage_destroy(cpu_rate_handle);
+ *
+ * }
+ * @endcode
+ */
+int runtime_info_get_all_apps_cpu_rate(app_usage_h *rate);
+
+
+/**
+ * @}
+ */
+
#ifdef __cplusplus
}
#endif
-#endif /* __TIZEN_SYSTEM_RUNTIME_INFO_H__ */
+#endif /** __TIZEN_SYSTEM_RUNTIME_INFO_H__ */
projects / platform / core / api / runtime-info.git / blobdiff