The Network Monitoring API provides functions for getting connections.

Required Header

#include <inm.h>

Overview

This set of functions is used to get network state, get connection handles. To use This kind of APIs, You should create a inm handle using inm_initialize(). You should destroy the created inm handle if you do not need it anymore.

Related Features

This API is related with the following features:

http://tizen.org/feature/network.ethernet
http://tizen.org/feature/network.wifi
http://tizen.org/feature/network.telephony
http://tizen.org/feature/network.tethering.bluetooth
http://tizen.org/feature/network.inm
It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature Element.

Functions
int	inm_set_cellular_state_changed_cb (inm_h inm, inm_cellular_state_changed_cb callback, void *user_data)
	Sets a callback called when the cellular state is changed.
int	inm_unset_cellular_state_changed_cb (inm_h inm)
	Unsets the callback called when the cellular state is changed.
int	inm_get_cellular_state (inm_h inm, inm_cellular_state_e *state)
	Gets the state of the cellular connection.
int	inm_set_wifi_state_changed_cb (inm_h inm, inm_wifi_state_changed_cb callback, void *user_data)
	Sets a callback called when the Wi-Fi state is changed.
int	inm_unset_wifi_state_changed_cb (inm_h inm)
	Unsets the callback called when the Wi-Fi state is changed.
int	inm_get_wifi_state (inm_h inm, inm_wifi_state_e *state)
	Gets the state of the Wi-Fi.
int	inm_set_ethernet_state_changed_cb (inm_h inm, inm_ethernet_state_changed_cb callback, void *user_data)
	Sets a callback called when the ethernet state is changed.
int	inm_unset_ethernet_state_changed_cb (inm_h inm)
	Unsets the callback called when the ethernet state is changed.
int	inm_get_ethernet_state (inm_h inm, inm_ethernet_state_e *state)
	Gets the state of the ethernet.
int	inm_get_current_connection (inm_h inm, inm_connection_h *connection)
	Gets the handle of the default connection.
int	inm_connection_destroy (inm_connection_h *connection)
	Destroys a connection handle.
int	inm_connection_clone (inm_connection_h *cloned, inm_connection_h origin)
	Clones a connection handle.
int	inm_get_connection_iterator (inm_h inm, inm_connection_iterator_h *connection_iterator)
	Gets a connections iterator.
int	inm_connection_iterator_next (inm_connection_iterator_h connection_iterator, inm_connection_h *connection)
	Moves the connection iterator to the next position and gets a connection handle.
int	inm_destroy_connection_iterator (inm_connection_iterator_h connection_iterator)
	Destroys a connections iterator.
Typedefs
typedef void(*	inm_cellular_state_changed_cb )(inm_cellular_state_e state, void *user_data)
	Called when the cellular state is changed.
typedef void(*	inm_wifi_state_changed_cb )(inm_wifi_state_e state, void *user_data)
	Called when the Wi-Fi state is changed.
typedef void(*	inm_ethernet_state_changed_cb )(inm_ethernet_state_e state, void *user_data)
	Called when the ethernet state is changed.

Typedef Documentation

typedef void(* inm_cellular_state_changed_cb)(inm_cellular_state_e state, void *user_data)

Called when the cellular state is changed.

Since :: 5.0

Parameters:

[in]	state	The cellular state
[in]	user_data	The user data passed from the callback registration function

See also:: inm_set_cellular_state_changed_cb(); inm_unset_cellular_state_changed_cb()

typedef void(* inm_ethernet_state_changed_cb)(inm_ethernet_state_e state, void *user_data)

Called when the ethernet state is changed.

Since :: 5.0

Parameters:

[in]	state	The ethernet state
[in]	user_data	The user data passed from the callback registration function

See also:: inm_set_ethernet_state_changed_cb(); inm_unset_ethernet_state_changed_cb()

typedef void(* inm_wifi_state_changed_cb)(inm_wifi_state_e state, void *user_data)

Called when the Wi-Fi state is changed.

Since :: 5.0

Parameters:

[in]	state	The Wi-Fi state
[in]	user_data	The user data passed from the callback registration function

See also:: inm_set_wifi_state_changed_cb(); inm_unset_wifi_state_changed_cb()

Enumeration Type Documentation

enum inm_cellular_state_e

Enumeration for cellular network state.

Since :: 5.0

Enumerator:

INM_CELLULAR_STATE_DEACTIVATED	Cellular is deactivated
INM_CELLULAR_STATE_DISCONNECTED	Disconnected
INM_CELLULAR_STATE_CONNECTED	Connected

enum inm_ethernet_state_e

Enumeration for ethernet state.

Since :: 5.0

Enumerator:

INM_ETHERNET_STATE_DEACTIVATED	There is no Ethernet profile to open
INM_ETHERNET_STATE_DISCONNECTED	Disconnected
INM_ETHERNET_STATE_CONNECTED	Connected

enum inm_wifi_state_e

Enumeration for Wi-Fi state.

Since :: 5.0

Enumerator:

INM_WIFI_STATE_DEACTIVATED	Wi-Fi is deactivated
INM_WIFI_STATE_DISCONNECTED	Disconnected
INM_WIFI_STATE_CONNECTED	Connected

Function Documentation

int inm_connection_clone	(	inm_connection_h *	cloned,
		inm_connection_h	origin
	)

Clones a connection handle.

Since :: 5.0

Remarks:: You must release cloned connection using inm_connection_destroy().

Parameters:

[out]	cloned	The handle of the cloned connection
[in]	origin	The handle of the origin connection

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_OUT_OF_MEMORY	Out of memory
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

