MmGdbusCall

MmGdbusCall — Generated C code for the org.freedesktop.ModemManager1.Call D-Bus interface

Synopsis

                    MmGdbusCall;
struct              MmGdbusCallIface;

gint                mm_gdbus_call_get_direction         (MmGdbusCall *object);
const gchar *       mm_gdbus_call_get_number            (MmGdbusCall *object);
gchar *             mm_gdbus_call_dup_number            (MmGdbusCall *object);
gint                mm_gdbus_call_get_state             (MmGdbusCall *object);
gint                mm_gdbus_call_get_state_reason      (MmGdbusCall *object);
void                mm_gdbus_call_emit_dtmf_received    (MmGdbusCall *object,
                                                         const gchar *arg_dtmf);
void                mm_gdbus_call_emit_state_changed    (MmGdbusCall *object,
                                                         gint arg_old,
                                                         gint arg_new,
                                                         guint arg_reason);

void                mm_gdbus_call_call_accept           (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            mm_gdbus_call_call_accept_finish    (MmGdbusCall *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
gboolean            mm_gdbus_call_call_accept_sync      (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                mm_gdbus_call_call_start            (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            mm_gdbus_call_call_start_finish     (MmGdbusCall *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
gboolean            mm_gdbus_call_call_start_sync       (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                mm_gdbus_call_call_hangup           (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            mm_gdbus_call_call_hangup_finish    (MmGdbusCall *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
gboolean            mm_gdbus_call_call_hangup_sync      (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);
void                mm_gdbus_call_call_send_dtmf        (MmGdbusCall *proxy,
                                                         const gchar *arg_dtmf,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            mm_gdbus_call_call_send_dtmf_finish (MmGdbusCall *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);
gboolean            mm_gdbus_call_call_send_dtmf_sync   (MmGdbusCall *proxy,
                                                         const gchar *arg_dtmf,
                                                         GCancellable *cancellable,
                                                         GError **error);

Object Hierarchy

  GInterface
   +----MmGdbusCall

Prerequisites

MmGdbusCall requires GObject.

Known Implementations

MmGdbusCall is implemented by MMCall, MmGdbusCallProxy and MmGdbusCallSkeleton.

Properties

  "direction"                gint                  : Read / Write
  "number"                   gchar*                : Read / Write
  "state"                    gint                  : Read / Write
  "state-reason"             gint                  : Read / Write

Signals

  "dtmf-received"                                  : Run Last
  "handle-accept"                                  : Run Last
  "handle-hangup"                                  : Run Last
  "handle-send-dtmf"                               : Run Last
  "handle-start"                                   : Run Last
  "state-changed"                                  : Run Last

Description

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

Details

MmGdbusCall

typedef struct _MmGdbusCall MmGdbusCall;

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

struct MmGdbusCallIface

struct MmGdbusCallIface {
  GTypeInterface parent_iface;



  gboolean (*handle_accept) (
    MmGdbusCall *object,
    GDBusMethodInvocation *invocation);

  gboolean (*handle_hangup) (
    MmGdbusCall *object,
    GDBusMethodInvocation *invocation);

  gboolean (*handle_send_dtmf) (
    MmGdbusCall *object,
    GDBusMethodInvocation *invocation,
    const gchar *arg_dtmf);

  gboolean (*handle_start) (
    MmGdbusCall *object,
    GDBusMethodInvocation *invocation);

  gint  (*get_direction) (MmGdbusCall *object);

  const gchar * (*get_number) (MmGdbusCall *object);

  gint  (*get_state) (MmGdbusCall *object);

  gint  (*get_state_reason) (MmGdbusCall *object);

  void (*dtmf_received) (
    MmGdbusCall *object,
    const gchar *arg_dtmf);

  void (*state_changed) (
    MmGdbusCall *object,
    gint arg_old,
    gint arg_new,
    guint arg_reason);
};

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

GTypeInterface parent_iface;

 The parent interface.

handle_accept ()

 Handler for the "handle-accept" signal.

handle_hangup ()

 Handler for the "handle-hangup" signal.

handle_send_dtmf ()

 Handler for the "handle-send-dtmf" signal.

handle_start ()

 Handler for the "handle-start" signal.

get_direction ()

 Getter for the "direction" property.

get_number ()

 Getter for the "number" property.

get_state ()

 Getter for the "state" property.

get_state_reason ()

 Getter for the "state-reason" property.

dtmf_received ()

 Handler for the "dtmf-received" signal.

state_changed ()

 Handler for the "state-changed" signal.

mm_gdbus_call_get_direction ()

gint                mm_gdbus_call_get_direction         (MmGdbusCall *object);

Gets the value of the "Direction" 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 MmGdbusCall.

Returns :

 The property value.

mm_gdbus_call_get_number ()

const gchar *       mm_gdbus_call_get_number            (MmGdbusCall *object);

Gets the value of the "Number" 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_call_dup_number() if on another thread.

object :

 A MmGdbusCall.

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_call_dup_number ()

gchar *             mm_gdbus_call_dup_number            (MmGdbusCall *object);

Gets a copy of the "Number" 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 MmGdbusCall.

Returns :

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

mm_gdbus_call_get_state ()

gint                mm_gdbus_call_get_state             (MmGdbusCall *object);

Gets the value of the "State" 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 MmGdbusCall.

Returns :

 The property value.

mm_gdbus_call_get_state_reason ()

gint                mm_gdbus_call_get_state_reason      (MmGdbusCall *object);

Gets the value of the "StateReason" 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 MmGdbusCall.

Returns :

 The property value.

mm_gdbus_call_emit_dtmf_received ()

void                mm_gdbus_call_emit_dtmf_received    (MmGdbusCall *object,
                                                         const gchar *arg_dtmf);

Emits the "DtmfReceived" D-Bus signal.

object :

 A MmGdbusCall.

arg_dtmf :

 Argument to pass with the signal.

mm_gdbus_call_emit_state_changed ()

void                mm_gdbus_call_emit_state_changed    (MmGdbusCall *object,
                                                         gint arg_old,
                                                         gint arg_new,
                                                         guint arg_reason);

Emits the "StateChanged" D-Bus signal.

object :

 A MmGdbusCall.

arg_old :

 Argument to pass with the signal.

arg_new :

 Argument to pass with the signal.

arg_reason :

 Argument to pass with the signal.

mm_gdbus_call_call_accept ()

void                mm_gdbus_call_call_accept           (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the Accept() 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_call_call_accept_finish() to get the result of the operation.

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

proxy :

 A MmGdbusCallProxy.

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_call_call_accept_finish ()

gboolean            mm_gdbus_call_call_accept_finish    (MmGdbusCall *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with mm_gdbus_call_call_accept().

proxy :

 A MmGdbusCallProxy.

res :

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

error :

 Return location for error or NULL.

Returns :

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

mm_gdbus_call_call_accept_sync ()

gboolean            mm_gdbus_call_call_accept_sync      (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

 A MmGdbusCallProxy.

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]

mm_gdbus_call_call_start ()

void                mm_gdbus_call_call_start            (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the Start() 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_call_call_start_finish() to get the result of the operation.

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

proxy :

 A MmGdbusCallProxy.

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_call_call_start_finish ()

gboolean            mm_gdbus_call_call_start_finish     (MmGdbusCall *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with mm_gdbus_call_call_start().

proxy :

 A MmGdbusCallProxy.

res :

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

error :

 Return location for error or NULL.

Returns :

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

mm_gdbus_call_call_start_sync ()

gboolean            mm_gdbus_call_call_start_sync       (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

 A MmGdbusCallProxy.

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]

mm_gdbus_call_call_hangup ()

void                mm_gdbus_call_call_hangup           (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the Hangup() 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_call_call_hangup_finish() to get the result of the operation.

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

proxy :

 A MmGdbusCallProxy.

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_call_call_hangup_finish ()

gboolean            mm_gdbus_call_call_hangup_finish    (MmGdbusCall *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with mm_gdbus_call_call_hangup().

proxy :

 A MmGdbusCallProxy.

res :

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

error :

 Return location for error or NULL.

Returns :

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

mm_gdbus_call_call_hangup_sync ()

gboolean            mm_gdbus_call_call_hangup_sync      (MmGdbusCall *proxy,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

 A MmGdbusCallProxy.

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]

mm_gdbus_call_call_send_dtmf ()

void                mm_gdbus_call_call_send_dtmf        (MmGdbusCall *proxy,
                                                         const gchar *arg_dtmf,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously invokes the SendDtmf() 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_call_call_send_dtmf_finish() to get the result of the operation.

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

proxy :

 A MmGdbusCallProxy.

arg_dtmf :

 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_call_call_send_dtmf_finish ()

gboolean            mm_gdbus_call_call_send_dtmf_finish (MmGdbusCall *proxy,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an operation started with mm_gdbus_call_call_send_dtmf().

proxy :

 A MmGdbusCallProxy.

res :

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

error :

 Return location for error or NULL.

Returns :

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

mm_gdbus_call_call_send_dtmf_sync ()

gboolean            mm_gdbus_call_call_send_dtmf_sync   (MmGdbusCall *proxy,
                                                         const gchar *arg_dtmf,
                                                         GCancellable *cancellable,
                                                         GError **error);

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

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

proxy :

 A MmGdbusCallProxy.

arg_dtmf :

 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 "direction" property

  "direction"                gint                  : Read / Write

Represents the D-Bus property "Direction".

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 "number" property

  "number"                   gchar*                : Read / Write

Represents the D-Bus property "Number".

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: NULL

The "state" property

  "state"                    gint                  : Read / Write

Represents the D-Bus property "State".

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 "state-reason" property

  "state-reason"             gint                  : Read / Write

Represents the D-Bus property "StateReason".

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

Signal Details

The "dtmf-received" signal

void                user_function                      (MmGdbusCall *object,
                                                        gchar       *arg_dtmf,
                                                        gpointer     user_data)      : Run Last

On the client-side, this signal is emitted whenever the D-Bus signal "DtmfReceived" is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

object :

 A MmGdbusCall.

arg_dtmf :

 Argument.

user_data :

 user data set when the signal handler was connected.

The "handle-accept" signal

gboolean            user_function                      (MmGdbusCall           *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the Accept() 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_call_complete_accept() 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 MmGdbusCall.

invocation :

 A GDBusMethodInvocation.

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.

The "handle-hangup" signal

gboolean            user_function                      (MmGdbusCall           *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the Hangup() 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_call_complete_hangup() 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 MmGdbusCall.

invocation :

 A GDBusMethodInvocation.

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.

The "handle-send-dtmf" signal

gboolean            user_function                      (MmGdbusCall           *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gchar                 *arg_dtmf,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the SendDtmf() 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_call_complete_send_dtmf() 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 MmGdbusCall.

invocation :

 A GDBusMethodInvocation.

arg_dtmf :

 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.

The "handle-start" signal

gboolean            user_function                      (MmGdbusCall           *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the Start() 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_call_complete_start() 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 MmGdbusCall.

invocation :

 A GDBusMethodInvocation.

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.

The "state-changed" signal

void                user_function                      (MmGdbusCall *object,
                                                        gint         arg_old,
                                                        gint         arg_new,
                                                        guint        arg_reason,
                                                        gpointer     user_data)       : Run Last

On the client-side, this signal is emitted whenever the D-Bus signal "StateChanged" is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

object :

 A MmGdbusCall.

arg_old :

 Argument.

arg_new :

 Argument.

arg_reason :

 Argument.

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.19