conicconnectionevent.h File Reference

---

Detailed Description

ConIcConnectionEvent class.

ConIcConnectionEvent is sent whenever status of a connection changes. It's derived from ConIcEvent class.

#include <glib.h>
#include <glib-object.h>

Typedefs
typedef struct _ConIcConnectionEvent	ConIcConnectionEvent
	ConIcConnectionEvent object.
Enumerations
enum	ConIcConnectionStatus { CON_IC_STATUS_CONNECTED, CON_IC_STATUS_DISCONNECTED, CON_IC_STATUS_DISCONNECTING, CON_IC_STATUS_NETWORK_UP }
	IAP connection statuses. More...
enum	ConIcConnectionError { CON_IC_CONNECTION_ERROR_NONE, CON_IC_CONNECTION_ERROR_INVALID_IAP, CON_IC_CONNECTION_ERROR_CONNECTION_FAILED, CON_IC_CONNECTION_ERROR_USER_CANCELED }
	Error codes for connection events. More...
Functions
ConIcConnectionStatus	con_ic_connection_event_get_status (ConIcConnectionEvent *event)
	Get status from the event.
ConIcConnectionError	con_ic_connection_event_get_error (ConIcConnectionEvent *event)
	Get error from the event.

---

Typedef Documentation

typedef struct _ConIcConnectionEvent ConIcConnectionEvent

ConIcConnectionEvent object.

The contents of the object is private, to access the object use the functions provided by conicconnectionevent.h.

---

Enumeration Type Documentation

enum ConIcConnectionError

Error codes for connection events.

Only set in DISCONNECTED events, otherwise set to CON_IC_CONNECTION_ERROR_NONE.

Note:

More error types might be added in the future.

Enumerator:

CON_IC_CONNECTION_ERROR_NONE	No errors.
CON_IC_CONNECTION_ERROR_INVALID_IAP	Requested IAP was invalid (for example not found or incomplete settings).
CON_IC_CONNECTION_ERROR_CONNECTION_FAILED	Connections establishment failed for unknown reason.
CON_IC_CONNECTION_ERROR_USER_CANCELED	Connections establishment failed because of user cancellation.

enum ConIcConnectionStatus

IAP connection statuses.

Note:

More status types might be added in the future.

Enumerator:

CON_IC_STATUS_CONNECTED	The IAP was connected.
CON_IC_STATUS_DISCONNECTED	The IAP was disconnected.
CON_IC_STATUS_DISCONNECTING	The IAP is disconnecting.
CON_IC_STATUS_NETWORK_UP	The IAP has a network address, but is not yet fully connected.

---

Function Documentation

ConIcConnectionError con_ic_connection_event_get_error

(

ConIcConnectionEvent *

event

)

Get error from the event.

Parameters:

event

OssIcConnectionEvent object

Returns:

error

ConIcConnectionStatus con_ic_connection_event_get_status

(

ConIcConnectionEvent *

event

)

Get status from the event.

Parameters:

event

OssIcConnectionEvent object

Returns:

status