See also:: inm_connection_destroy()

int inm_connection_destroy ( inm_connection_h * connection )

Destroys a connection handle.

Since :: 5.0

Parameters:

[out] connection The connection handle

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

See also:: inm_get_current_connection()

int inm_connection_iterator_next	(	inm_connection_iterator_h	connection_iterator,
		inm_connection_h *	connection
	)

Moves the connection iterator to the next position and gets a connection handle.

Since :: 5.0

Remarks:: After the iterator is created, its inner cursor is placed before the first element. The first call to inm_connection_iterator_next() gets the first element. You must release connection using inm_connection_destroy().

Parameters:

[in]	connection_iterator	The connection iterator
[out]	connection	The connection handle

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

int inm_destroy_connection_iterator ( inm_connection_iterator_h connection_iterator )

Destroys a connections iterator.

Since :: 5.0

Parameters:

[in] connection_iterator The connection iterator

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized

int inm_get_cellular_state	(	inm_h	inm,
		inm_cellular_state_e *	state
	)

Gets the state of the cellular connection.

The returned state is for the cellular connection state.

Since :: 5.0

Parameters:

[in]	inm	The inm handle
[out]	state	The state of the cellular connection

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

int inm_get_connection_iterator	(	inm_h	inm,
		inm_connection_iterator_h *	connection_iterator
	)

Gets a connections iterator.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.get

Remarks:: You must release connection_iterator using inm_destroy_connection_iterator().

Parameters:

[in]	inm	The inm handle
[out]	connection_iterator	The iterator of connection

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_OUT_OF_MEMORY	Out of memory
INM_ERROR_PERMISSION_DENIED	Permission Denied
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

int inm_get_current_connection	(	inm_h	inm,
		inm_connection_h *	connection
	)

Gets the handle of the default connection.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.get

Remarks:: You must release connection using connection_connection_destroy().

Parameters:

[in]	inm	The inm handle
[out]	connection	The connection handle

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_OUT_OF_MEMORY	Out of memory
INM_ERROR_PERMISSION_DENIED	Permission Denied
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

int inm_get_ethernet_state	(	inm_h	inm,
		inm_ethernet_state_e *	state
	)

Gets the state of the ethernet.

The returned state is for the ethernet connection state.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.get

Parameters:

[in]	inm	The inm handle
[out]	state	The state of ethernet connection

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_PERMISSION_DENIED	Permission Denied
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

int inm_get_wifi_state	(	inm_h	inm,
		inm_wifi_state_e *	state
	)

Gets the state of the Wi-Fi.

The returned state is for the Wi-Fi connection state.

Since :: 5.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/network.get

Parameters:

[in]	inm	The inm handle
[out]	state	The state of Wi-Fi connection

Returns:: 0 on success, otherwise a negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_PERMISSION_DENIED	Permission Denied
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

int inm_set_cellular_state_changed_cb	(	inm_h	inm,
		inm_cellular_state_changed_cb	callback,
		void *	user_data
	)

Sets a callback called when the cellular state is changed.

Since :: 5.0

Parameters:

[in]	inm	The monitor handle
[in]	callback	The callback function to be called
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

See also:: inm_cellular_state_changed_cb(); inm_unset_cellular_state_changed_cb()

int inm_set_ethernet_state_changed_cb	(	inm_h	inm,
		inm_ethernet_state_changed_cb	callback,
		void *	user_data
	)

Sets a callback called when the ethernet state is changed.

Since :: 5.0

Parameters:

[in]	inm	The monitor handle
[in]	callback	The callback function to be called
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

See also:: inm_ethernet_state_changed_cb(); inm_unset_ethernet_state_changed_cb()

int inm_set_wifi_state_changed_cb	(	inm_h	inm,
		inm_wifi_state_changed_cb	callback,
		void *	user_data
	)

Sets a callback called when the Wi-Fi state is changed.

Since :: 5.0

Parameters:

[in]	inm	The monitor handle
[in]	callback	The callback function to be called
[in]	user_data	The user data passed to the callback function

Returns:: 0 on success, otherwise negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

See also:: inm_wifi_state_changed_cb(); inm_unset_wifi_state_changed_cb()

int inm_unset_cellular_state_changed_cb ( inm_h inm )

Unsets the callback called when the cellular state is changed.

Since :: 5.0

Parameters:

[in] inm The monitor handle

Returns:: 0 on success, otherwise negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

See also:: inm_cellular_state_changed_cb(); inm_set_cellular_state_changed_cb()

int inm_unset_ethernet_state_changed_cb ( inm_h inm )

Unsets the callback called when the ethernet state is changed.

Since :: 5.0

Parameters:

[in] inm The monitor handle

Returns:: 0 on success, otherwise negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

See also:: inm_ethernet_state_changed_cb(); inm_set_ethernet_state_changed_cb()

int inm_unset_wifi_state_changed_cb ( inm_h inm )

Unsets the callback called when the Wi-Fi state is changed.

Since :: 5.0

Parameters:

[in] inm The monitor handle

Returns:: 0 on success, otherwise negative error value

Return values:

INM_ERROR_NONE	Successful
INM_ERROR_INVALID_PARAMETER	Invalid parameter
INM_ERROR_NOT_SUPPORTED	Not supported
INM_ERROR_NOT_INITIALIZED	Not initialized
INM_ERROR_OPERATION_FAILED	Operation failed

See also:: inm_wifi_state_changed_cb(); inm_set_wifi_state_changed_cb()

Required Header

Overview

Related Features

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation