keepalive-backgroundactivity.h

Go to the documentation of this file.

/****************************************************************************************
**
** Copyright (c) 2014 - 2020 Jolla Ltd.
 * Copyright (c) 2020 Open Mobile Platform LLC.
**
** 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_BACKGROUNDACTIVITY_H_
# define KEEPALIVE_GLIB_BACKGROUNDACTIVITY_H_
 
# include <stdbool.h>
 
# ifdef __cplusplus
extern "C" {
# elif 0
} /* fool JED indentation ... */
# endif
 
# pragma GCC visibility push(default)
 
typedef struct background_activity_t background_activity_t;
 
typedef void (*background_activity_event_fn)(background_activity_t *activity, void *user_data);
 
typedef void (*background_activity_free_fn)(void *);
 
typedef enum
{                                                                    // ORIGIN:
    BACKGROUND_ACTIVITY_FREQUENCY_RANGE                =            0, // Nemomobile
    BACKGROUND_ACTIVITY_FREQUENCY_THIRTY_SECONDS       =           30, // Meego
    BACKGROUND_ACTIVITY_FREQUENCY_TWO_AND_HALF_MINUTES =  30 + 2 * 60, // Meego
    BACKGROUND_ACTIVITY_FREQUENCY_FIVE_MINUTES         =       5 * 60, // Meego
    BACKGROUND_ACTIVITY_FREQUENCY_TEN_MINUTES          =      10 * 60, // Meego
    BACKGROUND_ACTIVITY_FREQUENCY_FIFTEEN_MINUTES      =      15 * 60, // Android
    BACKGROUND_ACTIVITY_FREQUENCY_THIRTY_MINUTES       =      30 * 60, // Meego & Android
    BACKGROUND_ACTIVITY_FREQUENCY_ONE_HOUR             =  1 * 60 * 60, // Meego & Android
    BACKGROUND_ACTIVITY_FREQUENCY_TWO_HOURS            =  2 * 60 * 60, // Meego
    BACKGROUND_ACTIVITY_FREQUENCY_FOUR_HOURS           =  4 * 60 * 60, // Nemomobile
    BACKGROUND_ACTIVITY_FREQUENCY_EIGHT_HOURS          =  8 * 60 * 60, // Nemomobile
    BACKGROUND_ACTIVITY_FREQUENCY_TEN_HOURS            = 10 * 60 * 60, // Meego
    BACKGROUND_ACTIVITY_FREQUENCY_TWELVE_HOURS         = 12 * 60 * 60, // Android
    BACKGROUND_ACTIVITY_FREQUENCY_TWENTY_FOUR_HOURS    = 24 * 60 * 60, // Android
    BACKGROUND_ACTIVITY_FREQUENCY_MAXIMUM_FREQUENCY    =   0x7fffffff, // due to 32-bit libiphb ranges
 
} background_activity_frequency_t;
 
background_activity_t *background_activity_new(void);
 
background_activity_t *background_activity_ref(background_activity_t *self);
 
void background_activity_unref(background_activity_t *self);
 
void background_activity_set_wakeup_slot(background_activity_t *self,
                                         background_activity_frequency_t slot);
 
background_activity_frequency_t background_activity_get_wakeup_slot(background_activity_t *self);
 
void background_activity_set_wakeup_range(background_activity_t *self, int range_lo, int range_hi);
 
void background_activity_get_wakeup_range(background_activity_t *self,
                                          int *range_lo, int *range_hi);
 
bool background_activity_is_stopped(background_activity_t *self);
 
bool background_activity_is_waiting(background_activity_t *self);
 
bool background_activity_is_running(background_activity_t *self);
 
void background_activity_wait(background_activity_t *self);
 
void background_activity_run(background_activity_t *self);
 
void background_activity_stop(background_activity_t *self);
 
const char *background_activity_get_id(const background_activity_t *self);
 
void background_activity_set_user_data(background_activity_t *self,
                                       void *user_data,
                                       background_activity_free_fn free_cb);
 
void *background_activity_get_user_data(background_activity_t *self);
 
void background_activity_free_user_data(background_activity_t *self);
 
void *background_activity_steal_user_data(background_activity_t *self);
 
void background_activity_set_running_callback(background_activity_t *self,
                                              background_activity_event_fn cb);
 
void background_activity_set_waiting_callback(background_activity_t *self,
                                              background_activity_event_fn cb);
 
void background_activity_set_stopped_callback(background_activity_t *self,
                                              background_activity_event_fn cb);
# pragma GCC visibility pop
 
# ifdef __cplusplus
};
# endif
 
#endif // KEEPALIVE_GLIB_BACKGROUNDACTIVITY_H_