Documentation/Maemo 5 Developer Guide/Application Development/LibOSSO library - Revision history

imported_>amigadave: add ==Further reading==

2010-09-02T10:43:59Z

add ==Further reading==

← Older revision		Revision as of 10:43, 2 September 2010
Line 221:		Line 221:

	Information on how to implement state saving can be found in LibOSSO API document.		Information on how to implement state saving can be found in LibOSSO API document.

			== Further reading ==

			* [[Documentation/Maemo 5 Developer Guide/DBus/DBus Basics\|Introduction to D-Bus]]

	[[Category:Development]]		[[Category:Development]]
	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:Fremantle]]		[[Category:Fremantle]]

imported_>amigadave: use


2010-08-16T14:24:21Z
use <code>

				
				
				
				
				
				← Older revision
				Revision as of 14:24, 16 August 2010
				
Line 99:
Line 99:
</source> </source>



Now the application is ready to receive D-Bus messages. Whenever it receives one, the dbus_req_handler function is called to process the message. Another test application ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_message.c example_message.c]), can send the ''HelloWorld'' that this application was designed to handle, as follows: Now the application is ready to receive D-Bus messages. Whenever it receives one, the <code>dbus_req_handler()</code> function is called to process the message. Another test application ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_message.c example_message.c]), can send the ''HelloWorld'' that this application was designed to handle, as follows:



<source lang="c"> <source lang="c">



imported_>amigadave: use  and , wikify slightly

2010-07-20T12:15:20Z
use <source> and <code>, wikify slightly
Show changes


imported_>amigadave: /* Overview */ link to libosso documentation
2010-03-31T09:08:52Z
Overview:  link to libosso documentation

				
				
				
				
				
				← Older revision
				Revision as of 09:08, 31 March 2010
				
Line 1:
Line 1:
= Overview = = Overview =



