keepalive-heartbeat.h

Go to the documentation of this file.

/****************************************************************************************
**
** Copyright (C) 2014 - 2018 Jolla Ltd.
**
** Author: Simo Piiroinen <simo.piiroinen@jollamobile.com>
**
** All rights reserved.
**
** This file is part of nemo-keepalive package.
**
** You may use this file under the terms of the GNU Lesser General
** Public License version 2.1 as published by the Free Software Foundation
** and appearing in the file license.lgpl included in the packaging
** of this file.
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation
** and appearing in the file license.lgpl included in the packaging
** of this file.
**
** This library is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
** Lesser General Public License for more details.
**
****************************************************************************************/
 
#ifndef KEEPALIVE_GLIB_HEARTBEAT_H_
# define KEEPALIVE_GLIB_HEARTBEAT_H_
 
# include <stdbool.h>
 
# ifdef __cplusplus
extern "C" {
# elif 0
} /* fool JED indentation ... */
# endif
 
# pragma GCC visibility push(default)
 
typedef struct heartbeat_t heartbeat_t;
 
typedef void (*heartbeat_wakeup_fn)(void *aptr);
 
typedef void (*heartbeat_free_fn)(void *aptr);
 
heartbeat_t *heartbeat_new(void);
 
heartbeat_t *heartbeat_ref(heartbeat_t *self);
 
void heartbeat_unref(heartbeat_t *self);
 
void heartbeat_set_delay(heartbeat_t *self,
                         int delay_lo,
                         int delay_hi);
 
void heartbeat_set_notify(heartbeat_t *self,
                          heartbeat_wakeup_fn notify_cb,
                          void *user_data,
                          heartbeat_free_fn user_free_cb);
 
void         heartbeat_start(heartbeat_t *self);
 
void         heartbeat_stop(heartbeat_t *self);
 
# pragma GCC visibility pop
 
# ifdef __cplusplus
};
# endif
 
#endif /* KEEPALIVE_GLIB_HEARTBEAT_H_ */