Top |
struct | MMModemLocation |
#define | MM_LOCATION_LONGITUDE_UNKNOWN |
#define | MM_LOCATION_LATITUDE_UNKNOWN |
#define | MM_LOCATION_ALTITUDE_UNKNOWN |
MMModemLocation implements GDBusInterface, GInitable, GAsyncInitable and MmGdbusModemLocation.
The MMModemLocation is an object providing access to the methods, signals and properties of the Location interface.
The Location interface is exposed whenever a modem has location capabilities.
const gchar *
mm_modem_location_get_path (MMModemLocation *self
);
Gets the DBus path of the MMObject which implements this interface.
Since: 1.0
gchar *
mm_modem_location_dup_path (MMModemLocation *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
MMModemLocationSource
mm_modem_location_get_capabilities (MMModemLocation *self
);
Gets a bitmask of the location capabilities supported by this MMModemLocation.
Since: 1.0
MMModemLocationSource
mm_modem_location_get_enabled (MMModemLocation *self
);
Gets a bitmask of the location capabilities which are enabled in this MMModemLocation.
Since: 1.0
guint
mm_modem_location_get_gps_refresh_rate
(MMModemLocation *self
);
Gets the GPS refresh rate, in seconds.
Since: 1.0
gboolean
mm_modem_location_signals_location (MMModemLocation *self
);
Gets the status of the location signaling in the MMModemLocation.
Since: 1.0
gchar *
mm_modem_location_dup_supl_server (MMModemLocation *self
);
Gets the address of the SUPL server.
The SUPL server address, or NULL
if none
available. The returned value should be freed with g_free()
.
[transfer full]
Since: 1.6
const gchar *
mm_modem_location_get_supl_server (MMModemLocation *self
);
Gets the address of the SUPL server.
self
was constructed. Use
mm_modem_location_dup_supl_server()
if on another thread.The SUPL server address, or NULL
if none
available. Do not free the returned value, it belongs to self
.
[transfer none]
Since: 1.6
MMModemLocationAssistanceDataType
mm_modem_location_get_supported_assistance_data
(MMModemLocation *self
);
Gets a bitmask of the supported assistance data types.
Since: 1.10
gchar **
mm_modem_location_dup_assistance_data_servers
(MMModemLocation *self
);
Gets the list of assistance data servers.
a NULL
-terminated array of server addresses, or
NULL
if none available. The returned value should be freed with
g_strfreev()
.
[transfer full]
Since: 1.10
const gchar **
mm_modem_location_get_assistance_data_servers
(MMModemLocation *self
);
Gets the list of assistance data servers.
self
was constructed. Use
mm_modem_location_dup_assistance_data_servers()
if on another thread.
a NULL
-terminated array of server addresses, or
NULL
if none available. Do not free the returned value, it belongs to self
.
[transfer none]
Since: 1.10
void mm_modem_location_setup (MMModemLocation *self
,MMModemLocationSource sources
,gboolean signal_location
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously configures the location sources to use when gathering location information. Also enable or disable location information gathering.
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_setup_finish()
to get the result of the operation.
See mm_modem_location_setup_sync()
for the synchronous, blocking version of
this method.
self |
||
sources |
Bitmask of MMModemLocationSource values specifying which locations should get enabled. |
|
signal_location |
Flag to enable or disable location signaling. |
|
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_location_setup_finish (MMModemLocation *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_location_setup()
.
self |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
Since: 1.0
gboolean mm_modem_location_setup_sync (MMModemLocation *self
,MMModemLocationSource sources
,gboolean signal_location
,GCancellable *cancellable
,GError **error
);
Synchronously configures the location sources to use when gathering location information. Also enable or disable location information gathering.
The calling thread is blocked until a reply is received. See
mm_modem_location_setup()
for the asynchronous version of this method.
self |
||
sources |
Bitmask of MMModemLocationSource values specifying which locations should get enabled. |
|
signal_location |
Flag to enable or disable location signaling. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.0
void mm_modem_location_set_supl_server (MMModemLocation *self
,const gchar *supl
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously configures the address of the SUPL server for A-GPS 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_location_set_supl_server_finish()
to get the result of the operation.
See mm_modem_location_set_supl_server_sync()
for the synchronous, blocking
version of this method.
self |
||
supl |
The SUPL server address, given as IP:PORT or with a full URL. |
|
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.6
gboolean mm_modem_location_set_supl_server_finish (MMModemLocation *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_location_set_supl_server()
.
self |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.6
gboolean mm_modem_location_set_supl_server_sync (MMModemLocation *self
,const gchar *supl
,GCancellable *cancellable
,GError **error
);
Synchronously configures the address of the SUPL server for A-GPS operation.
The calling thread is blocked until a reply is received. See
mm_modem_location_set_supl_server()
for the asynchronous version of this
method.
self |
||
supl |
The SUPL server address, given as IP:PORT or with a full URL. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.6
void mm_modem_location_inject_assistance_data (MMModemLocation *self
,const guint8 *data
,gsize data_size
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Aynchronously injects assistance data to the GNSS module.
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_location_inject_assistance_data_sync()
for the synchronous,
blocking version of this method.
self |
||
data |
Data to inject. |
[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.10
gboolean mm_modem_location_inject_assistance_data_finish (MMModemLocation *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with
mm_modem_location_inject_assistance_data()
.
self |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.10
gboolean mm_modem_location_inject_assistance_data_sync (MMModemLocation *self
,const guint8 *data
,gsize data_size
,GCancellable *cancellable
,GError **error
);
Synchronously injects assistance data to the GNSS module.
The calling thread is blocked until a reply is received. See
mm_modem_location_inject_assistance_data()
for the asynchronous version of
this method.
self |
||
data |
Data to inject. |
[array length=data_size] |
data_size |
size of |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.10
void mm_modem_location_set_gps_refresh_rate (MMModemLocation *self
,guint rate
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously configures the GPS refresh rate.
If a 0 rate is used, the GPS location updates will be immediately propagated to the interface.
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_set_gps_refresh_rate_finish()
to get the result of the
operation.
See mm_modem_location_set_gps_refresh_rate_sync()
for the synchronous,
blocking version of this method.
self |
||
rate |
The GPS refresh rate, in seconds. |
|
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_location_set_gps_refresh_rate_finish (MMModemLocation *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_location_set_gps_refresh_rate()
.
self |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.0
gboolean mm_modem_location_set_gps_refresh_rate_sync (MMModemLocation *self
,guint rate
,GCancellable *cancellable
,GError **error
);
Synchronously configures the GPS refresh rate.
If a 0 rate is used, the GPS location updates will be immediately propagated to the interface.
The calling thread is blocked until a reply is received. See
mm_modem_location_set_gps_refresh_rate()
for the asynchronous version of this
method.
self |
||
rate |
The GPS refresh rate, in seconds. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.0
void mm_modem_location_get_3gpp (MMModemLocation *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously gets the current 3GPP location information.
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_get_3gpp_finish()
to get the result of the operation.
See mm_modem_location_get_3gpp_sync()
for the synchronous, blocking version
of this method.
self |
||
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
MMLocation3gpp * mm_modem_location_get_3gpp_finish (MMModemLocation *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_location_get_3gpp()
.
self |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
A MMLocation3gpp, or NULL if not available. The
returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
MMLocation3gpp * mm_modem_location_get_3gpp_sync (MMModemLocation *self
,GCancellable *cancellable
,GError **error
);
Synchronously gets the current 3GPP location information.
The calling thread is blocked until a reply is received. See
mm_modem_location_get_3gpp()
for the asynchronous version of this method.
self |
||
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
A MMLocation3gpp, or NULL if not available. The
returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
void mm_modem_location_get_gps_nmea (MMModemLocation *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously gets the current GPS NMEA location information.
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_get_gps_nmea_finish()
to get the result of the operation.
See mm_modem_location_get_gps_nmea_sync()
for the synchronous, blocking
version of this method.
self |
||
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
MMLocationGpsNmea * mm_modem_location_get_gps_nmea_finish (MMModemLocation *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_location_get_gps_nmea()
.
self |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
A MMLocationGpsNmea, or NULL if not available.
The returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
MMLocationGpsNmea * mm_modem_location_get_gps_nmea_sync (MMModemLocation *self
,GCancellable *cancellable
,GError **error
);
Synchronously gets the current GPS NMEA location information.
The calling thread is blocked until a reply is received. See
mm_modem_location_get_gps_nmea()
for the asynchronous version of this method.
self |
||
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
A MMLocationGpsNmea, or NULL if not available.
The returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
void mm_modem_location_get_gps_raw (MMModemLocation *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously gets the current GPS raw location information.
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_get_gps_raw_finish()
to get the result of the operation.
See mm_modem_location_get_gps_raw_sync()
for the synchronous, blocking
version of this method.
self |
||
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
MMLocationGpsRaw * mm_modem_location_get_gps_raw_finish (MMModemLocation *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_location_get_gps_raw()
.
self |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
A MMLocationGpsRaw, or NULL if not available.
The returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
MMLocationGpsRaw * mm_modem_location_get_gps_raw_sync (MMModemLocation *self
,GCancellable *cancellable
,GError **error
);
Synchronously gets the current GPS raw location information.
The calling thread is blocked until a reply is received. See
mm_modem_location_get_gps_raw()
for the asynchronous version of this method.
self |
||
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
A MMLocationGpsRaw, or NULL if not available.
The returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
void mm_modem_location_get_cdma_bs (MMModemLocation *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously gets the current CDMA base station location information.
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_get_cdma_bs_finish()
to get the result of the operation.
See mm_modem_location_get_cdma_bs_sync()
for the synchronous, blocking
version of this method.
self |
||
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
MMLocationCdmaBs * mm_modem_location_get_cdma_bs_finish (MMModemLocation *self
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_modem_location_get_cdma_bs()
.
self |
||
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
A MMLocationCdmaBs, or NULL if not available.
The returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
MMLocationCdmaBs * mm_modem_location_get_cdma_bs_sync (MMModemLocation *self
,GCancellable *cancellable
,GError **error
);
Synchronously gets the current CDMA base station location information.
The calling thread is blocked until a reply is received. See
mm_modem_location_get_cdma_bs()
for the asynchronous version of this method.
self |
||
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
A MMLocationCdmaBs, or NULL if not available.
The returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
void mm_modem_location_get_full (MMModemLocation *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously gets the current location information.
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_get_full_finish()
to get the result of the operation.
See mm_modem_location_get_full_sync()
for the synchronous, blocking version
of this method.
self |
||
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_location_get_full_finish (MMModemLocation *self
,GAsyncResult *res
,MMLocation3gpp **location_3gpp
,MMLocationGpsNmea **location_gps_nmea
,MMLocationGpsRaw **location_gps_raw
,MMLocationCdmaBs **location_cdma_bs
,GError **error
);
Finishes an operation started with mm_modem_location_get_full()
.
self |
||
location_3gpp |
Return location for a
MMLocation3gpp if 3GPP location is requested, or NULL if not required. The
returned value should be freed with |
[out][allow-none][transfer full] |
location_gps_nmea |
Return location for a
MMLocationGpsNmea if GPS NMEA location is requested, or NULL if not
required. The returned value should be freed with |
[out][allow-none][transfer full] |
location_gps_raw |
Return location for a
MMLocationGpsRaw if GPS raw location is requested, or NULL if not required.
The returned value should be freed with |
[out][allow-none][transfer full] |
location_cdma_bs |
Return location for a
MMLocationCdmaBs if CDMA Base Station location is requested, or NULL if
not required. The returned value should be freed with |
[out][allow-none][transfer full] |
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to
|
|
error |
Return location for error or |
Since: 1.0
gboolean mm_modem_location_get_full_sync (MMModemLocation *self
,MMLocation3gpp **location_3gpp
,MMLocationGpsNmea **location_gps_nmea
,MMLocationGpsRaw **location_gps_raw
,MMLocationCdmaBs **location_cdma_bs
,GCancellable *cancellable
,GError **error
);
Synchronously gets the current location information.
The calling thread is blocked until a reply is received. See
mm_modem_location_get_full()
for the asynchronous version of this method.
self |
||
location_3gpp |
Return location for a
MMLocation3gpp if 3GPP location is requested, or NULL if not required. The
returned value should be freed with |
[out][allow-none][transfer full] |
location_gps_nmea |
Return location for a
MMLocationGpsNmea if GPS NMEA location is requested, or NULL if not
required. The returned value should be freed with |
[out][allow-none][transfer full] |
location_gps_raw |
Return location for a
MMLocationGpsRaw if GPS raw location is requested, or NULL if not required.
The returned value should be freed with |
[out][allow-none][transfer full] |
location_cdma_bs |
Return location for a
MMLocationCdmaBs if CDMA Base Station location is requested, or NULL if
not required. The returned value should be freed with |
[out][allow-none][transfer full] |
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
Since: 1.0
struct MMModemLocation;
The MMModemLocation structure contains private data and should only be accessed using the provided API.
#define MM_LOCATION_LONGITUDE_UNKNOWN -G_MAXDOUBLE
Identifier for an unknown longitude value.
Proper longitude values fall in the [-180,180] range.
Since: 1.0
#define MM_LOCATION_LATITUDE_UNKNOWN -G_MAXDOUBLE
Identifier for an unknown latitude value.
Proper latitude values fall in the [-90,90] range.
Since: 1.0
#define MM_LOCATION_ALTITUDE_UNKNOWN -G_MAXDOUBLE
Identifier for an unknown altitude value.
Since: 1.0