src/mm-iface-modem-time.h

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details:
 *
 * Copyright (C) 2012 Google, Inc.
 */

#ifndef MM_IFACE_MODEM_TIME_H
#define MM_IFACE_MODEM_TIME_H

#include <glib-object.h>
#include <gio/gio.h>

#define _LIBMM_INSIDE_MM
#include <libmm-glib.h>

#include "mm-iface-modem.h"

#define MM_TYPE_IFACE_MODEM_TIME mm_iface_modem_time_get_type ()
G_DECLARE_INTERFACE (MMIfaceModemTime, mm_iface_modem_time, MM, IFACE_MODEM_TIME, MMIfaceModem)

#define MM_IFACE_MODEM_TIME_DBUS_SKELETON "iface-modem-time-dbus-skeleton"

struct _MMIfaceModemTimeInterface {
    GTypeInterface g_iface;

    /* Check for Time support (async) */
    void (* check_support) (MMIfaceModemTime *self,
                            GAsyncReadyCallback callback,
                            gpointer user_data);
    gboolean (* check_support_finish) (MMIfaceModemTime *self,
                                       GAsyncResult *res,
                                       GError **error);

    /* Get current network time */
    void (* load_network_time) (MMIfaceModemTime *self,
                                GAsyncReadyCallback callback,
                                gpointer user_data);
    gchar * (* load_network_time_finish) (MMIfaceModemTime *self,
                                          GAsyncResult *res,
                                          GError **error);

    /* Loading of the network timezone property. This method may return
     * MM_CORE_ERROR_RETRY if the timezone cannot yet be loaded, so that
     * the interface retries later. */
    void (* load_network_timezone) (MMIfaceModemTime *self,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);
    MMNetworkTimezone * (* load_network_timezone_finish) (MMIfaceModemTime *self,
                                                          GAsyncResult *res,
                                                          GError **error);

    /* Asynchronous setting up unsolicited events */
    void (*setup_unsolicited_events) (MMIfaceModemTime *self,
                                      GAsyncReadyCallback callback,
                                      gpointer user_data);
    gboolean (*setup_unsolicited_events_finish) (MMIfaceModemTime *self,
                                                 GAsyncResult *res,
                                                 GError **error);

    /* Asynchronous cleaning up of unsolicited events */
    void (*cleanup_unsolicited_events) (MMIfaceModemTime *self,
                                        GAsyncReadyCallback callback,
                                        gpointer user_data);
    gboolean (*cleanup_unsolicited_events_finish) (MMIfaceModemTime *self,
                                                   GAsyncResult *res,
                                                   GError **error);

    /* Asynchronous enabling unsolicited events */
    void (* enable_unsolicited_events) (MMIfaceModemTime *self,
                                        GAsyncReadyCallback callback,
                                        gpointer user_data);
    gboolean (* enable_unsolicited_events_finish) (MMIfaceModemTime *self,
                                                   GAsyncResult *res,
                                                   GError **error);

    /* Asynchronous disabling unsolicited events */
    void (* disable_unsolicited_events) (MMIfaceModemTime *self,
                                         GAsyncReadyCallback callback,
                                         gpointer user_data);
    gboolean (* disable_unsolicited_events_finish) (MMIfaceModemTime *self,
                                                    GAsyncResult *res,
                                                    GError **error);
};

/* Initialize Time interface (async) */
void     mm_iface_modem_time_initialize        (MMIfaceModemTime *self,
                                                GCancellable *cancellable,
                                                GAsyncReadyCallback callback,
                                                gpointer user_data);
gboolean mm_iface_modem_time_initialize_finish (MMIfaceModemTime *self,
                                                GAsyncResult *res,
                                                GError **error);

/* Enable Time interface (async) */
void     mm_iface_modem_time_enable        (MMIfaceModemTime *self,
                                            GCancellable *cancellable,
                                            GAsyncReadyCallback callback,
                                            gpointer user_data);
gboolean mm_iface_modem_time_enable_finish (MMIfaceModemTime *self,
                                            GAsyncResult *res,
                                            GError **error);

/* Disable Time interface (async) */
void     mm_iface_modem_time_disable        (MMIfaceModemTime *self,
                                             GAsyncReadyCallback callback,
                                             gpointer user_data);
gboolean mm_iface_modem_time_disable_finish (MMIfaceModemTime *self,
                                             GAsyncResult *res,
                                             GError **error);

/* Shutdown Time interface */
void mm_iface_modem_time_shutdown (MMIfaceModemTime *self);

#if defined WITH_SUSPEND_RESUME

/* Sync Time interface (async) */
void     mm_iface_modem_time_sync        (MMIfaceModemTime *self,
                                          GAsyncReadyCallback callback,
                                          gpointer user_data);
gboolean mm_iface_modem_time_sync_finish (MMIfaceModemTime *self,
                                          GAsyncResult *res,
                                          GError **error);

#endif

/* Bind properties for simple GetStatus() */
void mm_iface_modem_time_bind_simple_status (MMIfaceModemTime *self,
                                             MMSimpleStatus *status);

/* Implementations of the unsolicited events handling should call this method
 * to notify about the updated time */
void mm_iface_modem_time_update_network_time     (MMIfaceModemTime  *self,
                                                  const gchar       *network_time);
void mm_iface_modem_time_update_network_timezone (MMIfaceModemTime  *self,
                                                  MMNetworkTimezone *tz);

#endif /* MM_IFACE_MODEM_TIME_H */