Editing Documentation/Maemo 5 Developer Guide/Using Connectivity Components/Maemo Connectivity
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
Warning: This page is 104 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
- | The Maemo connectivity subsystem is implemented by using known Linux conventions. It resides in the user space of Linux, and relies on the Linux kernel through standard C libraries. GPRS or WLAN is the main channel to the Internet. The Bluetooth software of | + | The Maemo connectivity subsystem is implemented by using known Linux conventions. It resides in the user space of Linux, and relies on the Linux kernel through standard C libraries. GPRS or WLAN is the main channel to the Internet. The Bluetooth software of maemo is based on BlueZ, which is known as the de-facto implementation of Bluetooth for Linux. D-Bus is used for internal application level message exchange. |
Even though the connectivity device drivers are closely related to this subsystem, they are considered to be outside of the scope of this manual. | Even though the connectivity device drivers are closely related to this subsystem, they are considered to be outside of the scope of this manual. | ||
- | ===Components of the | + | ===Components of the maemo connectivity architecture=== |
* '''Maemo connectivity UI''' - User Interface parts of the connectivity. This includes Control Panel applets and several different dialogs. | * '''Maemo connectivity UI''' - User Interface parts of the connectivity. This includes Control Panel applets and several different dialogs. | ||
Line 22: | Line 22: | ||
This section describes the system decomposition of the Connectivity subsystem. Maemo applications can open Internet connections by using the LibConIC API. The Internet Access subsystem take care of the connection to the phone, if necessary, by using the services of the Phone Access subsystem. If an application needs to gain access to the phone's files, the File selector consults the Phone Access subsystem. | This section describes the system decomposition of the Connectivity subsystem. Maemo applications can open Internet connections by using the LibConIC API. The Internet Access subsystem take care of the connection to the phone, if necessary, by using the services of the Phone Access subsystem. If an application needs to gain access to the phone's files, the File selector consults the Phone Access subsystem. | ||
- | In offline mode, none of the radios must be active. The | + | In offline mode, none of the radios must be active. The Device System Management Entity (DSME) of maemo provides information about the transitions to and from the offline mode. |
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! Connectivity UI | |
- | + | |- | |
- | + | | Purpose | |
- | + | | Provides the UI for managing phone and Internet connections. Available as a Control Panel applet, and from the Status Bar. | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Displaying active connections with statistics | ||
+ | * Updating status indicators | ||
+ | * Providing dialogs for changing and disconnecting connections | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | (N/A) | ||
+ | |} | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! Phone Access | |
- | + | |- | |
- | + | | Purpose | |
- | + | | Provides connections to phones with different Bluetooth profiles | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Searching for phones and inquiring their services | ||
+ | * Keeping phone register | ||
+ | * Providing status of the phone connections for Connectivity UI | ||
+ | * Binding RFCOMM devices to Bluetooth services on the phone | ||
+ | * Providing easy access to OpenOBEX | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | Number of clients not limited by Maemo. However, some phones may not support more than one Bluetooth profile at a time. | ||
+ | |} | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! Internet Access | |
- | + | |- | |
- | + | | Purpose | |
- | + | | Provides Internet connections over different bearers. | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Providing means for configuration and management of IAP settings | ||
+ | * Providing API for Internet connections over different bearers (e.g. WLAN, GPRS) | ||
+ | * Providing status of Internet connections for Connectivity UI | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | Number of clients not limited, but only one connection to the Internet can exist at any given time | ||
+ | |} | ||
Phone and Internet connections are quite different by nature and behavior. These are introduced in more detail in the following sections. | Phone and Internet connections are quite different by nature and behavior. These are introduced in more detail in the following sections. | ||
Line 57: | Line 83: | ||
Phone Access is the subsystem handling connections to a cellular phone. It offers a search utility for finding potential phones and inquiring the services they can offer. This is based on the standard Bluetooth service discovery mechanism. Phone Access also keeps a record of phones that have connected to the device in GConf, and provides a list of them for the user to choose from. Phone Access relies on the Linux Bluetooth implementation called BlueZ. BlueZ offers the Berkeley socket interface to the HCI and to the L2CAP protocol for the user space applications. | Phone Access is the subsystem handling connections to a cellular phone. It offers a search utility for finding potential phones and inquiring the services they can offer. This is based on the standard Bluetooth service discovery mechanism. Phone Access also keeps a record of phones that have connected to the device in GConf, and provides a list of them for the user to choose from. Phone Access relies on the Linux Bluetooth implementation called BlueZ. BlueZ offers the Berkeley socket interface to the HCI and to the L2CAP protocol for the user space applications. | ||
- | In principle, any cellular phone supporting Bluetooth Service Discovery Protocol (SDP) and File Transfer Profile (FTP) can connect to | + | In principle, any cellular phone supporting Bluetooth Service Discovery Protocol (SDP) and File Transfer Profile (FTP) can connect to maemo. However, different mobile phones implement varying levels of file transfer services and OBEX. Some products limit access to the Inbox (Object Push), whereas more sophisticated ones make the Gallery and the memory card available. The recent products support the OBEX Capability request for retrieving more specific information about the file system on the phone. |
Maemo connects to a phone on an on-demand basis, such as when an application requires a connection. For example, when the Internet browser is about to open a URL, it requests Phone Access to establish a connection to the phone. This causes Phone Access to bind an RFCOMM device to the requested service on the phone. In a similar fashion, the File Selector can set up a file transfer connection to the phone using another RFCOMM device. After binding to a service, the application in question can open the local RFCOMM device. Normal file selector access is performed with GnomeVFS layer to get transparent access to phone in the same way as internal flash and MMC are accessed. | Maemo connects to a phone on an on-demand basis, such as when an application requires a connection. For example, when the Internet browser is about to open a URL, it requests Phone Access to establish a connection to the phone. This causes Phone Access to bind an RFCOMM device to the requested service on the phone. In a similar fashion, the File Selector can set up a file transfer connection to the phone using another RFCOMM device. After binding to a service, the application in question can open the local RFCOMM device. Normal file selector access is performed with GnomeVFS layer to get transparent access to phone in the same way as internal flash and MMC are accessed. | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! General Bluetooth UI | |
- | + | |- | |
- | + | | Purpose | |
- | + | | User interface for managing all paired BT devices | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Keeping a list of all paired devices (not only phones) | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | N/A | ||
+ | |} | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | | BT search | |
- | + | |- | |
- | + | | Purpose | |
- | + | | Searches for available Bluetooth devices | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Bluetooth inquiry | ||
+ | * Checking on offline mode state | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | N/A | ||
+ | |} | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! BT service discovery | |
- | + | |- | |
- | + | | Purpose | |
- | + | | Checks if a found Bluetooth device is sufficient | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Bluetooth service discovery (SDP) | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | Not limited (but used by Phone selection UI and Phone connection daemon only) | ||
+ | |} | ||
+ | |||
+ | {| class="wikitable" | ||
+ | | Name | ||
+ | | GW OBEX library | ||
+ | |- | ||
+ | | Purpose | ||
+ | | Provides access to OpenOBEX library for the File selector (Gnome VFS) on a higher abstraction level than OpenOBEX itself supports | ||
+ | |- | ||
+ | | Responsibilities and additional requirements | ||
+ | | | ||
+ | * Handling OBEX requests | ||
+ | |- | ||
+ | | width="100" align="LEFT" valign="TOP" | Concurrent usage | ||
+ | | width="350" align="LEFT" valign="TOP" | Not limited | ||
+ | |} | ||
Maemo Bluetooth also supports HID (keyboard) and OPP (object push file transfer) profiles. | Maemo Bluetooth also supports HID (keyboard) and OPP (object push file transfer) profiles. | ||
Line 108: | Line 160: | ||
For Bluetooth connections, AT commands are applied to establish a PPP link to the cellular modem and the connection to the Internet. | For Bluetooth connections, AT commands are applied to establish a PPP link to the cellular modem and the connection to the Internet. | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! IC daemon | |
- | + | |- | |
- | + | | Purpose | |
- | + | | IC daemon establishes Internet connections over different bearers. | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Controlling that only one Internet connection (one active IAP) can exist at any given time | ||
+ | * Using WLAN or GPRS connection daemon for getting a network device and getting the connection authenticated | ||
+ | * Starting IP level services like PPP and DHCP | ||
+ | * Providing statistics about the usage of IAPs to any application | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | Has multiple clients and limits the connections to one at a time | ||
+ | |} | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! Internet Connectivity GUI | |
- | + | |- | |
- | + | | Purpose | |
- | + | | Has GUI applications for configuring Internet Access Points and WLAN settings. | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Providing the UI for configuring an IAP | ||
+ | * Providing the UI for WLAN settings | ||
+ | * Scanning for available WLAN networks (on request) | ||
+ | * Saving IAP and WLAN settings (excluding EAP settings) to GConf | ||
+ | * Opening up dialogs and displaying notifications | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | N/A | ||
+ | |} | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! WLAN connection daemon | |
- | + | |- | |
- | + | | Purpose | |
- | + | | Manages WLAN network connections | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Starting WLAN driver with the settings provided; stopping WLAN | ||
+ | * Requesting authentication when necessary | ||
+ | * Relaying WLAN IAP settings from IC daemon to WLAN drivers and authentication requests to EAP | ||
+ | * Relaying WLAN events from WLAN drivers | ||
+ | * Providing WLAN status information | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | Not limited | ||
+ | |} | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! EAP UI | |
- | + | |- | |
- | + | | Purpose | |
- | + | | User interface for EAP authentication | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Invoking a dialog for an authentication password | ||
+ | * Showing authentication status | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | N/A | ||
+ | |} | ||
- | + | {| class="wikitable" | |
- | + | ! Name | |
- | + | ! EAP | |
- | + | |- | |
- | + | | Purpose | |
- | + | | Provides WLAN security excluding basic WEP settings, which are in Wireless Extensions | |
- | + | |- | |
- | + | | Responsibilities and additional requirements | |
+ | | | ||
+ | * Taking care of the authentication process for the active IAP | ||
+ | * Delivering progress events to IC daemon | ||
+ | * As a special case, controlling the EAP-SIM authentication using the SIM Access Profile | ||
+ | * Providing authentication status | ||
+ | |- | ||
+ | | Concurrent usage | ||
+ | | N/A | ||
+ | |} | ||
==Internet Connectivity Daemon == | ==Internet Connectivity Daemon == | ||
Line 175: | Line 272: | ||
* Ensure that the user is aware of updates and can see the time when the data was last updated. | * Ensure that the user is aware of updates and can see the time when the data was last updated. | ||
* Ensure that the application registers via LibConIC and listens to signals emitted by the ICd (Connection Created, Lost and Changed), and react as follows: | * Ensure that the application registers via LibConIC and listens to signals emitted by the ICd (Connection Created, Lost and Changed), and react as follows: | ||
- | ** '''Connection Created''': Use the connection and update all data. | + | ** '''Connection Created'''<nowiki>: Use the connection and update all data. </nowiki> |
- | ** '''Connection Lost''': Go to an idle state silently and wait until a new connection is created. | + | ** '''Connection Lost'''<nowiki>: Go to an idle state silently and wait until a new connection is created. </nowiki> |
- | ** '''Connection Changed''': Use the new connection. | + | ** '''Connection Changed'''<nowiki>: Use the new connection. </nowiki> |
* Ensure that automatic data updates run in background and silently: | * Ensure that automatic data updates run in background and silently: | ||
** Avoid alarming the user with unnecessary banners or dialogs. | ** Avoid alarming the user with unnecessary banners or dialogs. | ||
Line 215: | Line 312: | ||
# employ no threading support in the Libconic API | # employ no threading support in the Libconic API | ||
- | If the application is a standard Hildon application, almost all of these requirements are already fulfilled. LibOSSO context initialization connects the application to both session and system D- | + | If the application is a standard Hildon application, almost all of these requirements are already fulfilled. LibOSSO context initialization connects the application to both session and system D-BUS buses, <code>g_type_init()</code> is called as a part of <code>gtk_init()</code>, and probably no extra threads are used. |
=== Non-Blocking Sockets === | === Non-Blocking Sockets === | ||
Line 235: | Line 332: | ||
=== No Multiple Threads === | === No Multiple Threads === | ||
- | Libconic API is not thread-safe. If the applications | + | Libconic API is not thread-safe. If the applications have threads, use Libconic API only from the same context where <code>GMainloop</code> is running. |
===Libconic Usage === | ===Libconic Usage === | ||
Line 241: | Line 338: | ||
==== Requesting for Connection ==== | ==== Requesting for Connection ==== | ||
- | + | Libconic is an asynchronous connection API, which heavily relies on <code>GObject</code> signals. Basically this means that <code>GMainloop</code> must be iterated in order to successfully execute connection requests. After the application is set up, use a <code>ConIcConnection</code> object to request a connection: | |
<source lang="c"> | <source lang="c"> | ||
Line 255: | Line 352: | ||
</source> | </source> | ||
- | At this point, the application does not yet have an Internet connection. A successful return from <code>con_ic_connection_connect()</code> means only that the request was successfully dispatched to the Internet Connectivity daemon. When the daemon has a connection ready, the application receives an | + | At this point, the application does not yet have an Internet connection. A successful return from <code>con_ic_connection_connect()</code> means only that the request was successfully dispatched to the Internet Connectivity daemon. When the daemon has a connection ready, the application receives an event (as an <code>GObject</code> signal) indicating that the device is connected. If the connection attempt fails, the application receives a disconnected event with an error describing the reason for the failure. |
The connection handler (<code>my_connection_handler()</code> function registered in the previous snippet) could look like this: | The connection handler (<code>my_connection_handler()</code> function registered in the previous snippet) could look like this: | ||
Line 369: | Line 466: | ||
==== Getting Proxy Settings ==== | ==== Getting Proxy Settings ==== | ||
+ | Libconic allows you to set up Internet connection proxy settings for various protocols. The first step is to discover the current proxy mode by using the ''con_ic_connection_get_proxy_mode()'' function. Next, use the following functions to get the actual proxy settings: | ||
- | + | * If proxy mode is CON_IC_PROXY_MODE_NONE, do not use any proxies. | |
+ | * If proxy mode is CON_IC_PROXY_MODE_MANUAL, use the following functions to query proxy settings: | ||
+ | ** con_ic_connection_get_proxy_host() to get the proxy host | ||
+ | ** con_ic_connection_get_proxy_port() to get the proxy port | ||
+ | ** con_ic_connection_get_proxy_ignore_hosts() to get a list of hosts for which the proxy should not be used. | ||
+ | * If proxy mode is CON_IC_PROXY_MODE_AUTO, use <br /> con_ic_connection_get_proxy_autoconfig_url() to get a proxy auto configuration URL. | ||
+ | ** Use of auto configuration URL is explained in [http://en.wikipedia.org/wiki/Proxy_auto-config Wikipedia] | ||
- | + | In this example, the "connection-event" handler is modified to print HTTP proxy settings when establishing connection: | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">my_connection_handler</font></span>'''</span><span><font color="#990000">(</font></span>ConIcConnection <span><font color="#990000"><nowiki>*</nowiki></font></span>connection<span><font color="#990000">,</font></span> | |
+ | ConIcConnectionEvent <span><font color="#990000"><nowiki>*</nowiki></font></span>event<span><font color="#990000">,</font></span> | ||
+ | gpointer user_data<span><font color="#990000">)</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | ConIcConnectionStatus status <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">con_ic_connection_event_get_status</font></span>'''</span><span><font color="#990000">(</font></span>event<span><font color="#990000">);</font></span> | ||
+ | GSList <span><font color="#990000"><nowiki>*</nowiki></font></span>ignore_hosts<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>status <span><font color="#990000"><nowiki>==</nowiki></font></span> CON_IC_STATUS_CONNECTED<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000000">g_debug</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"We are connected! \</font></span> | ||
+ | <span><font color="#FF0000">Let's see what kind of settings we have for HTTP proxy..."</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* Do things based on specified proxy mode */</font></span>''</span> | ||
+ | <span>'''<span><font color="#0000FF">switch</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">con_ic_connection_get_proxy_mode</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">))</font></span> <span><font color="#FF0000">{</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">case</font></span>'''</span> CON_IC_PROXY_MODE_NONE<span><font color="#990000"><nowiki>:</nowiki></font></span> | ||
+ | <span>'''<span><font color="#000000">g_debug</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"No proxies defined, it is direct connection"</font></span><span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">break</font></span>'''</span><span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">case</font></span>'''</span> CON_IC_PROXY_MODE_MANUAL<span><font color="#990000"><nowiki>:</nowiki></font></span> | ||
+ | <span>'''<span><font color="#000000">g_debug</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"HTTP proxy %s:%d in use"</font></span><span><font color="#990000">,</font></span> | ||
+ | <span>'''<span><font color="#000000">con_ic_connection_get_proxy_host</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">,</font></span> CON_IC_PROXY_PROTOCOL_HTTP<span><font color="#990000">),</font></span> | ||
+ | <span>'''<span><font color="#000000">con_ic_connection_get_proxy_port</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">,</font></span> CON_IC_PROXY_PROTOCOL_HTTP<span><font color="#990000">));</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">g_debug</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"List of hosts, for which proxy should not be used:"</font></span><span><font color="#990000">);</font></span> | ||
+ | ignore_hosts <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">con_ic_connection_proxy_ignore_hosts</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">for</font></span>'''</span> <span><font color="#990000">(</font></span>GSList <span><font color="#990000"><nowiki>*</nowiki></font></span>iter <span><font color="#990000"><nowiki>=</nowiki></font></span> ignore_hosts<span><font color="#990000"><nowiki>;</nowiki></font></span> iter <span><font color="#990000"><nowiki>!=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> iter <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">g_slist_next</font></span>'''</span><span><font color="#990000">(</font></span>iter<span><font color="#990000">))</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000000">g_debug</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"%s"</font></span><span><font color="#990000">,</font></span> <span><font color="#990000">(</font></span>gchar <span><font color="#990000"><nowiki>*)</nowiki></font></span>iter<span><font color="#990000">-></font></span>data<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_free</font></span>'''</span><span><font color="#990000">(</font></span>iter<span><font color="#990000">-></font></span>data<span><font color="#990000">);</font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | <span>'''<span><font color="#000000">g_slist_free</font></span>'''</span><span><font color="#990000">(</font></span>ignore_hosts<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">break</font></span>'''</span><span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">case</font></span>'''</span> CON_IC_PROXY_MODE_AUTO<span><font color="#990000"><nowiki>:</nowiki></font></span> | ||
+ | <span>'''<span><font color="#000000">g_debug</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"Proxy auto-config URL %s should be used"</font></span><span><font color="#990000">,</font></span> | ||
+ | <span>'''<span><font color="#000000">con_ic_connection_get_proxy_autoconfig_url</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">));</font></span> | ||
+ | <span>'''<span><font color="#0000FF">break</font></span>'''</span><span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | <span><font color="#FF0000">}</font></span></tt> | ||
- | + | Proxy functions also exist for each individual protocol (like <br />''con_ic_connection_get_proxy_ftp_host()''), but these functions are deprecated. Avoid them in newly-written code. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | Proxy functions also exist for each individual protocol (like < | + | |
====Getting List of User-Saved Connections ==== | ====Getting List of User-Saved Connections ==== | ||
+ | To query all user-saved connections (IAPs), use the ''con_ic_connection_get_all_iaps()'' function. The function returns simply a singly linked list of ConIcIap objects: | ||
- | + | <tt> <span>''<span><font color="#9A1900">/* ConIcConnection object named "connection" has already been created */</font></span>''</span> | |
+ | GSList <span><font color="#990000"><nowiki>*</nowiki></font></span>saved_iaps <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">con_ic_connection_get_all_iaps</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_debug</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"The following connections have been saved by the user:"</font></span><span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">for</font></span>'''</span> <span><font color="#990000">(</font></span>GSList <span><font color="#990000"><nowiki>*</nowiki></font></span>iter <span><font color="#990000"><nowiki>=</nowiki></font></span> saved_iaps<span><font color="#990000"><nowiki>;</nowiki></font></span> iter <span><font color="#990000"><nowiki>!=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> iter <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">g_slist_next</font></span>'''</span><span><font color="#990000">(</font></span>iter<span><font color="#990000">))</font></span> <span><font color="#FF0000">{</font></span> | ||
+ | <span>''<span><font color="#9A1900">/* Get IAP object and print some information about it */</font></span>''</span> | ||
+ | ConIcIap <span><font color="#990000"><nowiki>*</nowiki></font></span>iap <span><font color="#990000"><nowiki>=</nowiki></font></span> <span><font color="#990000">(</font></span>ConIcIap <span><font color="#990000"><nowiki>*)</nowiki></font></span>iter<span><font color="#990000">-></font></span>data<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span>'''<span><font color="#000000">g_debug</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"Connection %s called '%s' using bearer %s"</font></span><span><font color="#990000">,</font></span> | ||
+ | <span>'''<span><font color="#000000">con_ic_iap_get_id</font></span>'''</span><span><font color="#990000">(</font></span>iap<span><font color="#990000">),</font></span> <span>'''<span><font color="#000000">con_ic_iap_get_name</font></span>'''</span><span><font color="#990000">(</font></span>iap<span><font color="#990000">),</font></span> | ||
+ | <span>'''<span><font color="#000000">con_ic_iap_get_bearer_type</font></span>'''</span><span><font color="#990000">(</font></span>iap<span><font color="#990000">));</font></span> | ||
+ | <span>''<span><font color="#9A1900">/* We unref the IAP object as we are not going to use it anymore */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000000">g_object_unref</font></span>'''</span><span><font color="#990000">(</font></span>iap<span><font color="#990000">);</font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | <span>'''<span><font color="#000000">g_slist_free</font></span>'''</span><span><font color="#990000">(</font></span>saved_iaps<span><font color="#990000">);</font></span></tt> | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
==== Porting Application from OSSO IC API to Libconic ==== | ==== Porting Application from OSSO IC API to Libconic ==== | ||
- | + | * If the application does not have GType, GLib or D-BUS configured, set them up: | |
- | * If the application does not have | + | <tt> DBusConnection <span><font color="#990000"><nowiki>*</nowiki></font></span>system_dbus<span><font color="#990000"><nowiki>;</nowiki></font></span> |
- | + | GMainLoop <span><font color="#990000"><nowiki>*</nowiki></font></span>main_loop<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | < | + | <span>'''<span><font color="#000000">g_type_init</font></span>'''</span><span><font color="#990000">();</font></span> |
- | + | main_loop <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">g_main_loop_new</font></span>'''</span><span><font color="#990000">(</font></span>NULL<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">);</font></span> | |
- | + | system_dbus <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">dbus_bus_get</font></span>'''</span><span><font color="#990000">(</font></span>DBUS_BUS_SYSTEM<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">dbus_connection_setup_with_g_main</font></span>'''</span><span><font color="#990000">(</font></span>system_dbus<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span></tt> | |
- | + | ||
- | + | ||
- | + | ||
- | </ | + | |
- | + | ||
* Include the correct header file: | * Include the correct header file: | ||
- | + | <tt><span>'''<span><font color="#000080"> #include</font></span>'''</span> <span><font color="#FF0000"><osso-ic.h></font></span> | |
- | < | + | <span><font color="#990000"><nowiki>===></nowiki></font></span> |
- | + | <span>'''<span><font color="#000080"> #include</font></span>'''</span> <span><font color="#FF0000"><conic.h></font></span></tt> | |
- | + | * Set up ''ConIcConnection'' object and "connection-event" handler instead of ''osso_iap_cb_t'' callback: | |
- | + | <tt> <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">my_connection_cb</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#0000FF">struct</font></span>'''</span> <span><font color="#009900">iap_event_t</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>event<span><font color="#990000">,</font></span> <span><font color="#009900">void</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>arg<span><font color="#990000">)</font></span> | |
- | </ | + | <span><font color="#FF0000">{</font></span> |
- | + | <span>''<span><font color="#9A1900">/* ... */</font></span>''</span> | |
- | * Set up | + | <span><font color="#FF0000">}</font></span> |
- | + | <span>''<span><font color="#9A1900">/* ... */</font></span>''</span> | |
- | < | + | <span>'''<span><font color="#000000">osso_iap_cb</font></span>'''</span><span><font color="#990000">(</font></span>my_connection_cb<span><font color="#990000">);</font></span> |
- | + | <span><font color="#990000"><nowiki>===></nowiki></font></span> | |
- | + | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">my_connection_cb</font></span>'''</span><span><font color="#990000">(</font></span>ConIcConnection <span><font color="#990000"><nowiki>*</nowiki></font></span>connection<span><font color="#990000">,</font></span> | |
- | + | ConIcConnectionEvent <span><font color="#990000"><nowiki>*</nowiki></font></span>event<span><font color="#990000">,</font></span> | |
- | + | gpointer user_data<span><font color="#990000">)</font></span> | |
- | + | <span><font color="#FF0000">{</font></span> | |
- | + | <span>''<span><font color="#9A1900">/* ... */</font></span>''</span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | + | <span>''<span><font color="#9A1900">/* ... */</font></span>''</span> | |
- | + | ConIcConnection <span><font color="#990000"><nowiki>*</nowiki></font></span>connection <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">con_ic_connection_new</font></span>'''</span><span><font color="#990000">();</font></span> | |
- | + | <span>'''<span><font color="#000000">g_signal_connect</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">),</font></span> <span><font color="#FF0000">"connection-event"</font></span><span><font color="#990000">,</font></span> | |
- | + | <span>'''<span><font color="#000000">G_CALLBACK</font></span>'''</span><span><font color="#990000">(</font></span>my_connection_cb<span><font color="#990000">),</font></span> app_data<span><font color="#990000">);</font></span></tt> | |
- | + | * Manage connections through ''ConIcConnection'' API instead of <br />''osso_iap_connect()'' and ''osso_iap_disconnect()''<nowiki>: </nowiki> | |
- | + | <tt> <span>'''<span><font color="#000000">osso_iap_connect</font></span>'''</span><span><font color="#990000">(</font></span>OSSO_IAP_ANY<span><font color="#990000">,</font></span> OSSO_IAP_REQUESTED_CONNECT<span><font color="#990000">,</font></span> app_data<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">osso_iap_disconnect</font></span>'''</span><span><font color="#990000">(</font></span>iap_name<span><font color="#990000">,</font></span> app_data<span><font color="#990000">);</font></span> | |
- | + | <span><font color="#990000"><nowiki>===></nowiki></font></span> | |
- | + | <span>'''<span><font color="#000000">con_ic_connection_connect</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">,</font></span> CON_IC_CONNECT_FLAG_NONE<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">con_ic_connection_disconnect</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">);</font></span></tt> | |
- | </ | + | * Request statistics with ''con_ic_connection_statistics()'' instead of <br />''osso_iap_get_statistics()''. |
- | + | * List all available IAPs with ''con_ic_connection_get_all_iaps()'' instead of <br />''osso_iap_get_configured_iaps()''. | |
- | + | ||
- | * List all available IAPs with | + | |
* Configure autoconf to use Libconic instead of OSSO IC API: | * Configure autoconf to use Libconic instead of OSSO IC API: | ||
- | < | + | <tt> PKG_CHECK_MODULES<span><font color="#990000">(</font></span>OSSOIC<span><font color="#990000">,</font></span> osso-ic<span><font color="#990000">)</font></span> |
- | + | AC_SUBST<span><font color="#990000">(</font></span>OSSOIC_CFLAGS<span><font color="#990000">)</font></span> | |
- | AC_SUBST(OSSOIC_CFLAGS) | + | AC_SUBST<span><font color="#990000">(</font></span>OSSOIC_LIBS<span><font color="#990000">)</font></span> |
- | AC_SUBST(OSSOIC_LIBS) | + | <span><font color="#990000"><nowiki>===></nowiki></font></span> |
- | # | + | PKG_CHECK_MODULES<span><font color="#990000">(</font></span>CONIC<span><font color="#990000">,</font></span> conic<span><font color="#990000">)</font></span> |
- | PKG_CHECK_MODULES(CONIC, conic) | + | AC_SUBST<span><font color="#990000">(</font></span>CONIC_CFLAGS<span><font color="#990000">)</font></span> |
- | AC_SUBST(CONIC_CFLAGS) | + | AC_SUBST<span><font color="#990000">(</font></span>CONIC_LIBS<span><font color="#990000">)</font></span></tt> |
- | AC_SUBST(CONIC_LIBS) | + | * In debian/control file "Build-Depends" section, depend on libconic0-dev instead of osso-ic-dev. |
- | </ | + | |
- | * In | + | |
==Bluetooth Libraries == | ==Bluetooth Libraries == | ||
+ | This section explains how maemo Bluetooth libraries work internally. The following subsections explain the behavior and the decomposition of the Bluetooth library components in detail. | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
=== Libgwobex === | === Libgwobex === | ||
- | + | Libgwobex provides access to libopenobex functionality by providing a <br /> helper/wrapper interface. Libopenobex is explained in detail in the following section. | |
- | Libgwobex provides access to libopenobex functionality by providing a helper/wrapper interface. Libopenobex is explained in detail in the following section. | + | |
The interface to libgwobex is available at [http://maemo.org/api_refs/5.0/5.0-final/osso-gwobex/ GW OBEX Library Documentation]. | The interface to libgwobex is available at [http://maemo.org/api_refs/5.0/5.0-final/osso-gwobex/ GW OBEX Library Documentation]. | ||
===Creating Connection === | ===Creating Connection === | ||
+ | The connection with libgwobex is established using the gw_obex_setup_dev function, setting up the connection. gw-obex.h | ||
- | + | <tt><span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> OBEX_FTP_UUID <span><font color="#990000">\</font></span> | |
+ | <span><font color="#FF0000">"</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">F9</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">EC</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">7B</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">C4</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">95</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">3C</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">11</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">D2</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">98</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">4E</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">52</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">54</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">00</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">DC</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">9E</font></span><span><font color="#CC33CC">\x</font></span><span><font color="#FF0000">09"</font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> OBEX_FTP_UUID_LEN <span><font color="#993399">16</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* ... */</font></span>''</span> | ||
+ | |||
+ | GwObex<span><font color="#990000"><nowiki>*</nowiki></font></span> <span>'''<span><font color="#000000">gw_obex_setup_dev</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#0000FF">const</font></span>'''</span> gchar <span><font color="#990000"><nowiki>*</nowiki></font></span> device<span><font color="#990000">,</font></span> <span>'''<span><font color="#0000FF">const</font></span>'''</span> gchar <span><font color="#990000"><nowiki>*</nowiki></font></span> uuid<span><font color="#990000">,</font></span> gint uuid_len<span><font color="#990000">,</font></span> | ||
+ | GMainContext <span><font color="#990000"><nowiki>*</nowiki></font></span> context<span><font color="#990000">,</font></span> gint <span><font color="#990000"><nowiki>*</nowiki></font></span> error <span><font color="#990000">)</font></span></tt> | ||
- | + | The following code snippet illustrates how to open a handle using gw_obex_setup_dev. | |
- | + | ||
- | + | ||
- | + | ||
- | / | + | <tt><span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>rfcomm_dev<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> |
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>use_ftp<span><font color="#990000">)</font></span> | ||
+ | ctx<span><font color="#990000">-></font></span>obex <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gw_obex_setup_dev</font></span>'''</span><span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>rfcomm_dev<span><font color="#990000">,</font></span> | ||
+ | OBEX_FTP_UUID<span><font color="#990000">,</font></span> OBEX_FTP_UUID_LEN<span><font color="#990000">,</font></span> | ||
+ | NULL<span><font color="#990000">,</font></span> <span><font color="#990000">&</font></span>err<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">else</font></span>'''</span> | ||
+ | ctx<span><font color="#990000">-></font></span>obex <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gw_obex_setup_dev</font></span>'''</span><span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>rfcomm_dev<span><font color="#990000">,</font></span> NULL<span><font color="#990000">,</font></span> | ||
+ | <span><font color="#993399">0</font></span><span><font color="#990000">,</font></span> NULL<span><font color="#990000">,</font></span> <span><font color="#990000">&</font></span>err<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>obex <span><font color="#990000"><nowiki>==</nowiki></font></span> NULL<span><font color="#990000">)</font></span> | ||
+ | <span>'''<span><font color="#000000">printf</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"OBEX setup failed: %s</font></span><span><font color="#CC33CC">\n</font></span><span><font color="#FF0000">"</font></span><span><font color="#990000">,</font></span> <span>'''<span><font color="#000000">response_to_string</font></span>'''</span><span><font color="#990000">(</font></span>err<span><font color="#990000">));</font></span> | ||
+ | <span><font color="#FF0000">}</font></span></tt> | ||
- | + | In this example, ctx->rfcomm_dev points to a string containing the device node name (e.g. /dev/rfcomm0). ctx->use_ftp dictates whether to set up standard folder browsing services. If use_ftp is untrue, then INBOX is connected. | |
- | + | ||
- | + | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
===Closing Connection === | ===Closing Connection === | ||
- | |||
To close a gwobex connection, use the following function: gw-obex.h | To close a gwobex connection, use the following function: gw-obex.h | ||
- | < | + | <tt><span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">gw_obex_close</font></span>'''</span> <span><font color="#990000">(</font></span> GwObex <span><font color="#990000"><nowiki>*</nowiki></font></span> ctx <span><font color="#990000">);</font></span></tt> |
- | void gw_obex_close ( GwObex * ctx ); | + | |
- | </ | + | |
The following code demonstrates this usage. | The following code demonstrates this usage. | ||
- | < | + | <tt><span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>obex<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> |
- | if (ctx->obex) { | + | <span>'''<span><font color="#000000">gw_obex_close</font></span>'''</span><span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>obex<span><font color="#990000">);</font></span> |
- | + | ctx<span><font color="#990000">-></font></span>obex <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span><font color="#FF0000">}</font></span></tt> | |
- | } | + | |
- | </ | + | If ctx->obex is not NULL, it is simply passed as an argument to gw_obex_close(). |
- | |||
===Using Connection === | ===Using Connection === | ||
- | |||
The libgwobex library provides general file handling functionality, including reading directory structure, browsing in different folders and getting files. | The libgwobex library provides general file handling functionality, including reading directory structure, browsing in different folders and getting files. | ||
To read entries from an opened directory, use the following function: gw-obex.h | To read entries from an opened directory, use the following function: gw-obex.h | ||
- | < | + | <tt>gboolean <span>'''<span><font color="#000000">gw_obex_read_dir</font></span>'''</span> <span><font color="#990000">(</font></span>GwObex <span><font color="#990000"><nowiki>*</nowiki></font></span> ctx<span><font color="#990000">,</font></span> |
- | + | <span>'''<span><font color="#0000FF">const</font></span>'''</span> gchar <span><font color="#990000"><nowiki>*</nowiki></font></span> dir<span><font color="#990000">,</font></span> | |
- | + | gchar <span><font color="#990000"><nowiki>**</nowiki></font></span> buf<span><font color="#990000">,</font></span> | |
- | + | gint <span><font color="#990000"><nowiki>*</nowiki></font></span> buf_size<span><font color="#990000">,</font></span> | |
- | + | gint <span><font color="#990000"><nowiki>*</nowiki></font></span> error <span><font color="#990000">);</font></span></tt> | |
- | + | ||
- | </ | + | |
- | + | gw_obex_read_dir reads an entry from the selected folder and returns the result in the buf argument given to the function. | |
- | < | + | <tt>gboolean ret<span><font color="#990000"><nowiki>;</nowiki></font></span> |
- | + | <span>''<span><font color="#9A1900">/* ... */</font></span>''</span> | |
- | /* ... */ | + | ret <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gw_obex_read_dir</font></span>'''</span><span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>obex<span><font color="#990000">,</font></span> dir<span><font color="#990000">,</font></span> buf<span><font color="#990000">,</font></span> buf_size<span><font color="#990000">,</font></span> err<span><font color="#990000">);</font></span></tt> |
- | ret = gw_obex_read_dir(ctx->obex, dir, buf, buf_size, err); | + | |
- | </ | + | |
- | This reads an entry from the directory | + | This reads an entry from the directory dir (char *) and returns it in buf (char **). |
To change the current directory, use the following function: gw-obex.h | To change the current directory, use the following function: gw-obex.h | ||
- | < | + | <tt>gboolean <span>'''<span><font color="#000000">gw_obex_chdir</font></span>'''</span> <span><font color="#990000">(</font></span>GwObex <span><font color="#990000"><nowiki>*</nowiki></font></span> ctx<span><font color="#990000">,</font></span> <span>'''<span><font color="#0000FF">const</font></span>'''</span> gchar <span><font color="#990000"><nowiki>*</nowiki></font></span> dir<span><font color="#990000">,</font></span> gint <span><font color="#990000"><nowiki>*</nowiki></font></span> error <span><font color="#990000">);</font></span></tt> |
- | + | ||
- | </ | + | |
which changes the directory of the FTP connection. Below is a code example using this function. | which changes the directory of the FTP connection. Below is a code example using this function. | ||
- | < | + | <tt><span>''<span><font color="#9A1900">/* Ignore parent dir pointers */</font></span>''</span> |
- | /* Ignore parent dir pointers */ | + | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">g_str_equal</font></span>'''</span><span><font color="#990000">(</font></span>name<span><font color="#990000">,</font></span> <span><font color="#FF0000">".."</font></span><span><font color="#990000">))</font></span> |
- | if (g_str_equal(name, "..")) | + | <span>'''<span><font color="#0000FF">return</font></span>'''</span> TRUE<span><font color="#990000"><nowiki>;</nowiki></font></span> |
- | + | ||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(!</font></span><span>'''<span><font color="#000000">gw_obex_chdir</font></span>'''</span><span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>obex<span><font color="#990000">,</font></span> name<span><font color="#990000">,</font></span> err<span><font color="#990000">))</font></span> <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000000">printf</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"Could not chdir to %s</font></span><span><font color="#CC33CC">\n</font></span><span><font color="#FF0000">"</font></span><span><font color="#990000">,</font></span> name<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> FALSE<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span></tt> | ||
- | + | To retrieve files over the OBEX connection, use the gw_obex_get_file function: gw-obex.h | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | <tt>gboolean <span>'''<span><font color="#000000">gw_obex_get_file</font></span>'''</span> <span><font color="#990000">(</font></span>GwObex <span><font color="#990000"><nowiki>*</nowiki></font></span> ctx<span><font color="#990000">,</font></span> | |
+ | <span>'''<span><font color="#0000FF">const</font></span>'''</span> gchar <span><font color="#990000"><nowiki>*</nowiki></font></span> local<span><font color="#990000">,</font></span> | ||
+ | <span>'''<span><font color="#0000FF">const</font></span>'''</span> gchar <span><font color="#990000"><nowiki>*</nowiki></font></span> remote<span><font color="#990000">,</font></span> | ||
+ | <span>'''<span><font color="#0000FF">const</font></span>'''</span> gchar <span><font color="#990000"><nowiki>*</nowiki></font></span> type<span><font color="#990000">,</font></span> | ||
+ | gint <span><font color="#990000"><nowiki>*</nowiki></font></span> error<span><font color="#990000">);</font></span> | ||
+ | </tt> | ||
- | + | gw_obex_get_file uses the ctx context for retrieving the remote file to local file. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | < | + | <tt>gboolean ret<span><font color="#990000"><nowiki>;</nowiki></font></span> |
- | + | ret <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gw_obex_get_file</font></span>'''</span><span><font color="#990000">(</font></span>ctx<span><font color="#990000">-></font></span>obex<span><font color="#990000">,</font></span> name<span><font color="#990000">,</font></span> name<span><font color="#990000">,</font></span> err<span><font color="#990000">);</font></span></tt> | |
- | < | + | |
- | + | ||
- | + | ||
- | </ | + | |
Using the libwobex wrapper directly allows you to perform many more functions. For more information, see the [http://maemo.org/api_refs/5.0/5.0-final/osso-gwobex/ API document]. | Using the libwobex wrapper directly allows you to perform many more functions. For more information, see the [http://maemo.org/api_refs/5.0/5.0-final/osso-gwobex/ API document]. | ||
===Libopenobex === | ===Libopenobex === | ||
- | + | The LibOpenOBEX library implements a generic OBEX Session Protocol, but not the OBEX Application Framework. OBEX is a protocol designed to allow data interchanging between different kinds of connections (e.g. Bluetooth, IrDA). For more information on the OBEX protocol, see [http://www.irda.org/ http://www.irda.org]<nowiki>; select the Developer->Specifications category. OBEX resembles the HTTP protocol, expect for a few differences: </nowiki> | |
- | The LibOpenOBEX library implements a generic OBEX Session Protocol, but not the OBEX Application Framework. OBEX is a protocol designed to allow data interchanging between different kinds of connections (e.g. Bluetooth, IrDA). For more information on the OBEX protocol, see [http://www.irda.org/ http://www.irda.org]; select the Developer->Specifications category. OBEX resembles the HTTP protocol, expect for a few differences: | + | |
* Transports: While HTTP is normally layered above a TCP/IP connection, OBEX is usually transported over IrLAP/IrLMP/Tiny TP (on IrDA) or over Baseband/Link Manager/L2CAP/RFCOMM (on Bluetooth). | * Transports: While HTTP is normally layered above a TCP/IP connection, OBEX is usually transported over IrLAP/IrLMP/Tiny TP (on IrDA) or over Baseband/Link Manager/L2CAP/RFCOMM (on Bluetooth). | ||
Line 840: | Line 698: | ||
* Session support: HTTP is stateless, while OBEX maintains the connection. | * Session support: HTTP is stateless, while OBEX maintains the connection. | ||
- | For more information on OBEX, see the summary available at | + | For more information on OBEX, see the summary available at <br />http://en.wikipedia.org/wiki/OBEX. |
- | For libopenobex code samples, see http://openobex.triq.net/downloads the samples are in the example apps package. | + | For libopenobex code samples, see <br />http://openobex.triq.net/downloads<nowiki>; the samples are in the example apps package. </nowiki> |
- | |||
+ | ===Using BlueZ D-Bus API === | ||
The BlueZ system exports a D-Bus API that can be employed instead of OSSO Bluetooth tools. See the following documents: | The BlueZ system exports a D-Bus API that can be employed instead of OSSO Bluetooth tools. See the following documents: | ||
Line 853: | Line 711: | ||
===UI Components === | ===UI Components === | ||
- | |||
Connectivity UI contains various dialogs and other components used to control the connectivity. The different UI parts are: | Connectivity UI contains various dialogs and other components used to control the connectivity. The different UI parts are: | ||
Line 862: | Line 719: | ||
* Bluetooth UIs | * Bluetooth UIs | ||
- | The connectivity dialogs are invoked by D-Bus method calls, so for example the ICd is using these D-Bus method calls for showing dialogs when they are needed. The next section specifies the D-Bus API of | + | The connectivity dialogs are invoked by D-Bus method calls, so for example the ICd is using these D-Bus method calls for showing dialogs when they are needed. The next section specifies the D-Bus API of maemo connectivity UI. |
- | |||
+ | ===D-Bus Connectivity UI Interface === | ||
If the user must provide information about the IAP that the system is about to connect to, you can use the following method: | If the user must provide information about the IAP that the system is about to connect to, you can use the following method: | ||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Service: com.nokia.icd_ui | ||
+ | Interfaces: com.nokia.icd_ui | ||
+ | Object paths: /com/nokia/icd_ui | ||
- | + | </div> | |
- | |||
- | + | The Internet Connectivity UIs implement the following D-Bus API used by the ICd and EAP. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Method: show_conn_dlg | ||
+ | Parameters: 1. boolean When TRUE the dialog is requested because | ||
+ | there were no saved connections (i.e. auto | ||
+ | connect was tried before invoking the dialog) | ||
+ | Return parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | Description: Shows the Connect Dialog where the user can choose an IAP. | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Method: show_disconnect_dlg | ||
+ | Parameters: none | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows the disconnect dialog. | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Method: show_retry_dlg | ||
+ | Parameters: 1. string Bluetooth address of the device used with SAP | ||
+ | 2. string Name of the connection attempt error which | ||
+ | selects the retry dialog type. | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows the retry dialog. | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Method: show_change_dlg | ||
+ | Parameters: 1. string Name of the currently active IAP | ||
+ | 2. string Name of the IAP to be activated | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows the Change IAP Dialog | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Method: show_passwd_dlg | ||
+ | Parameters: 1. string Username supplied by ICd | ||
+ | 2. string Password supplied by ICd | ||
+ | 3. string Name of the IAP | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows the username/password dialog. | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | < | + | <div class="graybox"> |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Method: show_gtc_dlg | ||
+ | Parameters: 1. string GTC challenge string | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows EAP GTC challenge dialog. | ||
- | + | </div> | |
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
+ | |||
+ | Method: show_mschap_change_dlg | ||
+ | Parameters: 1. string Supplied username | ||
+ | 2. string Old password that is to be changed | ||
+ | 3. string Name of the IAP | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows EAP MSCHAPv2 change password dialog. | ||
- | + | </div> | |
- | |||
- | |||
- | |||
- | |||
- | = | + | <div class="graybox"> |
- | + | ||
- | : | + | Method: show_private_key_passwd_dlg |
- | + | Parameters: 1. byte array Certificate ID | |
- | : | + | |
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows EAP private key password dialog | ||
- | + | </div> | |
- | |||
- | |||
- | |||
- | |||
+ | <div class="graybox"> | ||
- | + | ||
+ | Method: show_server_cert_dlg | ||
+ | Parameters: 1. string Certificate name | ||
+ | 2. string Certificate serial | ||
+ | 3. boolean TRUE if certificate is expired, FALSE otherwise | ||
+ | 4. boolean TRUE if root CA is unknown or self-signed | ||
+ | certificate, FALSE otherwise | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows server certificate error and expiration dialogs. | ||
+ | If both boolean arguments are false, the error dialog is | ||
+ | shown. If either or both boolean arguments are TRUE, the | ||
+ | expiration dialog is shown instead. | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Method: strong_bt_req | ||
+ | Parameters: 1. string Bluetooth address of the device to pair with | ||
+ | 2. boolean TRUE if strong authentication enabled, FALSE | ||
+ | if strong authentication is disabled | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Requests strong (16 digit) BT PIN dialog for a BT device | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Method: show_sim_pin_dlg | ||
+ | Parameters: 1. string Bluetooth address of the device used with SAP | ||
+ | 2. boolean TRUE if PIN was incorrect and retry dialog | ||
+ | should be displayed before asking PIN. FALSE | ||
+ | if this is the first PIN request. | ||
+ | |||
+ | Return Parameters: none | ||
+ | Errors: com.nokia.icd_ui.error.flight_mode: | ||
+ | Flight mode enabled, dialog not shown | ||
+ | |||
+ | Description: Shows SIM PIN dialog | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | |||
- | + | The code example for the application to show the connect dialog using show_conn_dlg is following. Note the use of the macro. | |
- | + | ||
- | + | ||
- | + | ||
- | == | + | <tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><osso-ic-ui-dbus.h></font></span> |
+ | <span>''<span><font color="#9A1900">/* ... */</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900">/* in our code somewhere, where we need the Connect Dialog*/</font></span>''</span> | ||
+ | DBusMessage <span><font color="#990000"><nowiki>*</nowiki></font></span>uimsg<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span>''<span><font color="#9A1900">/* construct the message for Connect Dialog request*/</font></span>''</span> | ||
+ | uimsg <span><font color="#990000"><nowiki>=</nowiki></font></span> | ||
+ | <span>'''<span><font color="#000000">dbus_message_new_method_call</font></span>'''</span><span><font color="#990000">(</font></span>ICD_UI_DBUS_SERVICE<span><font color="#990000">,</font></span> | ||
+ | ICD_UI_DBUS_PATH<span><font color="#990000">,</font></span> | ||
+ | ICD_UI_DBUS_INTERFACE<span><font color="#990000">,</font></span> | ||
+ | <span>''<span><font color="#9A1900">/*macro for show_conn_dlg */</font></span>''</span> | ||
+ | ICD_UI_SHOW_CONNDLG_REQ<span><font color="#990000">);</font></span> | ||
+ | <span>''<span><font color="#9A1900">/* send the message */</font></span>''</span> | ||
+ | reply <span><font color="#990000"><nowiki>=</nowiki></font></span> | ||
+ | <span>'''<span><font color="#000000">dbus_connection_send_with_reply_and_block</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">,</font></span> | ||
+ | uimsg<span><font color="#990000">,</font></span> | ||
+ | reply_timeout<span><font color="#990000">,</font></span> | ||
+ | <span><font color="#990000">&</font></span>error<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>reply <span><font color="#990000"><nowiki>==</nowiki></font></span> NULL<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000000">DLOG_ERR</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"Failed to show connect dialog: %s"</font></span><span><font color="#990000">,</font></span> uierror<span><font color="#990000">.</font></span>message<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">dbus_error_free</font></span>'''</span><span><font color="#990000">(&</font></span>uierror<span><font color="#990000">);</font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | <span>'''<span><font color="#000000">dbus_message_unref</font></span>'''</span><span><font color="#990000">(</font></span>uimsg<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">dbus_message_unref</font></span>'''</span><span><font color="#990000">(</font></span>reply<span><font color="#990000">);</font></span> | ||
+ | <span>''<span><font color="#9A1900">/* ... */</font></span>''</span></tt> | ||
- | + | The signals emitted from com.nokia.icd_ui interface are listed below. | |
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | Signal: disconnect | |
- | + | Parameters: 1. boolean TRUE if "disconnect" pressed, FALSE if "cancel" | |
+ | |||
+ | Description: Signal emitted from UI when disconnect dialog has been closed. | ||
- | / | + | </div> |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | |||
- | + | Signal: retry | |
- | + | Parameters: 1. string The IAP that is to be retried | |
- | + | 2. boolean TRUE if "retry" pressed, FALSE if "cancel" | |
- | + | ||
- | + | Description: Signal emitted from UI when the retry dialog has been closed. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | </div> | |
- | + | ||
- | + | <br /><br /> | |
- | + | ||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | |||
- | |||
- | + | Signal: change | |
- | + | Parameters: 1. string Old IAP to change from | |
- | + | 2. string New IAP to change to | |
- | + | 3. boolean Change to the new IAP If TRUE, keep old if FALSE | |
- | + | ||
- | + | Description: Signal emitted from UI when change connection dialog has | |
- | + | been closed. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | < | + | </div> |
- | / | + | |
- | + | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | Signal: passwd | |
- | + | Parameters: 1. string Username supplied or modified by the user | |
- | + | 2. string Password supplied or modified by the user | |
+ | 3. string IAP name | ||
+ | 4. boolean TRUE if "ok" pressed, FALSE if "cancel" | ||
+ | |||
+ | Description: Signal emitted from UI when the username/password dialog has | ||
+ | been closed | ||
- | + | </div> | |
- | + | ||
- | |||
- | |||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | Signal: gtc_response | |
- | + | Parameters: 1. string Response to the given challenge or empty string | |
+ | if cancelled | ||
+ | 2. boolean TRUE if "ok" pressed, FALSE if "cancel" | ||
+ | |||
+ | Description: Signal emitted from UI when the EAP GTC challenge dialog has | ||
+ | been closed. | ||
- | + | </div> | |
- | + | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | Signal: mschap_change | |
- | + | Parameters: 1. string Supplied username | |
- | + | 2. string The new password or empty string if cancelled | |
- | + | 3. string IAP name | |
- | + | 4. boolean TRUE if "ok" pressed, FALSE if "cancel" | |
- | + | ||
- | + | Description: Signal emitted from UI when the MSCHAPv2 password has been | |
+ | changed | ||
- | + | </div> | |
- | + | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | Signal: private_key_passwd | |
- | + | Parameters: 1. byte array Certificate ID | |
- | + | 2. string Password for the private key or empty string if none | |
- | + | 3. boolean TRUE if "ok" pressed, FALSE if "cancel" | |
+ | |||
+ | Description: Signal emitted from UI when the private key password dialog | ||
+ | has been closed | ||
- | + | </div> | |
- | + | ||
- | |||
- | |||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | Signal: server_cert | |
- | + | Parameters: 1. boolean TRUE if strong PIN entered, FALSE if strong | |
- | + | PIN dialog was canceled | |
- | + | ||
- | + | Description: Signal emitted from UI when the server certificate error | |
- | + | dialog has been closed | |
- | + | ||
- | + | </div> | |
- | + | <br /><br /> | |
- | + | ||
- | + | ||
- | + | ||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | Signal: strong_bt | |
+ | Parameters: 1. boolean TRUE if strong PIN entered, FALSE if strong | ||
+ | PIN dialog was cancelled | ||
+ | |||
+ | Description: Signal emitted from UI when the strong (16 digit) BT PIN | ||
+ | has been entered | ||
- | + | </div> | |
- | |||
- | |||
- | |||
- | |||
- | |||
- | + | <div class="graybox"> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
+ | Signal: sim_pin | ||
+ | Parameters: 1. string SIM PIN code or empty string if cancelled | ||
+ | 2. boolean TRUE if "ok" pressed, FALSE if "cancel" | ||
+ | |||
+ | Description: Signal emitted from UI when the SIM PIN has been entered. | ||
- | + | </div> | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ===Bluetooth DBUS UI dialogs === | |
- | + | ||
- | + | conbtdialogs-dbus.h | |
- | + | ||
- | return 0; | + | <tt><span>''<span><font color="#9A1900">/** </font></span>''</span> |
- | } | + | <span>''<span><font color="#9A1900"> Example of use (command line):</font></span>''</span> |
- | </ | + | <span>''<span><font color="#9A1900"> </font></span>''</span> |
+ | <span>''<span><font color="#9A1900"> dbus-send --system --print-reply \</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> --dest='com.nokia.icd_ui' /com/nokia/bt_ui \</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> com.nokia.bt_ui.show_send_file_dlg \</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> array:string:</font></span>''</span><span><u><span><font color="#0000FF">file:///home/user/MyDocs/.documents/testing.txt</font></span></u></span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> dbus-send --system --print-reply \</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> --dest=com.nokia.bt_ui /com/nokia/bt_ui </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> com.nokia.bt_ui.show_search_dlg \</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> string: string: array:string: string:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"><nowiki>*/</nowiki></font></span>''</span> | ||
+ | |||
+ | <span>'''<span><font color="#000080"><nowiki>#ifndef</nowiki></font></span>'''</span> CONBTDIALOGS_DBUS_H | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> CONBTDIALOGS_DBUS_H | ||
+ | |||
+ | <span>'''<span><font color="#000080"><nowiki>#ifdef</nowiki></font></span>'''</span> __cplusplus | ||
+ | <span>'''<span><font color="#0000FF">extern</font></span>'''</span> <span><font color="#FF0000">"C"</font></span> <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#endif</nowiki></font></span>'''</span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/** Conbtdialogs service, resides in system dbus */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> CONBTDIALOGS_DBUS_SERVICE <span><font color="#FF0000">"com.nokia.bt_ui"</font></span> | ||
+ | <span>''<span><font color="#9A1900">/** Conbtdialogs interface */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> CONBTDIALOGS_DBUS_INTERFACE <span><font color="#FF0000">"com.nokia.bt_ui"</font></span> | ||
+ | <span>''<span><font color="#9A1900">/** Conbtdialogs path */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> CONBTDIALOGS_DBUS_PATH <span><font color="#FF0000">"/com/nokia/bt_ui"</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/** </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Show send file dialog</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Arguments:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> uris: DBUS_TYPE_ARRAY Array of strings representing the URIs of the</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> files to send.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Returns:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> DBUS_TYPE_BOOLEAN TRUE, if dialog was shown successfully.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> CONBTDIALOGS_SEND_FILE_REQ <span><font color="#FF0000">"show_send_file_dlg"</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/** </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> File sending result signal</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Arguments:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> success: DBUS_TYPE_BOOLEAN TRUE, if all files were sent successfully or</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> FALSE, if error occurred or sending was </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> canceled.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> CONBTDIALOGS_SEND_FILE_SIG <span><font color="#FF0000">"send_file"</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/** </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Show BT device search dialog</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Arguments:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> major_class: DBUS_TYPE_STRING To set filtering based on major_class or</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "". Possible major class values are:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "miscellaneous", "computer", "phone", </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "access point", "audio/video", </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "peripheral", "imaging", "wearable",</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "toy" and "uncategorized".</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> minor_class: DBUS_TYPE_STRING To set filtering based on minor_class or "".</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Possible minor class values are:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> - Minor classes for "computer": </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "uncategorized", "desktop", "server",</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "laptop", "handheld", "palm", "wearable"</font></span>''</span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900"> - Minor classes for "phone": "uncategorized",</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "cellular", "cordless", "smart phone",</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "modem", "isdn"</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> service_classes: DBUS_TYPE_ARRAY To set filtering based on service classes.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Supported classes include "positioning", </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "networking", "rendering", "capturing",</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "object transfer", "audio", "telephony", </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "information". Can be empty list, when no</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> service class filtering is performed.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> bonding: DBUS_TYPE_STRING Bonding mode for found and selected device:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "require" for requiring a bonding from a</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> selected device (i.e. bond device if it has not</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> been bonded before). </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> "force" to always bond (i.e. device will be</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> bonded even if bonded before).</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Any other string will allow to search and</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> select device without bonding it.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Returns:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> DBUS_TYPE_BOOLEAN TRUE, if dialog was shown successfully.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> CONBTDIALOGS_SEARCH_REQ <span><font color="#FF0000">"show_search_dlg"</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/** </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Bluetooth search result signal</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Arguments:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> address: DBUS_TYPE_STRING Bluetooth address of the selected device, or ""</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> if search dialog was cancelled.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> name: DBUS_TYPE_STRING Name of the device.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> icon: DBUS_TYPE_STRING Logical name for the icon describing the </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> device.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> major_class: DBUS_TYPE_STRING Major class of the device.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> minor_class: DBUS_TYPE_STRING Minor class of the device.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> trusted: DBUS_TYPE_BOOLEAN Defines whether the device is marked as a trusted device.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> services: DBUS_TYPE_ARRAY List of strings describing the service classes</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> and SDP-based services provided by the device.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> CONBTDIALOGS_SEARCH_SIG <span><font color="#FF0000">"search_result"</font></span> | ||
+ | </tt> | ||
+ | |||
+ | <br> | ||
+ | |||
+ | <tt><span>''<span><font color="#9A1900">/**</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Bluetooth UI Library for maemo</font></span>''</span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900"> Copyright (C) 2006 Nokia. All rights reserved.</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> This sample demonstrates the use of conbtdialogs API and especially </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> send_file function. Compile the program with conbtdialogs and dbus:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> gcc -Wall `pkg-config -libs -cflags dbus-glib-1 conbtdialogs` \</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900">-o send_file conbtdialogs_send_file.c</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> Run with list of URLS:</font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> ./send_file </font></span>''</span><span><u><span><font color="#0000FF">file:///home/user/MyDocs/.sounds/Everyday.mp3</font></span></u></span> | ||
+ | <span>''<span><font color="#9A1900"><nowiki>*/</nowiki></font></span>''</span> | ||
+ | |||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> DBUS_API_SUBJECT_TO_CHANGE | ||
+ | |||
+ | <span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><glib.h></font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><conbtdialogs-dbus.h></font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><dbus/dbus.h></font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><dbus/dbus-glib.h></font></span> | ||
+ | |||
+ | DBusGConnection <span><font color="#990000"><nowiki>*</nowiki></font></span>connection <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | GMainLoop <span><font color="#990000"><nowiki>*</nowiki></font></span>mainloop <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">static</font></span>'''</span> gboolean <span>'''<span><font color="#000000">initialize</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">)</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | GError <span><font color="#990000"><nowiki>*</nowiki></font></span>error <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">g_type_init</font></span>'''</span> <span><font color="#990000">();</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* Create main loop */</font></span>''</span> | ||
+ | mainloop <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">g_main_loop_new</font></span>'''</span><span><font color="#990000">(</font></span>NULL<span><font color="#990000">,</font></span> TRUE<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span> mainloop <span><font color="#990000"><nowiki>==</nowiki></font></span> NULL <span><font color="#990000">)</font></span> <span>'''<span><font color="#0000FF">return</font></span>'''</span> FALSE<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* Create DBUS connection */</font></span>''</span> | ||
+ | connection <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">dbus_g_bus_get</font></span>'''</span><span><font color="#990000">(</font></span>DBUS_BUS_SYSTEM<span><font color="#990000">,</font></span> <span><font color="#990000">&</font></span>error<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>connection <span><font color="#990000"><nowiki>==</nowiki></font></span> NULL <span><font color="#990000">)</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000000">g_print</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#FF0000">"Error: %s</font></span><span><font color="#CC33CC">\n</font></span><span><font color="#FF0000">"</font></span><span><font color="#990000">,</font></span> error<span><font color="#990000">-></font></span>message<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_clear_error</font></span>'''</span> <span><font color="#990000">(&</font></span>error<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> FALSE<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> TRUE<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">static</font></span>'''</span> gboolean <span>'''<span><font color="#000000">uninitialize</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">)</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | <span>''<span><font color="#9A1900">/* Quit main loop and unref it */</font></span>''</span> | ||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>mainloop <span><font color="#990000"><nowiki>!=</nowiki></font></span> NULL<span><font color="#990000">)</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000000">g_main_loop_quit</font></span>'''</span><span><font color="#990000">(</font></span>mainloop<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_main_loop_unref</font></span>'''</span><span><font color="#990000">(</font></span>mainloop<span><font color="#990000">);</font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> TRUE<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">static</font></span>'''</span> DBusHandlerResult <span>'''<span><font color="#000000">file_sent_signal</font></span>'''</span> <span><font color="#990000">(</font></span> DBusConnection <span><font color="#990000"><nowiki>*</nowiki></font></span>connection<span><font color="#990000">,</font></span> | ||
+ | DBusMessage <span><font color="#990000"><nowiki>*</nowiki></font></span>message<span><font color="#990000">,</font></span> | ||
+ | <span><font color="#009900">void</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>data <span><font color="#990000">)</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | gboolean success <span><font color="#990000"><nowiki>=</nowiki></font></span> FALSE<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* check signal */</font></span>''</span> | ||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(!</font></span><span>'''<span><font color="#000000">dbus_message_is_signal</font></span>'''</span><span><font color="#990000">(</font></span>message<span><font color="#990000">,</font></span> | ||
+ | CONBTDIALOGS_DBUS_INTERFACE<span><font color="#990000">,</font></span> | ||
+ | CONBTDIALOGS_SEND_FILE_SIG<span><font color="#990000">))</font></span> | ||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> DBUS_HANDLER_RESULT_NOT_YET_HANDLED<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* get args */</font></span>''</span> | ||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span> <span><font color="#990000"><nowiki>!</nowiki></font></span><span>'''<span><font color="#000000">dbus_message_get_args</font></span>'''</span> <span><font color="#990000">(</font></span> message<span><font color="#990000">,</font></span> NULL<span><font color="#990000">,</font></span> | ||
+ | DBUS_TYPE_BOOLEAN<span><font color="#990000">,</font></span> <span><font color="#990000">&</font></span>success<span><font color="#990000">,</font></span> | ||
+ | DBUS_TYPE_INVALID <span><font color="#990000">)</font></span> <span><font color="#990000">)</font></span> | ||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> DBUS_HANDLER_RESULT_NOT_YET_HANDLED<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* print if file sending was success or failure */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000000">g_print</font></span>'''</span> <span><font color="#990000">(</font></span> <span><font color="#FF0000">"File sending was a "</font></span> <span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>success<span><font color="#990000">)</font></span> <span>'''<span><font color="#000000">g_print</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"success</font></span><span><font color="#CC33CC">\n</font></span><span><font color="#FF0000">"</font></span><span><font color="#990000">);</font></span> <span>'''<span><font color="#0000FF">else</font></span>'''</span> <span>'''<span><font color="#000000">g_print</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"failure</font></span><span><font color="#CC33CC">\n</font></span><span><font color="#FF0000">"</font></span><span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">dbus_connection_close</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">uninitialize</font></span>'''</span><span><font color="#990000">();</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> DBUS_HANDLER_RESULT_HANDLED<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | |||
+ | gint <span>'''<span><font color="#000000">main</font></span>'''</span><span><font color="#990000">(</font></span>gint argc<span><font color="#990000">,</font></span> gchar <span><font color="#990000"><nowiki>**</nowiki></font></span>argv<span><font color="#990000">)</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | GError <span><font color="#990000"><nowiki>*</nowiki></font></span>error <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | gchar <span><font color="#990000"><nowiki>**</nowiki></font></span>files <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | gint idx <span><font color="#990000"><nowiki>=</nowiki></font></span> <span><font color="#993399">0</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | DBusGProxy <span><font color="#990000"><nowiki>*</nowiki></font></span>proxy<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | DBusConnection <span><font color="#990000"><nowiki>*</nowiki></font></span>sys_conn<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | gchar <span><font color="#990000"><nowiki>*</nowiki></font></span>filter_string <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>argc <span><font color="#990000"><</font></span> <span><font color="#993399">2</font></span><span><font color="#990000">)</font></span> <span>'''<span><font color="#0000FF">return</font></span>'''</span> <span><font color="#993399">1</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">initialize</font></span>'''</span><span><font color="#990000">()</font></span> <span><font color="#990000"><nowiki>==</nowiki></font></span> FALSE<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000000">uninitialize</font></span>'''</span><span><font color="#990000">();</font></span> | ||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> <span><font color="#993399">1</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* Copy urls to GLib compatible char array */</font></span>''</span> | ||
+ | files <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">g_new0</font></span>'''</span><span><font color="#990000">(</font></span>gchar<span><font color="#990000"><nowiki>*,</nowiki></font></span> argc<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">for</font></span>'''</span> <span><font color="#990000">(</font></span>idx <span><font color="#990000"><nowiki>=</nowiki></font></span> <span><font color="#993399">1</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> idx <span><font color="#990000"><</font></span> argc<span><font color="#990000"><nowiki>;</nowiki></font></span> idx<span><font color="#990000">++)</font></span> | ||
+ | files<span><font color="#990000">[</font></span>idx<span><font color="#990000">-</font></span><span><font color="#993399">1</font></span><span><font color="#990000">]</font></span> <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">g_strdup</font></span>'''</span><span><font color="#990000">(</font></span>argv<span><font color="#990000">[</font></span>idx<span><font color="#990000">]);</font></span> | ||
+ | |||
+ | files<span><font color="#990000">[</font></span>argc<span><font color="#990000">-</font></span><span><font color="#993399">1</font></span><span><font color="#990000">]</font></span> <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* Open connection for btdialogs service */</font></span>''</span> | ||
+ | proxy <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">dbus_g_proxy_new_for_name</font></span>'''</span><span><font color="#990000">(</font></span>connection<span><font color="#990000">,</font></span> | ||
+ | CONBTDIALOGS_DBUS_SERVICE<span><font color="#990000">,</font></span> | ||
+ | CONBTDIALOGS_DBUS_PATH<span><font color="#990000">,</font></span> | ||
+ | CONBTDIALOGS_DBUS_INTERFACE<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* Send send file request to btdialogs service */</font></span>''</span> | ||
+ | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(!</font></span><span>'''<span><font color="#000000">dbus_g_proxy_call</font></span>'''</span><span><font color="#990000">(</font></span>proxy<span><font color="#990000">,</font></span> CONBTDIALOGS_SEND_FILE_REQ<span><font color="#990000">,</font></span> | ||
+ | <span><font color="#990000">&</font></span>error<span><font color="#990000">,</font></span> | ||
+ | G_TYPE_STRV<span><font color="#990000">,</font></span> files<span><font color="#990000">,</font></span> G_TYPE_INVALID<span><font color="#990000">,</font></span> | ||
+ | G_TYPE_INVALID<span><font color="#990000">))</font></span> | ||
+ | <span><font color="#FF0000">{</font></span> | ||
+ | <span>'''<span><font color="#000000">g_print</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"Error: %s</font></span><span><font color="#CC33CC">\n</font></span><span><font color="#FF0000">"</font></span><span><font color="#990000">,</font></span> error<span><font color="#990000">-></font></span>message<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_clear_error</font></span>'''</span><span><font color="#990000">(&</font></span>error<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_strfreev</font></span>'''</span> <span><font color="#990000">(</font></span>files<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_object_unref</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span><span><font color="#990000">(</font></span>proxy<span><font color="#990000">));</font></span> | ||
+ | <span>'''<span><font color="#000000">uninitialize</font></span>'''</span><span><font color="#990000">();</font></span> | ||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> <span><font color="#993399">1</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span> | ||
+ | <span>'''<span><font color="#000000">g_strfreev</font></span>'''</span> <span><font color="#990000">(</font></span>files<span><font color="#990000">);</font></span> | ||
+ | files <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">g_object_unref</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span><span><font color="#990000">(</font></span>proxy<span><font color="#990000">));</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* Now wait for file sent signal, use low level bindings as glib </font></span>''</span> | ||
+ | <span>''<span><font color="#9A1900"> bindings require signal marshaller registered */</font></span>''</span> | ||
+ | sys_conn <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">dbus_bus_get</font></span>'''</span><span><font color="#990000">(</font></span>DBUS_BUS_SYSTEM<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_assert</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">dbus_connection_add_filter</font></span>'''</span><span><font color="#990000">(</font></span>sys_conn<span><font color="#990000">,</font></span> | ||
+ | file_sent_signal<span><font color="#990000">,</font></span> | ||
+ | NULL<span><font color="#990000">,</font></span> | ||
+ | NULL <span><font color="#990000">));</font></span> | ||
+ | filter_string <span><font color="#990000"><nowiki>=</nowiki></font></span> | ||
+ | <span>'''<span><font color="#000000">g_strdup_printf</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#FF0000">"type='signal',interface='%s'"</font></span><span><font color="#990000">,</font></span> CONBTDIALOGS_DBUS_INTERFACE<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">dbus_bus_add_match</font></span>'''</span><span><font color="#990000">(</font></span>sys_conn<span><font color="#990000">,</font></span> filter_string<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">dbus_connection_unref</font></span>'''</span><span><font color="#990000">(</font></span>sys_conn<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>''<span><font color="#9A1900">/* Run mainloop */</font></span>''</span> | ||
+ | <span>'''<span><font color="#000000">g_main_loop_run</font></span>'''</span><span><font color="#990000">(</font></span>mainloop<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> <span><font color="#993399">0</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span></tt> | ||
[[Category:Development]] | [[Category:Development]] | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Fremantle]] | [[Category:Fremantle]] |
Learn more about Contributing to the wiki.