LibOSSO is the basic library, containing required and helpful functions for Maemo applications. The full API documentation of LibOSSO is available in Doxygen format. LibOSSO is the basic library, containing required and helpful functions for Maemo applications. The [http://maemo.org/api_refs/5.0/5.0-final/libosso/ full API documentation of LibOSSO is available] in Doxygen format.



= Maemo initialization = = Maemo initialization =



imported_>amigadave: categorise
2010-02-12T11:59:59Z
categorise

				
				
				
				
				
				← Older revision
				Revision as of 11:59, 12 February 2010
				
Line 201:
Line 201:



Information on how to implement state saving can be found in LibOSSO API document. Information on how to implement state saving can be found in LibOSSO API document.

[[Category:Development]]
[[Category:Documentation]]
[[Category:Fremantle]]



imported_>tapio at 09:43, 12 February 2010
2010-02-12T09:43:23Z


				
				
				
				
				
				← Older revision
				Revision as of 09:43, 12 February 2010
				
Line 163:
Line 163:
= System Exit message = = System Exit message =



A system message is sent when applications are required to close themselves. Its callback is: ([https://garage.maemo.org/svn/maemoexamples/trunk/maemo-examples/example_libosso.c example_libosso.c]): A system message is sent when applications are required to close themselves. Its callback is: ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_libosso.c example_libosso.c]):



  <tt><span>''<span><font color="#9A1900">/* Callback for exit D-BUS event */</font></span>''</span>   <tt><span>''<span><font color="#9A1900">/* Callback for exit D-BUS event */</font></span>''</span>



imported_>tapio at 09:42, 12 February 2010
2010-02-12T09:42:36Z


				
				
				
				
				
				← Older revision
				Revision as of 09:42, 12 February 2010
				
Line 114:
Line 114:
<nowiki> Maemo applications can connect to listen the system D-BUS messages, like ``battery low'' and ``shutdown''. When these messages are received, the application may want to ask the user to save files that are open, or react however wanted. </nowiki> <nowiki> Maemo applications can connect to listen the system D-BUS messages, like ``battery low'' and ``shutdown''. When these messages are received, the application may want to ask the user to save files that are open, or react however wanted. </nowiki>



A callback function is defined like below, taking <code>osso_hw_state_t</code> and gpointer as parameters. The changed state can be gotten from state variable ([https://garage.maemo.org/svn/maemoexamples/trunk/maemo-examples/example_libosso.c <code>example_libosso.c</code>]). A callback function is defined like below, taking <code>osso_hw_state_t</code> and gpointer as parameters. The changed state can be gotten from state variable ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_libosso.c <code>example_libosso.c</code>]).



  <tt><span>''<span><font color="#9A1900">/* Callback for hardware D-BUS events */</font></span>''</span>   <tt><span>''<span><font color="#9A1900">/* Callback for hardware D-BUS events */</font></span>''</span>



imported_>tapio at 09:41, 12 February 2010
2010-02-12T09:41:31Z


				
				
				
				
				
				← Older revision
				Revision as of 09:41, 12 February 2010
				
Line 33:
Line 33:
System wide messages in Maemo platform are handled with D-BUS system messaging, which is a Remote Process Communication (RPC) method. LibOSSO has own wrappers to normal D-BUS functions to make usage simpler and to maintain backward compatibility. By using D-BUS, applications can send messages from one process to another. System wide messages in Maemo platform are handled with D-BUS system messaging, which is a Remote Process Communication (RPC) method. LibOSSO has own wrappers to normal D-BUS functions to make usage simpler and to maintain backward compatibility. By using D-BUS, applications can send messages from one process to another.



Callback function receiving the messages can be as follows ([https://garage.maemo.org/svn/maemoexamples/trunk/maemo-examples/example_libosso.c example_libosso.c]), where AppData structure contains the initialized osso_context: Callback function receiving the messages can be as follows ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_libosso.c example_libosso.c]), where AppData structure contains the initialized osso_context:



  <tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000">&lt;hildon/hildon-program.h&gt;</font></span>   <tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000">&lt;hildon/hildon-program.h&gt;</font></span>
Line 90:
Line 90:
  </tt>   </tt>



Now the application is ready to receive D-BUS messages. Whenever it receives one, the dbus_req_handler function is called to process the message. Another test application ([https://garage.maemo.org/svn/maemoexamples/trunk/maemo-examples/example_message.c example_message.c]<nowiki>), can send the ``HelloWorld'' that this application was designed to handle, as follows: </nowiki> Now the application is ready to receive D-BUS messages. Whenever it receives one, the dbus_req_handler function is called to process the message. Another test application ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_message.c example_message.c]<nowiki>), can send the ``HelloWorld'' that this application was designed to handle, as follows: </nowiki>



  <tt><span>''<span><font color="#9A1900">/* ... */</font></span>''</span>   <tt><span>''<span><font color="#9A1900">/* ... */</font></span>''</span>



imported_>tapio at 09:40, 12 February 2010
2010-02-12T09:40:15Z


				
				
				
				
				
				← Older revision
				Revision as of 09:40, 12 February 2010
				
Line 11:
Line 11:
<br />''osso_context_t * osso_initialize(const gchar *application, const gchar* version, gboolean activation, GMainContext *context)''<br /><br /> When the application is closing, osso_deinitialize function should be called to close the message bus connection and free all memory allocated by the library. <br /><br />''void osso_deinitialize(osso_context_t *osso)''<br /><br /> <br />''osso_context_t * osso_initialize(const gchar *application, const gchar* version, gboolean activation, GMainContext *context)''<br /><br /> When the application is closing, osso_deinitialize function should be called to close the message bus connection and free all memory allocated by the library. <br /><br />''void osso_deinitialize(osso_context_t *osso)''<br /><br />



Below is an example ([https://garage.maemo.org/svn/maemoexamples/trunk/maemo-examples/example_libosso.c example_libosso.c]) of this; if the initialization does not succeed, the function returns NULL. Below is an example ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_libosso.c example_libosso.c]) of this; if the initialization does not succeed, the function returns NULL.



  <tt><span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> OSSO_EXAMPLE_NAME    <span><font color="#FF0000">"example_libosso"</font></span>   <tt><span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> OSSO_EXAMPLE_NAME    <span><font color="#FF0000">"example_libosso"</font></span>



imported_>danielwilms: Maemo 5 Developer Guide/Application Development/LibOSSO library moved to Documentation/Maemo 5 Developer Guide/Application Development/LibOSSO library
2009-11-05T13:24:08Z
Maemo 5 Developer Guide/Application Development/LibOSSO library moved to Documentation/Maemo 5 Developer Guide/Application Development/LibOSSO library

				
				← Older revision
				Revision as of 13:24, 5 November 2009
				
(No difference)

← Older revision		Revision as of 14:24, 16 August 2010
Line 99:		Line 99:
	</source>		</source>

	Now the application is ready to receive D-Bus messages. Whenever it receives one, the dbus_req_handler function is called to process the message. Another test application ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_message.c example_message.c]), can send the ''HelloWorld'' that this application was designed to handle, as follows:		Now the application is ready to receive D-Bus messages. Whenever it receives one, the <code>dbus_req_handler()</code> function is called to process the message. Another test application ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_message.c example_message.c]), can send the ''HelloWorld'' that this application was designed to handle, as follows:

	<source lang="c">		<source lang="c">

← Older revision		Revision as of 09:08, 31 March 2010
Line 1:		Line 1:
	= Overview =		= Overview =

	LibOSSO is the basic library, containing required and helpful functions for Maemo applications. The full API documentation of LibOSSO is available in Doxygen format.		LibOSSO is the basic library, containing required and helpful functions for Maemo applications. The [http://maemo.org/api_refs/5.0/5.0-final/libosso/ full API documentation of LibOSSO is available] in Doxygen format.

	= Maemo initialization =		= Maemo initialization =

← Older revision		Revision as of 11:59, 12 February 2010
Line 201:		Line 201:

	Information on how to implement state saving can be found in LibOSSO API document.		Information on how to implement state saving can be found in LibOSSO API document.

			[[Category:Development]]
			[[Category:Documentation]]
			[[Category:Fremantle]]

← Older revision		Revision as of 09:43, 12 February 2010
Line 163:		Line 163:
	= System Exit message =		= System Exit message =

	A system message is sent when applications are required to close themselves. Its callback is: ([https://~~garage~~.maemo.org/svn/maemoexamples/~~trunk~~/maemo-examples/example_libosso.c example_libosso.c]):		A system message is sent when applications are required to close themselves. Its callback is: ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_libosso.c example_libosso.c]):

	<tt><span>''<span><font color="#9A1900">/* Callback for exit D-BUS event */</font></span>''</span>		<tt><span>''<span><font color="#9A1900">/* Callback for exit D-BUS event */</font></span>''</span>

← Older revision		Revision as of 09:42, 12 February 2010
Line 114:		Line 114:
	<nowiki> Maemo applications can connect to listen the system D-BUS messages, like ``battery low'' and ``shutdown''. When these messages are received, the application may want to ask the user to save files that are open, or react however wanted. </nowiki>		<nowiki> Maemo applications can connect to listen the system D-BUS messages, like ``battery low'' and ``shutdown''. When these messages are received, the application may want to ask the user to save files that are open, or react however wanted. </nowiki>

	A callback function is defined like below, taking <code>osso_hw_state_t</code> and gpointer as parameters. The changed state can be gotten from state variable ([https://~~garage~~.maemo.org/svn/maemoexamples/~~trunk~~/maemo-examples/example_libosso.c <code>example_libosso.c</code>]).		A callback function is defined like below, taking <code>osso_hw_state_t</code> and gpointer as parameters. The changed state can be gotten from state variable ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_libosso.c <code>example_libosso.c</code>]).

	<tt><span>''<span><font color="#9A1900">/* Callback for hardware D-BUS events */</font></span>''</span>		<tt><span>''<span><font color="#9A1900">/* Callback for hardware D-BUS events */</font></span>''</span>

← Older revision		Revision as of 09:41, 12 February 2010
Line 33:		Line 33:
	System wide messages in Maemo platform are handled with D-BUS system messaging, which is a Remote Process Communication (RPC) method. LibOSSO has own wrappers to normal D-BUS functions to make usage simpler and to maintain backward compatibility. By using D-BUS, applications can send messages from one process to another.		System wide messages in Maemo platform are handled with D-BUS system messaging, which is a Remote Process Communication (RPC) method. LibOSSO has own wrappers to normal D-BUS functions to make usage simpler and to maintain backward compatibility. By using D-BUS, applications can send messages from one process to another.

	Callback function receiving the messages can be as follows ([https://~~garage~~.maemo.org/svn/maemoexamples/~~trunk~~/maemo-examples/example_libosso.c example_libosso.c]), where AppData structure contains the initialized osso_context:		Callback function receiving the messages can be as follows ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_libosso.c example_libosso.c]), where AppData structure contains the initialized osso_context:

	<tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><hildon/hildon-program.h></font></span>		<tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><hildon/hildon-program.h></font></span>
Line 90:		Line 90:
	</tt>		</tt>

	Now the application is ready to receive D-BUS messages. Whenever it receives one, the dbus_req_handler function is called to process the message. Another test application ([https://~~garage~~.maemo.org/svn/maemoexamples/~~trunk~~/maemo-examples/example_message.c example_message.c]<nowiki>), can send the ``HelloWorld'' that this application was designed to handle, as follows: </nowiki>		Now the application is ready to receive D-BUS messages. Whenever it receives one, the dbus_req_handler function is called to process the message. Another test application ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_message.c example_message.c]<nowiki>), can send the ``HelloWorld'' that this application was designed to handle, as follows: </nowiki>

	<tt><span>''<span><font color="#9A1900">/* ... */</font></span>''</span>		<tt><span>''<span><font color="#9A1900">/* ... */</font></span>''</span>

← Older revision		Revision as of 09:40, 12 February 2010
Line 11:		Line 11:
	<br />''osso_context_t * osso_initialize(const gchar application, const gchar version, gboolean activation, GMainContext context)''<br /><br /> When the application is closing, osso_deinitialize function should be called to close the message bus connection and free all memory allocated by the library. <br /><br />''void osso_deinitialize(osso_context_t osso)''<br /><br />		<br />''osso_context_t * osso_initialize(const gchar application, const gchar version, gboolean activation, GMainContext context)''<br /><br /> When the application is closing, osso_deinitialize function should be called to close the message bus connection and free all memory allocated by the library. <br /><br />''void osso_deinitialize(osso_context_t osso)''<br /><br />

	Below is an example ([https://~~garage~~.maemo.org/svn/maemoexamples/~~trunk~~/maemo-examples/example_libosso.c example_libosso.c]) of this; if the initialization does not succeed, the function returns NULL.		Below is an example ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/example_libosso.c example_libosso.c]) of this; if the initialization does not succeed, the function returns NULL.

	<tt><span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> OSSO_EXAMPLE_NAME <span><font color="#FF0000">"example_libosso"</font></span>		<tt><span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> OSSO_EXAMPLE_NAME <span><font color="#FF0000">"example_libosso"</font></span>

← Older revision	Revision as of 13:24, 5 November 2009
(No difference)