Top |
GBoxed ╰── MMModem3gppNetwork GObject ╰── GDBusProxy ╰── MmGdbusModem3gppProxy ╰── MMModem3gpp
MMModem3gpp implements GDBusInterface, GInitable, GAsyncInitable and MmGdbusModem3gpp.
The MMModem3gpp is an object providing access to the methods, signals and properties of the 3GPP interface.
The 3GPP interface is exposed whenever a modem has any of the 3GPP
capabilities (MM_MODEM_CAPABILITY_GSM_UMTS
, MM_MODEM_CAPABILITY_LTE
or MM_MODEM_CAPABILITY_5GNR
).
const gchar *
mm_modem_3gpp_network_get_operator_code
(const MMModem3gppNetwork *network
);
Get the operator code (MCCMNC) of the 3GPP network.
Since: 1.0
const gchar *
mm_modem_3gpp_network_get_operator_short
(const MMModem3gppNetwork *network
);
Get the short operator name of the 3GPP network.
Since: 1.0
const gchar *
mm_modem_3gpp_network_get_operator_long
(const MMModem3gppNetwork *network
);
Get the long operator name of the 3GPP network.
Since: 1.0
MMModemAccessTechnology
mm_modem_3gpp_network_get_access_technology
(const MMModem3gppNetwork *network
);
Get the technology used to access the 3GPP network.
Since: 1.0
MMModem3gppNetworkAvailability
mm_modem_3gpp_network_get_availability
(const MMModem3gppNetwork *network
);
Get availability of the 3GPP network.
Since: 1.0
void
mm_modem_3gpp_network_free (MMModem3gppNetwork *network
);
Frees a MMModem3gppNetwork.
Since: 1.0
const gchar *
mm_modem_3gpp_get_path (MMModem3gpp *self
);
Gets the DBus path of the MMObject which implements this interface.
Since: 1.0
gchar *
mm_modem_3gpp_dup_path (MMModem3gpp *self
);
Gets a copy of the DBus path of the MMObject object which implements this interface.
The DBus path of the MMObject. The returned value
should be freed with g_free()
.
[transfer full]
Since: 1.0
const gchar *
mm_modem_3gpp_get_imei (MMModem3gpp *self
);
Gets the IMEI, as reported by this MMModem3gpp.
self
was constructed. Use mm_modem_3gpp_dup_imei()
if on another
thread.Since: 1.0
gchar *
mm_modem_3gpp_dup_imei (MMModem3gpp *self
);
Gets a copy of the IMEI, as reported by this MMModem3gpp.
The IMEI, or NULL
if none available. The returned
value should be freed with g_free()
.
[transfer full]
Since: 1.0
const gchar *
mm_modem_3gpp_get_operator_code (MMModem3gpp *self
);
Gets the code of the operator to which the mobile is currently registered.
Returned in the format "MCCMNC"
, where
MCC
is the three-digit ITU E.212 Mobile Country Code
and MNC
is the two- or three-digit GSM Mobile Network
Code. e.g. e"31026"
or "310260"
.
If the MCC
and MNC
are not known
or the mobile is not registered to a mobile network, this property will
be a zero-length (blank) string.
self
was constructed. Use mm_modem_3gpp_dup_operator_code()
if on another
thread.Since: 1.0
gchar *
mm_modem_3gpp_dup_operator_code (MMModem3gpp *self
);
Gets a copy of the code of the operator to which the mobile is currently registered.
Returned in the format "MCCMNC"
, where
MCC
is the three-digit ITU E.212 Mobile Country Code
and MNC
is the two- or three-digit GSM Mobile Network
Code. e.g. e"31026"
or "310260"
.
The operator code, or NULL
if none available.
The returned value should be freed with g_free()
.
[transfer full]
Since: 1.0
const gchar *
mm_modem_3gpp_get_operator_name (MMModem3gpp *self
);
Gets the name of the operator to which the mobile is currently registered.
self
was constructed. Use mm_modem_3gpp_dup_operator_name()
if on another
thread.Since: 1.0
gchar *
mm_modem_3gpp_dup_operator_name (MMModem3gpp *self
);
Gets a copy of the name of the operator to which the mobile is currently registered.
The operator name, or NULL
if none available.
The returned value should be freed with g_free()
.
[transfer full]
Since: 1.0
MMModem3gppFacility
mm_modem_3gpp_get_enabled_facility_locks
(MMModem3gpp *self
);
Get the list of facilities for which PIN locking is enabled.
Since: 1.0
MMModem3gppRegistrationState
mm_modem_3gpp_get_registration_state (MMModem3gpp *self
);
Get the the mobile registration status as defined in 3GPP TS 27.007 section 10.1.19.
Since: 1.0
GList *
mm_modem_3gpp_get_pco (MMModem3gpp *self
);
Get the list of MMPco received from the network.
a list of MMPco
objects, or NULL if error
is set. The returned value should be freed with
g_list_free_full()
using g_object_unref()
as GDestroyNotify function.
[transfer full][element-type ModemManager.Pco]
Since: 1.10
MMModem3gppEpsUeModeOperation
mm_modem_3gpp_get_eps_ue_mode_operation
(MMModem3gpp *self
);
Get the UE mode of operation for EPS.
Since: 1.8
const gchar *
mm_modem_3gpp_get_initial_eps_bearer_path
(MMModem3gpp *self
);
Gets the DBus path of the initial EPS MMBearer exposed in this MMModem3gpp.
self
was constructed. Use mm_modem_3gpp_dup_initial_eps_bearer_path()
if on
another thread.[skip]
The DBus path of the MMBearer, or NULL
if none
available. Do not free the returned value, it belongs to self
.
[transfer none]
Since: 1.10
gchar *
mm_modem_3gpp_dup_initial_eps_bearer_path
(MMModem3gpp *self
);
Gets a copy of the DBus path of the initial EPS MMBearer exposed in this MMModem3gpp.
The DBus path of the MMBearer, or NULL
if none
available. The returned value should be freed with g_free()
.
[transfer full]
Since: 1.10
void mm_modem_3gpp_get_initial_eps_bearer (MMModem3gpp *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously gets the initial EPS MMBearer object exposed by this MMModem3gpp.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_3gpp_get_initial_eps_bearer_finish()
to get the result of the
operation.
See mm_modem_3gpp_get_initial_eps_bearer_sync()
for the synchronous, blocking
version of this method.
self |
A MMModem3gpp. |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or
|
|
user_data |
User data to pass to |
Since: 1.10
MMBearer * mm_modem_3gpp_get_initial_eps_bearer_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_3gpp_get_initial_eps_bearer()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
a MMSim or NULL if error
is set. The returned
value should be freed with g_object_unref()
.
[transfer full]
Since: 1.10
MMBearer * mm_modem_3gpp_get_initial_eps_bearer_sync (MMModem3gpp *self
,GCancellable *cancellable
,GError **error
);
Synchronously gets the initial EPS MMBearer object exposed by this MMModem3gpp.
The calling thread is blocked until a reply is received. See
mm_modem_3gpp_get_initial_eps_bearer()
for the asynchronous version of this
method.
self |
A MMModem3gpp. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
a MMBearer or NULL if error
is set. The returned
value should be freed with g_object_unref()
.
[transfer full]
Since: 1.10
MMBearerProperties *
mm_modem_3gpp_get_initial_eps_bearer_settings
(MMModem3gpp *self
);
Gets a MMBearerProperties object specifying the settings configured in the device to use when attaching to the LTE network.
self
are not updated when the values in the
interface change. Instead, the client is expected to call
mm_modem_3gpp_get_initial_eps_bearer_settings()
again to get a new
MMBearerProperties with the new values.A MMBearerProperties that must be freed with
g_object_unref()
or NULL
if unknown.
[transfer full]
Since: 1.10
MMBearerProperties *
mm_modem_3gpp_peek_initial_eps_bearer_settings
(MMModem3gpp *self
);
Gets a MMBearerProperties object specifying the settings configured in the device to use when attaching to the LTE network.
self
was constructed. Use mm_modem_3gpp_get_initial_eps_bearer_settings()
if on another thread.Since: 1.10
MMModem3gppPacketServiceState
mm_modem_3gpp_get_packet_service_state
(MMModem3gpp *self
);
Get the packet domain service state.
Since: 1.20
MMNr5gRegistrationSettings *
mm_modem_3gpp_get_nr5g_registration_settings
(MMModem3gpp *self
);
Gets a MMNr5gRegistrationSettings object including the configured 5GNR registration settings.
self
are not updated when the values in the
interface change. Instead, the client is expected to call
mm_modem_3gpp_get_nr5g_registration_settings()
again to get a new
MMNr5gRegistrationSettings with the new values.A MMNr5gRegistrationSettings that must be freed with
g_object_unref()
or NULL
if unknown.
[transfer full]
Since: 1.20
MMNr5gRegistrationSettings *
mm_modem_3gpp_peek_nr5g_registration_settings
(MMModem3gpp *self
);
Gets a MMNr5gRegistrationSettings object including the configured 5GNR registration settings.
self
was constructed. Use mm_modem_3gpp_get_nr5g_registration_settings()
if on another thread.A MMNr5gRegistrationSettings Do not free the returned
value, it belongs to self
.
[transfer none]
Since: 1.20
void mm_modem_3gpp_register (MMModem3gpp *self
,const gchar *network_id
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously requests registration with a given mobile network.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_3gpp_register_finish()
to get the result of the operation.
See mm_modem_3gpp_register_sync()
for the synchronous, blocking version of
this method.
self |
A MMModem3gpp. |
|
network_id |
The operator ID to register. An empty string can be used to register to the home network. |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or
|
|
user_data |
User data to pass to |
Since: 1.0
gboolean mm_modem_3gpp_register_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_3gpp_register()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.0
gboolean mm_modem_3gpp_register_sync (MMModem3gpp *self
,const gchar *network_id
,GCancellable *cancellable
,GError **error
);
Synchronously requests registration with a given mobile network.
The calling thread is blocked until a reply is received. See
mm_modem_3gpp_register()
for the asynchronous version of this method.
self |
A MMModem3gpp. |
|
network_id |
The operator ID to register. An empty string can be used to register to the home network. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.0
void mm_modem_3gpp_scan (MMModem3gpp *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously requests to scan available 3GPP networks.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_3gpp_scan_finish()
to get the result of the operation.
See mm_modem_3gpp_scan_sync()
for the synchronous, blocking version of this
method.
self |
A MMModem3gpp. |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or
|
|
user_data |
User data to pass to |
Since: 1.0
GList * mm_modem_3gpp_scan_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_3gpp_scan()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
a list
of MMModem3gppNetwork structs, or NULL if error
is set. The returned value
should be freed with g_list_free_full()
using mm_modem_3gpp_network_free()
as
GDestroyNotify function.
[transfer full][element-type ModemManager.Modem3gppNetwork]
Since: 1.0
GList * mm_modem_3gpp_scan_sync (MMModem3gpp *self
,GCancellable *cancellable
,GError **error
);
Synchronously requests to scan available 3GPP networks.
The calling thread is blocked until a reply is received. See
mm_modem_3gpp_scan()
for the asynchronous version of this method.
self |
A MMModem3gpp. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
a list
of MMModem3gppNetwork structs, or NULL if error
is set. The returned value
should be freed with g_list_free_full()
using mm_modem_3gpp_network_free()
as
GDestroyNotify function.
[transfer full][element-type ModemManager.Modem3gppNetwork]
Since: 1.0
void mm_modem_3gpp_set_eps_ue_mode_operation (MMModem3gpp *self
,MMModem3gppEpsUeModeOperation mode
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously requests to update the EPS UE mode of operation.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_3gpp_set_eps_ue_mode_operation_finish()
to get the result of the
operation.
See mm_modem_3gpp_set_eps_ue_mode_operation_sync()
for the synchronous,
blocking version of this method. The calling thread is blocked until a reply
is received.
self |
A MMModem3gpp. |
|
mode |
||
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or
|
|
user_data |
User data to pass to |
Since: 1.8
gboolean mm_modem_3gpp_set_eps_ue_mode_operation_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_3gpp_set_eps_ue_mode_operation()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.8
gboolean mm_modem_3gpp_set_eps_ue_mode_operation_sync (MMModem3gpp *self
,MMModem3gppEpsUeModeOperation mode
,GCancellable *cancellable
,GError **error
);
Synchronously requests to update the EPS UE mode of operation.
The calling thread is blocked until a reply is received.
See mm_modem_3gpp_set_eps_ue_mode_operation()
for the asynchronous version
of this method.
self |
A MMModem3gpp. |
|
mode |
||
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.8
void mm_modem_3gpp_set_initial_eps_bearer_settings (MMModem3gpp *self
,MMBearerProperties *config
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously configures the settings for the initial LTE default bearer.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_3gpp_set_initial_eps_bearer_settings_finish()
to get the result of
the operation.
self |
A MMModem3gpp. |
|
config |
A MMBearerProperties object with the properties to use. |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or
|
|
user_data |
User data to pass to |
Since: 1.10
gboolean mm_modem_3gpp_set_initial_eps_bearer_settings_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with
mm_modem_3gpp_set_initial_eps_bearer_settings()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.10
gboolean mm_modem_3gpp_set_initial_eps_bearer_settings_sync (MMModem3gpp *self
,MMBearerProperties *config
,GCancellable *cancellable
,GError **error
);
Synchronously configures the settings for the initial LTE default bearer.
The calling thread is blocked until a reply is received. See
mm_modem_3gpp_set_initial_eps_bearer_settings()
for the asynchronous
version of this method.
self |
A MMModem3gpp. |
|
config |
A MMBearerProperties object with the properties to use. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.10
void mm_modem_3gpp_disable_facility_lock (MMModem3gpp *self
,MMModem3gppFacility facility
,const gchar *control_key
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously disables the modem personalization lock.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_3gpp_disable_facility_lock_finish()
to get the result of
the operation.
self |
A MMModem3gpp. |
|
facility |
Single bit value describing the modem personalization lock to disable. |
|
control_key |
String with control key required to unlock the personalization. |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or
|
|
user_data |
User data to pass to |
Since: 1.20
gboolean mm_modem_3gpp_disable_facility_lock_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_3gpp_disable_facility_lock()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.20
gboolean mm_modem_3gpp_disable_facility_lock_sync (MMModem3gpp *self
,MMModem3gppFacility facility
,const gchar *control_key
,GCancellable *cancellable
,GError **error
);
Synchronously disables facility lock.
The calling thread is blocked until a reply is received.
See mm_modem_3gpp_disable_facility_lock()
for the asynchronous
version of this method.
self |
A MMModem3gpp. |
|
facility |
Single bit value describing the modem personalization lock to disable. |
|
control_key |
String with control key required to unlock the personalization. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.20
void mm_modem_3gpp_set_packet_service_state (MMModem3gpp *self
,MMModem3gppPacketServiceState state
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously tries to attach or detach from the packet domain service.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_3gpp_set_packet_service_state_finish()
to get the result of the operation.
See mm_modem_3gpp_set_packet_service_state_sync()
for the synchronous,
blocking version of this method.
self |
A MMModem3gpp. |
|
state |
||
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or
|
|
user_data |
User data to pass to |
Since: 1.20
gboolean mm_modem_3gpp_set_packet_service_state_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_3gpp_set_packet_service_state()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.20
gboolean mm_modem_3gpp_set_packet_service_state_sync (MMModem3gpp *self
,MMModem3gppPacketServiceState state
,GCancellable *cancellable
,GError **error
);
Synchronously tries to attach or detach from the packet domain service.
The calling thread is blocked until a reply is received. See
mm_modem_3gpp_set_packet_service_state()
for the asynchronous version of
this method.
self |
A MMModem3gpp. |
|
state |
||
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.20
void mm_modem_3gpp_set_nr5g_registration_settings (MMModem3gpp *self
,MMNr5gRegistrationSettings *settings
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously configures the 5GNR registration settings.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_3gpp_set_nr5g_registration_settings_finish()
to get the result of the operation.
See mm_modem_3gpp_set_nr5g_registration_settings_sync()
for the synchronous,
blocking version of this method.
self |
A MMModem3gpp. |
|
settings |
||
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or |
|
user_data |
User data to pass to |
Since: 1.20
gboolean mm_modem_3gpp_set_nr5g_registration_settings_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_3gpp_set_nr5g_registration_settings()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.20
gboolean mm_modem_3gpp_set_nr5g_registration_settings_sync (MMModem3gpp *self
,MMNr5gRegistrationSettings *settings
,GCancellable *cancellable
,GError **error
);
Synchronously configures the 5GNR registration settings.
The calling thread is blocked until a reply is received. See
mm_modem_3gpp_set_nr5g_registration_settings()
for the asynchronous
version of this method.
self |
A MMModem3gpp. |
|
settings |
||
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.20
void mm_modem_3gpp_set_carrier_lock (MMModem3gpp *self
,const guint8 *data
,gsize data_size
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously sends the carrier lock information to the modem.
When the operation is finished, callback
will be invoked in the
of the thread you are calling this method from. You can then call
mm_modem_location_inject_assistance_data_finish()
to get the result of the
operation.
See mm_modem_3gpp_set_carrier_lock_sync()
for the synchronous,
blocking version of this method.
self |
A MMModem3gpp. |
|
data |
Carrier lock information. |
[array length=data_size] |
data_size |
size of |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied or
|
|
user_data |
User data to pass to |
Since: 1.22
gboolean mm_modem_3gpp_set_carrier_lock_finish (MMModem3gpp *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_3gpp_set_carrier_lock()
.
self |
A MMModem3gpp. |
|
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
Since: 1.22
gboolean mm_modem_3gpp_set_carrier_lock_sync (MMModem3gpp *self
,const guint8 *data
,gsize data_size
,GCancellable *cancellable
,GError **error
);
Synchronously sends the carrier lock information to the modem..
The calling thread is blocked until a reply is received. See
mm_modem_3gpp_set_carrier_lock()
for the asynchronous version of this method.
self |
A MMModem3gpp. |
|
data |
Carrier lock information. |
[array length=data_size] |
data_size |
size of |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.22
struct MMModem3gpp;
The MMModem3gpp structure contains private data and should only be accessed using the provided API.
typedef struct _MMModem3gppNetwork MMModem3gppNetwork;
The MMModem3gppNetwork structure contains private data and should only be accessed using the provided API.