1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
|
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libmm-glib -- Access modem status & information from glib applications
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* 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.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright (C) 2024 Guido Günther <agx@sigxcpu.org>
*/
#include "string.h"
#include "mm-helpers.h"
#include "mm-cbm.h"
#include "mm-modem.h"
/**
* SECTION: mm-cbm
* @title: MMCbm
* @short_description: The CBM interface
*
* The #MMCbm is an object providing access to the methods, signals and
* properties of the CBM interface.
*
* When the CBM is exposed and available in the bus, it is ensured that at
* least this interface is also available.
*/
G_DEFINE_TYPE (MMCbm, mm_cbm, MM_GDBUS_TYPE_CBM_PROXY)
/*****************************************************************************/
/**
* mm_cbm_get_path:
* @self: A #MMCbm.
*
* Gets the DBus path of the #MMCbm object.
*
* Returns: (transfer none): The DBus path of the #MMCbm object.
*
* Since: 1.24
*/
const gchar *
mm_cbm_get_path (MMCbm *self)
{
g_return_val_if_fail (MM_IS_CBM (self), NULL);
RETURN_NON_EMPTY_CONSTANT_STRING (
g_dbus_proxy_get_object_path (G_DBUS_PROXY (self)));
}
/**
* mm_cbm_dup_path:
* @self: A #MMCbm.
*
* Gets a copy of the DBus path of the #MMCbm object.
*
* Returns: (transfer full): The DBus path of the #MMCbm object. The returned
* value should be freed with g_free().
*
* Since: 1.24
*/
gchar *
mm_cbm_dup_path (MMCbm *self)
{
gchar *value;
g_return_val_if_fail (MM_IS_CBM (self), NULL);
g_object_get (G_OBJECT (self),
"g-object-path", &value,
NULL);
RETURN_NON_EMPTY_STRING (value);
}
/*****************************************************************************/
/**
* mm_cbm_get_text:
* @self: A #MMCbm.
*
* Gets the message text, in UTF-8.
*
* <warning>The returned value is only valid until the property changes so it is
* only safe to use this function on the thread where @self was constructed. Use
* mm_cbm_dup_text() if on another thread.</warning>
*
* Returns: (transfer none): The message text, or %NULL if it doesn't contain
* any (e.g. contains data instead).
*
* Since: 1.24
*/
const gchar *
mm_cbm_get_text (MMCbm *self)
{
g_return_val_if_fail (MM_IS_CBM (self), NULL);
RETURN_NON_EMPTY_CONSTANT_STRING (
mm_gdbus_cbm_get_text (MM_GDBUS_CBM (self)));
}
/**
* mm_cbm_dup_text:
* @self: A #MMCbm.
*
* Gets the message text, in UTF-8.
*
* Returns: (transfer full): The message text, or %NULL if it doesn't contain
* any (e.g. contains data instead). The returned value should be freed with
* g_free().
*
* Since: 1.24
*/
gchar *
mm_cbm_dup_text (MMCbm *self)
{
g_return_val_if_fail (MM_IS_CBM (self), NULL);
RETURN_NON_EMPTY_STRING (
mm_gdbus_cbm_dup_text (MM_GDBUS_CBM (self)));
}
/*****************************************************************************/
/**
* mm_cbm_get_state:
* @self: A #MMCbm.
*
* Gets the state of this CBM.
*
* Returns: A #MMCbmState specifying the state.
*
* Since: 1.24
*/
MMCbmState
mm_cbm_get_state (MMCbm *self)
{
g_return_val_if_fail (MM_IS_CBM (self), MM_CBM_STATE_UNKNOWN);
return (MMCbmState)mm_gdbus_cbm_get_state (MM_GDBUS_CBM (self));
}
/*****************************************************************************/
/**
* mm_cbm_get_channel:
* @self: A #MMCbm.
*
* Gets the channel of this CBM.
*
* Returns: The channel
*
* Since: 1.24
*/
guint
mm_cbm_get_channel (MMCbm *self)
{
g_return_val_if_fail (MM_IS_CBM (self), 0);
return mm_gdbus_cbm_get_channel (MM_GDBUS_CBM (self));
}
/*****************************************************************************/
/**
* mm_cbm_get_message_code:
* @self: A #MMCbm.
*
* Gets the message code of this CBM.
*
* Returns: The message code
*
* Since: 1.24
*/
guint
mm_cbm_get_message_code (MMCbm *self)
{
g_return_val_if_fail (MM_IS_CBM (self), 0);
return mm_gdbus_cbm_get_message_code (MM_GDBUS_CBM (self));
}
/*****************************************************************************/
/**
* mm_cbm_get_update:
* @self: A #MMCbm.
*
* Gets the update number of this CBM.
*
* Returns: The update number
*
* Since: 1.24
*/
guint
mm_cbm_get_update (MMCbm *self)
{
g_return_val_if_fail (MM_IS_CBM (self), 0);
return mm_gdbus_cbm_get_update (MM_GDBUS_CBM (self));
}
/*****************************************************************************/
static void
mm_cbm_init (MMCbm *self)
{
}
static void
mm_cbm_class_init (MMCbmClass *cbm_class)
{
}
|