MmGdbusModemSignal

MmGdbusModemSignal — Generated C code for the org.freedesktop.ModemManager1.Modem.Signal D-Bus interface

Synopsis

                    MmGdbusModemSignal;
struct              MmGdbusModemSignalIface;

guint               mm_gdbus_modem_signal_get_rate      (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_get_cdma      (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_get_evdo      (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_get_gsm       (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_get_umts      (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_get_lte       (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_dup_cdma      (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_dup_evdo      (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_dup_gsm       (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_dup_umts      (MmGdbusModemSignal *object);
GVariant *          mm_gdbus_modem_signal_dup_lte       (MmGdbusModemSignal *object);

void                mm_gdbus_modem_signal_call_setup    (MmGdbusModemSignal *proxy,
                                                         guint arg_rate,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            mm_gdbus_modem_signal_call_setup_finish
                                                        (MmGdbusModemSignal *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
gboolean            mm_gdbus_modem_signal_call_setup_sync
                                                        (MmGdbusModemSignal *proxy,
                                                         guint arg_rate,
                                                         GCancellable *cancellable,
                                                         GError **error);

Object Hierarchy

  GInterface
   +----MmGdbusModemSignal

Prerequisites

MmGdbusModemSignal requires GObject.

Known Implementations

MmGdbusModemSignal is implemented by MMModemSignal, MmGdbusModemSignalProxy and MmGdbusModemSignalSkeleton.

Properties

  "cdma"                     GVariant*             : Read / Write
  "evdo"                     GVariant*             : Read / Write
  "gsm"                      GVariant*             : Read / Write
  "lte"                      GVariant*             : Read / Write
  "rate"                     guint                 : Read / Write
  "umts"                     GVariant*             : Read / Write

Signals

  "handle-setup"                                   : Run Last

Description

This section contains code for working with the org.freedesktop.ModemManager1.Modem.Signal D-Bus interface in C.

Details

MmGdbusModemSignal

typedef struct _MmGdbusModemSignal MmGdbusModemSignal;

Abstract interface type for the D-Bus interface org.freedesktop.ModemManager1.Modem.Signal.


struct MmGdbusModemSignalIface

struct MmGdbusModemSignalIface {
  GTypeInterface parent_iface;


  gboolean (*handle_setup) (
    MmGdbusModemSignal *object,
    GDBusMethodInvocation *invocation,
    guint arg_rate);

  GVariant * (*get_cdma) (MmGdbusModemSignal *object);

  GVariant * (*get_evdo) (MmGdbusModemSignal *object);

  GVariant * (*get_gsm) (MmGdbusModemSignal *object);

  GVariant * (*get_lte) (MmGdbusModemSignal *object);

  guint  (*get_rate) (MmGdbusModemSignal *object);

  GVariant * (*get_umts) (MmGdbusModemSignal *object);
};

Virtual table for the D-Bus interface org.freedesktop.ModemManager1.Modem.Signal.

GTypeInterface parent_iface;

The parent interface.

handle_setup ()

Handler for the "handle-setup" signal.

get_cdma ()

Getter for the "cdma" property.

get_evdo ()

Getter for the "evdo" property.

get_gsm ()

Getter for the "gsm" property.

get_lte ()

Getter for the "lte" property.

get_rate ()

Getter for the "rate" property.

get_umts ()

Getter for the "umts" property.

mm_gdbus_modem_signal_get_rate ()

guint               mm_gdbus_modem_signal_get_rate      (MmGdbusModemSignal *object);

Gets the value of the "Rate" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

object :

A MmGdbusModemSignal.

Returns :

The property value.

mm_gdbus_modem_signal_get_cdma ()

GVariant *          mm_gdbus_modem_signal_get_cdma      (MmGdbusModemSignal *object);

Gets the value of the "Cdma" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object was constructed. Use mm_gdbus_modem_signal_dup_cdma() if on another thread.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. Do not free the returned value, it belongs to object. [transfer none]

mm_gdbus_modem_signal_get_evdo ()

GVariant *          mm_gdbus_modem_signal_get_evdo      (MmGdbusModemSignal *object);

Gets the value of the "Evdo" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object was constructed. Use mm_gdbus_modem_signal_dup_evdo() if on another thread.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. Do not free the returned value, it belongs to object. [transfer none]

mm_gdbus_modem_signal_get_gsm ()

GVariant *          mm_gdbus_modem_signal_get_gsm       (MmGdbusModemSignal *object);

Gets the value of the "Gsm" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object was constructed. Use mm_gdbus_modem_signal_dup_gsm() if on another thread.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. Do not free the returned value, it belongs to object. [transfer none]

mm_gdbus_modem_signal_get_umts ()

GVariant *          mm_gdbus_modem_signal_get_umts      (MmGdbusModemSignal *object);

Gets the value of the "Umts" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object was constructed. Use mm_gdbus_modem_signal_dup_umts() if on another thread.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. Do not free the returned value, it belongs to object. [transfer none]

mm_gdbus_modem_signal_get_lte ()

GVariant *          mm_gdbus_modem_signal_get_lte       (MmGdbusModemSignal *object);

Gets the value of the "Lte" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object was constructed. Use mm_gdbus_modem_signal_dup_lte() if on another thread.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. Do not free the returned value, it belongs to object. [transfer none]

mm_gdbus_modem_signal_dup_cdma ()

GVariant *          mm_gdbus_modem_signal_dup_cdma      (MmGdbusModemSignal *object);

Gets a copy of the "Cdma" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. The returned value should be freed with g_variant_unref(). [transfer full]

mm_gdbus_modem_signal_dup_evdo ()

GVariant *          mm_gdbus_modem_signal_dup_evdo      (MmGdbusModemSignal *object);

Gets a copy of the "Evdo" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. The returned value should be freed with g_variant_unref(). [transfer full]

mm_gdbus_modem_signal_dup_gsm ()

GVariant *          mm_gdbus_modem_signal_dup_gsm       (MmGdbusModemSignal *object);

Gets a copy of the "Gsm" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. The returned value should be freed with g_variant_unref(). [transfer full]

mm_gdbus_modem_signal_dup_umts ()

GVariant *          mm_gdbus_modem_signal_dup_umts      (MmGdbusModemSignal *object);

Gets a copy of the "Umts" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. The returned value should be freed with g_variant_unref(). [transfer full]

mm_gdbus_modem_signal_dup_lte ()

GVariant *          mm_gdbus_modem_signal_dup_lte       (MmGdbusModemSignal *object);

Gets a copy of the "Lte" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

object :

A MmGdbusModemSignal.

Returns :

The property value or NULL if the property is not set. The returned value should be freed with g_variant_unref(). [transfer full]

mm_gdbus_modem_signal_call_setup ()

void                mm_gdbus_modem_signal_call_setup    (MmGdbusModemSignal *proxy,
                                                         guint arg_rate,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the Setup() D-Bus method on proxy. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call mm_gdbus_modem_signal_call_setup_finish() to get the result of the operation.

See mm_gdbus_modem_signal_call_setup_sync() for the synchronous, blocking version of this method.

proxy :

A MmGdbusModemSignalProxy.

arg_rate :

Argument to pass with the method invocation.

cancellable :

A GCancellable or NULL. [allow-none]

callback :

A GAsyncReadyCallback to call when the request is satisfied or NULL.

user_data :

User data to pass to callback.

mm_gdbus_modem_signal_call_setup_finish ()

gboolean            mm_gdbus_modem_signal_call_setup_finish
                                                        (MmGdbusModemSignal *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with mm_gdbus_modem_signal_call_setup().

proxy :

A MmGdbusModemSignalProxy.

res :

The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_gdbus_modem_signal_call_setup().

error :

Return location for error or NULL.

Returns :

TRUE if the call succeded, FALSE if error is set. [skip]

mm_gdbus_modem_signal_call_setup_sync ()

gboolean            mm_gdbus_modem_signal_call_setup_sync
                                                        (MmGdbusModemSignal *proxy,
                                                         guint arg_rate,
                                                         GCancellable *cancellable,
                                                         GError **error);

Synchronously invokes the Setup() D-Bus method on proxy. The calling thread is blocked until a reply is received.

See mm_gdbus_modem_signal_call_setup() for the asynchronous version of this method.

proxy :

A MmGdbusModemSignalProxy.

arg_rate :

Argument to pass with the method invocation.

cancellable :

A GCancellable or NULL. [allow-none]

error :

Return location for error or NULL.

Returns :

TRUE if the call succeded, FALSE if error is set. [skip]

Property Details

The "cdma" property

  "cdma"                     GVariant*             : Read / Write

Represents the D-Bus property "Cdma".

Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Allowed values: GVariant<a{sv}>

Default value: NULL


The "evdo" property

  "evdo"                     GVariant*             : Read / Write

Represents the D-Bus property "Evdo".

Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Allowed values: GVariant<a{sv}>

Default value: NULL


The "gsm" property

  "gsm"                      GVariant*             : Read / Write

Represents the D-Bus property "Gsm".

Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Allowed values: GVariant<a{sv}>

Default value: NULL


The "lte" property

  "lte"                      GVariant*             : Read / Write

Represents the D-Bus property "Lte".

Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Allowed values: GVariant<a{sv}>

Default value: NULL


The "rate" property

  "rate"                     guint                 : Read / Write

Represents the D-Bus property "Rate".

Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Default value: 0


The "umts" property

  "umts"                     GVariant*             : Read / Write

Represents the D-Bus property "Umts".

Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Allowed values: GVariant<a{sv}>

Default value: NULL

Signal Details

The "handle-setup" signal

gboolean            user_function                      (MmGdbusModemSignal    *object,
                                                        GDBusMethodInvocation *invocation,
                                                        guint                  arg_rate,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the Setup() D-Bus method.

If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call mm_gdbus_modem_signal_complete_setup() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.

object :

A MmGdbusModemSignal.

invocation :

A GDBusMethodInvocation.

arg_rate :

Argument passed by remote caller.

user_data :

user data set when the signal handler was connected.

Returns :

TRUE if the invocation was handled, FALSE to let other signal handlers run.