keepalive-object.h

Go to the documentation of this file.

/****************************************************************************************
**
** Copyright (c) 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_OBJECT_H_
#define KEEPALIVE_OBJECT_H_
 
# include <stdarg.h>
# include <stdbool.h>
 
# include <glib.h>
 
# include <dbus/dbus.h>
 
# ifdef __cplusplus
extern "C" {
# endif
 
/* ========================================================================= *
 * Types
 * ========================================================================= */
 
typedef struct keepalive_object_t keepalive_object_t;
 
struct keepalive_object_t
{
    const char                     *kao_identity;
 
    unsigned                        kao_refcount_external;
 
    unsigned                        kao_refcount_internal;
 
    bool                            kao_in_shutdown;
 
    guint                           kao_shutdown_id;
 
    pthread_mutex_t                 kao_mutex;
 
    GDestroyNotify                  kao_shutdown_locked_cb;
 
    GDestroyNotify                  kao_delete_cb;
};
 
/* ========================================================================= *
 * Functions
 * ========================================================================= */
 
void keepalive_object_ctor (keepalive_object_t *self, const char *identity, GDestroyNotify shutdown_locked_cb, GDestroyNotify delete_cb);
 
void keepalive_object_dtor (keepalive_object_t *self);
 
void keepalive_object_lock (keepalive_object_t *self);
 
void keepalive_object_unlock (keepalive_object_t *self);
 
void *keepalive_object_ref_external_locked (keepalive_object_t *self);
 
void *keepalive_object_ref_internal_locked (keepalive_object_t *self);
 
void keepalive_object_unref_external_locked(keepalive_object_t *self);
 
void keepalive_object_unref_internal_locked(keepalive_object_t *self);
 
void keepalive_object_unref_internal_cb (void *aptr);
 
void keepalive_object_timer_start_locked (keepalive_object_t *self, guint *timer_id, guint interval, GSourceFunc notify_cb);
 
void keepalive_object_timer_stop_locked(keepalive_object_t *self, guint *timer_id);
 
bool keepalive_object_in_shutdown_locked(keepalive_object_t *self);
 
void keepalive_object_ipc_start_locked_va (keepalive_object_t *self, DBusPendingCall **where, DBusPendingCallNotifyFunction notify_cb, DBusConnection *connection, const char *service, const char *object, const char *interface, const char *method, int arg_type, va_list va);
 
void keepalive_object_ipc_cancel_locked(keepalive_object_t *self, DBusPendingCall **where);
 
bool keepalive_object_ipc_finish_locked(keepalive_object_t *self, DBusPendingCall **where, DBusPendingCall *what);
 
void keepalive_object_iowatch_start_locked(keepalive_object_t *self, guint *iowatch_id, int fd, GIOCondition cnd, GIOFunc io_cb);
 
void keepalive_object_iowatch_stop_locked (keepalive_object_t *self, guint *iowatch_id);
 
# ifdef __cplusplus
};
# endif
 
#endif /* KEEPALIVE_OBJECT_H_ */