Difference between revisions of "FPC and DBus"

From Free Pascal wiki
Jump to navigationJump to search
(Dbus is not new anymore ;), typos, grammar)
Line 3: Line 3:
 
=== Documentation ===
 
=== Documentation ===
  
DBUS is a very new GNU library that implements inter-process communication. It's the default library of this kind for GNU applications.
+
DBUS is a GNU library that implements inter-process communication. It's the default library of this kind for GNU applications.
  
This library provides a simple way for applications to talk to one another, using a bus sytem. These headers are the translation of the low-level c API for dbus. In the future it is desirable that this headers be wrapped around a class to make their use easier.
+
This library provides a simple way for applications to talk to one another, using a bus sytem. These headers are the translation of the low-level C API for DBUS. In the future it is desirable that these headers be wrapped around a class to make their use easier.
  
 
==== Common Code ====
 
==== Common Code ====
  
Independently from what you want to achieve, a lot of the code for a software that uses DBUS will be very similar. This is the startup and finalization code. On the startup you need to connect to the bus. Usually there is a system and a session bus. Depending on the configuration of the system you may not have access to the system bus. Next you need to request a name on the bus. Bellow is a simple startup code.
+
Independently from what you want to achieve, a lot of the code for a software that uses DBUS will be very similar. This is the startup and finalization code. On the startup you need to connect to the bus. Usually there is a system and a session bus. Depending on the configuration of the system you may not have access to the system bus. Next you need to request a name on the bus. Below is a simple startup code.
  
<pre>
+
<delphi>
 
var
 
var
 
   err: DBusError;
 
   err: DBusError;
Line 43: Line 43:
  
 
   ....
 
   ....
</pre>
+
</delphi>
  
After you no longer need the bus you should close the connect. A good place to do this on most cases is right before the application terminates.
+
When you no longer need the bus you should close the connection. A good place to do this in most cases is right before the application terminates.
  
<pre>
+
<delphi>
 
   { Finalization }
 
   { Finalization }
 
   dbus_connection_close(conn);
 
   dbus_connection_close(conn);
</pre>
+
</delphi>
  
 
==== Sending a Signal ====
 
==== Sending a Signal ====
Line 74: Line 74:
 
=== Subversion ===
 
=== Subversion ===
  
The FPC package for dbus resides in packages/[[dbus]] in the FPC (2.2.2/2.3.x+) packages tree.
+
The FPC package for DBUS resides in packages/[[dbus]] in the FPC (2.2.2/2.3.x+) packages tree.
  
 
You can download the subversion version of this project using this command:
 
You can download the subversion version of this project using this command:
 
+
<bash>
 
svn checkout http://svn.freepascal.org/svn/fpc/trunk/packages/dbus dbus
 
svn checkout http://svn.freepascal.org/svn/fpc/trunk/packages/dbus dbus
 +
</bash>
  
You can also download a full fpc 2.2.2+/2.3.1 repository and it will be included.
+
You can also download a full FPC 2.2.2+/2.3.1 repository and it will be included.
  
 
=== Bug Reporting ===
 
=== Bug Reporting ===
  
Tests are necessary to verify if all functions and structures are declared properly. Tests were done on Windows,FreeBSD and Linux operating systems. It is necessary to test if the modules work correctly in other operating system.
+
Tests are necessary to verify if all functions and structures are declared properly. Tests were done on Windows, FreeBSD and Linux operating systems. It is necessary to test if the modules work correctly in other operating system.
  
 
You can post Bug Reports here:
 
You can post Bug Reports here:
 +
*** to do: add location if it is not standard mantis***
  
 
=== Change Log ===
 
=== Change Log ===
Line 95: Line 97:
 
=== Help ===
 
=== Help ===
  
Please send help requests to the Free Pascal mailling list or on apache-modules mailling list.
+
Please send help requests to the Free Pascal mailling list or on apache-modules mailing list.
  
 
=== External Links ===
 
=== External Links ===
  
 
* [http://www.matthew.ath.cx/misc/dbus] - A Tutorial about using the DBUS C API
 
* [http://www.matthew.ath.cx/misc/dbus] - A Tutorial about using the DBUS C API

Revision as of 19:39, 18 September 2011

English (en) español (es)

Documentation

DBUS is a GNU library that implements inter-process communication. It's the default library of this kind for GNU applications.

This library provides a simple way for applications to talk to one another, using a bus sytem. These headers are the translation of the low-level C API for DBUS. In the future it is desirable that these headers be wrapped around a class to make their use easier.

Common Code

Independently from what you want to achieve, a lot of the code for a software that uses DBUS will be very similar. This is the startup and finalization code. On the startup you need to connect to the bus. Usually there is a system and a session bus. Depending on the configuration of the system you may not have access to the system bus. Next you need to request a name on the bus. Below is a simple startup code.

<delphi> var

 err: DBusError;
 conn: PDBusConnection;
 ret: cint;

begin

 { Initializes the errors }
 dbus_error_init(@err);
 
 { Connection }
 conn := dbus_bus_get(DBUS_BUS_SESSION, @err);
 if dbus_error_is_set(@err) <> 0 then
 begin
   WriteLn('Connection Error: ' + err.message);
   dbus_error_free(@err);
 end;
 
 if conn = nil then Exit;
 
 { Request the name of the bus }
 ret := dbus_bus_request_name(conn, 'test.method.server', DBUS_NAME_FLAG_REPLACE_EXISTING, @err);
 if dbus_error_is_set(@err) <> 0 then
 begin
   WriteLn('Name Error: ' + err.message);
   dbus_error_free(@err);
 end;
 
 if ret <> DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER then Exit;
 ....

</delphi>

When you no longer need the bus you should close the connection. A good place to do this in most cases is right before the application terminates.

<delphi>

 { Finalization }
 dbus_connection_close(conn);

</delphi>

Sending a Signal

Receiving a Signal

Calling a Method

Responding to Method calls

Authors

Felipe Monteiro de Carvalho


License

Download

Status: Beta

Subversion

The FPC package for DBUS resides in packages/dbus in the FPC (2.2.2/2.3.x+) packages tree.

You can download the subversion version of this project using this command: <bash> svn checkout http://svn.freepascal.org/svn/fpc/trunk/packages/dbus dbus </bash>

You can also download a full FPC 2.2.2+/2.3.1 repository and it will be included.

Bug Reporting

Tests are necessary to verify if all functions and structures are declared properly. Tests were done on Windows, FreeBSD and Linux operating systems. It is necessary to test if the modules work correctly in other operating system.

You can post Bug Reports here:

      • to do: add location if it is not standard mantis***

Change Log

  • ??.??.06 DBus headers version 0.1
  1. Under construction

Help

Please send help requests to the Free Pascal mailling list or on apache-modules mailing list.

External Links

  • [1] - A Tutorial about using the DBUS C API