LOOP module definition. More...

#include "artik_error.h"
#include "artik_types.h"

Typedefs
typedef void(*	timeout_callback) (void *user_data)
	This callback function gets triggered after timeout. More...

typedef int(*	periodic_callback) (void *user_data)
	This callback function gets triggered after periodic. More...

typedef int(*	idle_callback) (void *user_data)
	This callback function gets triggered after idle. More...

typedef int(*	watch_callback) (int fd, enum watch_io io, void *user_data)
	Watch callback prototype. More...

typedef int(*	signal_callback) (void *user_data)

Enumerations
enum	watch_io { WATCH_IO_IN = (1 << 0), WATCH_IO_OUT = (1 << 1), WATCH_IO_PRI = (1 << 2), WATCH_IO_ERR = (1 << 3), WATCH_IO_HUP = (1 << 4), WATCH_IO_NVAL = (1 << 5) }

Detailed Description

Definitions and functions for using the loop module and working with the SDK's main loop and asynchronous mechanisms.

Definition in file artik_loop.h.

Typedef Documentation

typedef int(* idle_callback) (void *user_data)

Parameters

[in] user_data The user data passed from the register callback function

Definition at line 68 of file artik_loop.h.

typedef int(* periodic_callback) (void *user_data)

Parameters

[in] user_data The user data passed from the register callback function

Returns: continue calling the periodic. 1 re-new periodic, 0 cancel periodic.

Definition at line 61 of file artik_loop.h.

typedef void(* timeout_callback) (void *user_data)

Parameters

[in] user_data The user data passed from the register callback function

Definition at line 54 of file artik_loop.h.

typedef int(* watch_callback) (int fd, enum watch_io io, void *user_data)

Parameters

[in]	fd	file descriptor
[in]	io	i/o event condition
[in]	user_data	The user data passed from the callback function

Returns: continue using the watch callback. 1 continue use, 0 remove the watch callback.

Definition at line 78 of file artik_loop.h.

Enumerator
WATCH_IO_IN	data input available
WATCH_IO_OUT	data can be written
WATCH_IO_PRI	high priority input available
WATCH_IO_ERR	i/o error
WATCH_IO_HUP	Hung up. device disconnected
WATCH_IO_NVAL	invalid request. the file descriptor is not open

Definition at line 40 of file artik_loop.h.