RTimeout

RTimeout

Synopsis




#define             R_TIMEOUT_TYPE
#define             R_TIMEOUT                           (obj)
#define             R_TIMEOUT_CLASS                     (klass)
#define             IS_R_TIMEOUT                        (obj)
#define             IS_R_TIMEOUT_CLASS                  (klass)
#define             R_TIMEOUT_GET_CLASS                 (obj)
                    RTimeoutPrivate;
                    RTimeout;
GType               r_timeout_get_type                  (void);
RTimeout*           r_timeout_new                       (guint32 time);
void                r_timeout_free                      (RTimeout *timeout);
void                r_timeout_start                     (RTimeout *timeout);
void                r_timeout_enable                    (RTimeout *timeout);
void                r_timeout_disable                   (RTimeout *timeout);
void                r_timeout_restart                   (RTimeout *timeout,
                                                         guint32 time);
gboolean            r_timeout_is_running                (RTimeout *timeout);

Object Hierarchy


  GObject
   +----RTimeout

Signals


  "timeout"                                        : Run Last

Description

Details

R_TIMEOUT_TYPE

#define R_TIMEOUT_TYPE            (r_timeout_get_type())


R_TIMEOUT()

#define             R_TIMEOUT(obj)

obj :

R_TIMEOUT_CLASS()

#define             R_TIMEOUT_CLASS(klass)

klass :

IS_R_TIMEOUT()

#define             IS_R_TIMEOUT(obj)

obj :

IS_R_TIMEOUT_CLASS()

#define             IS_R_TIMEOUT_CLASS(klass)

klass :

R_TIMEOUT_GET_CLASS()

#define             R_TIMEOUT_GET_CLASS(obj)

obj :

RTimeoutPrivate

typedef struct _RTimeoutPrivate RTimeoutPrivate;


RTimeout

typedef struct _RTimeout RTimeout;


r_timeout_get_type ()

GType               r_timeout_get_type                  (void);

Returns :

r_timeout_new ()

RTimeout*           r_timeout_new                       (guint32 time);

Create a new timer. Timer will wait "time" seconds, when a "timeout" signal is emitted. If time is 0, then timer will wait 15 minutes, before emit signal.

time : time
Returns : a RTimeout*

r_timeout_free ()

void                r_timeout_free                      (RTimeout *timeout);

free the RTimeout object

timeout : a RTimeout

r_timeout_start ()

void                r_timeout_start                     (RTimeout *timeout);

start the timeout object

timeout : RTimeout

r_timeout_enable ()

void                r_timeout_enable                    (RTimeout *timeout);

enable the timeout

timeout : a RTimeout

r_timeout_disable ()

void                r_timeout_disable                   (RTimeout *timeout);

disable the timeout

timeout : a RTimeout

r_timeout_restart ()

void                r_timeout_restart                   (RTimeout *timeout,
                                                         guint32 time);

restart the timeout, but waiting "time" seconds

timeout : a RTimeout
time : anew time

r_timeout_is_running ()

gboolean            r_timeout_is_running                (RTimeout *timeout);

check if timer is running or is disabled

timeout : a RTimeout
Returns : a gboolean, TRUE if timeout is running, FALSE otherwise.

Signal Details

The "timeout" signal

void                user_function                      (RTimeout *timeout,
                                                        gpointer  user_data)      : Run Last

the "timeout" signal

timeout : a RTimeout
user_data : user data set when the signal handler was connected.