Net::DBus Binding Tutorial - Revision history

Digimer at 03:23, 5 May 2013

2013-05-05T03:23:47Z

← Older revision		Revision as of 03:23, 5 May 2013
Line 199:		Line 199:
	== Well Known Name ==		== Well Known Name ==

	Well known names in DBus are similar to domain names on the Internet; They simply map to a UCN. This way, a program could be written that will always look for a particular server, method or object and not need to worry about where it actually is. To continue the network analogy; This allows you to say "I want to connect to https://alteeve.~~com~~" and not need to worry about what the underlying IP address is, even if it changes.		Well known names in DBus are similar to domain names on the Internet; They simply map to a UCN. This way, a program could be written that will always look for a particular server, method or object and not need to worry about where it actually is. To continue the network analogy; This allows you to say "I want to connect to https://alteeve.ca" and not need to worry about what the underlying IP address is, even if it changes.

	Often times a program will (arbitrarily) define that a given program, say "<span class="code">org.freedesktop.TextEditor</span>" must publish an object at "<span class="code">/org/freedesktop/TextFileManager</span>" and support the interface "<span class="code">org.freedesktop.FileHandler</span>". These conventions are not enforced by DBus however.		Often times a program will (arbitrarily) define that a given program, say "<span class="code">org.freedesktop.TextEditor</span>" must publish an object at "<span class="code">/org/freedesktop/TextFileManager</span>" and support the interface "<span class="code">org.freedesktop.FileHandler</span>". These conventions are not enforced by DBus however.
Line 235:		Line 235:
	This shows simple how to connect to a bus, connect to a service on that bus, get a handle to an interface and one of it's methods and add a few handles. It uses [[HAL]] to show these methods.		This shows simple how to connect to a bus, connect to a service on that bus, get a handle to an interface and one of it's methods and add a few handles. It uses [[HAL]] to show these methods.

	* [https://alteeve.~~com~~/files/dbus_tutorial/client.pl Simple DBus Client] (3,997 bytes, '.pl' perl script).		* [https://alteeve.ca/files/dbus_tutorial/client.pl Simple DBus Client] (3,997 bytes, '.pl' perl script).
	* [[Sample Script: client.pl\|View Source]]		* [[Sample Script: client.pl\|View Source]]

Digimer: /* Simple Client */

2012-02-11T19:41:09Z

Simple Client

← Older revision		Revision as of 19:41, 11 February 2012
Line 235:		Line 235:
	This shows simple how to connect to a bus, connect to a service on that bus, get a handle to an interface and one of it's methods and add a few handles. It uses [[HAL]] to show these methods.		This shows simple how to connect to a bus, connect to a service on that bus, get a handle to an interface and one of it's methods and add a few handles. It uses [[HAL]] to show these methods.

	* [https://alteeve.com/~~local~~/dbus_tutorial/client.pl Simple DBus Client] (3,997 bytes, '.pl' perl script).		* [https://alteeve.com/files/dbus_tutorial/client.pl Simple DBus Client] (3,997 bytes, '.pl' perl script).
	* [[Sample Script: client.pl\|View Source]]		* [[Sample Script: client.pl\|View Source]]

Digimer: /* Logical Order */

2012-02-11T19:27:26Z

Logical Order

← Older revision		Revision as of 19:27, 11 February 2012
Line 213:		Line 213:
	In order to use a method published on a message bus, we need some information on how to find it. In order, that is;		In order to use a method published on a message bus, we need some information on how to find it. In order, that is;

			<source lang="bash">
	# Address; how and where clients connect to the server.		# Address; how and where clients connect to the server.
	# Bus Name; Where on the bus is the program we are or want to connect to. Not		# Bus Name; Where on the bus is the program we are or want to connect to. Not
Line 222:		Line 223:
	reasons.		reasons.
	# Method; This is the actually method we what to use.		# Method; This is the actually method we what to use.
			</source>

	== High-Level Overview of the Low Level DBus API ==		== High-Level Overview of the Low Level DBus API ==

Digimer: /* Service */

2012-02-11T19:22:19Z

Service

← Older revision		Revision as of 19:22, 11 February 2012
Line 172:		Line 172:
	To use [[HAL]] as an example, and to tie all the components together, the interface 'org.freedesktop.Hal.Manager.GetAllDevices' can be broken up like this:		To use [[HAL]] as an example, and to tie all the components together, the interface 'org.freedesktop.Hal.Manager.GetAllDevices' can be broken up like this:

			<source lang="text">
	org.freedesktop.Hal.Manager.GetAllDevices		org.freedesktop.Hal.Manager.GetAllDevices
	\| \| \| \| \-----------/ <= The name of the method.		\| \| \| \| \-----------/ <= The name of the method.
Line 177:		Line 178:
	\|-------------+--/ <======================== Service, name of the HAL server.		\|-------------+--/ <======================== Service, name of the HAL server.
	\------------/ <============================ Name space used by 'Freedesktop.org'.		\------------/ <============================ Name space used by 'Freedesktop.org'.
			</source>

	As an exercise in showing a full interface using Perl terminology, you might say:		As an exercise in showing a full interface using Perl terminology, you might say:

			<source lang="text">
	\/=================================== The namespace used by Freedesktop.org.		\/=================================== The namespace used by Freedesktop.org.
	/-------------\		/-------------\
Line 188:		Line 191:
	\| \==================== The name of the perl module you are using.		\| \==================== The name of the perl module you are using.
	\================================== The program itself.		\================================== The program itself.
			</source>

	== Unique Connection Name ==		== Unique Connection Name ==

Digimer: /* Object */

2012-02-11T19:21:52Z

Object

← Older revision		Revision as of 19:21, 11 February 2012
Line 134:		Line 134:
	For example, you may have an object with two methods and a signal and a parameter published under it. Let's say the methods are '<span class="code">ClientConnect</span>' and '<span class="code">ClientDisconnect</span>', the signal is called '<span class="code">ClientAnnounce</span>' and a writable property called '<span class="code">ClientOnlineSince</span>'. Lets then say that we use the object path '<span class="code">/org/tle-bu</span>' to publish them under. Thus, we can access these objects at:		For example, you may have an object with two methods and a signal and a parameter published under it. Let's say the methods are '<span class="code">ClientConnect</span>' and '<span class="code">ClientDisconnect</span>', the signal is called '<span class="code">ClientAnnounce</span>' and a writable property called '<span class="code">ClientOnlineSince</span>'. Lets then say that we use the object path '<span class="code">/org/tle-bu</span>' to publish them under. Thus, we can access these objects at:

	/org/tle-bu/ClientConnect		<source lang="text">
	/org/tle-bu/ClientDisconnect		/org/tle-bu/ClientConnect
	/org/tle-bu/ClientAnnounce		/org/tle-bu/ClientDisconnect
	/org/tle-bu/ClientOnlineSince		/org/tle-bu/ClientAnnounce
			/org/tle-bu/ClientOnlineSince
			</source>

	A real-world example would be [[HAL]]'s '<span class="code">Manager</span>' object which is found at the path:		A real-world example would be [[HAL]]'s '<span class="code">Manager</span>' object which is found at the path:

	/org/freedesktop/Hal/Manager		<source lang="text">
			/org/freedesktop/Hal/Manager
			</source>

	Please note that the object's path does not need to match the program's namespace, or even be human-readable. It is simply "best practice", and may well not make sense for your application.		Please note that the object's path does not need to match the program's namespace, or even be human-readable. It is simply "best practice", and may well not make sense for your application.

Digimer at 03:07, 12 October 2009

2009-10-12T03:07:03Z

← Older revision		Revision as of 03:07, 12 October 2009
Line 2:		Line 2:

	Introduction to the Perl DBus Binding '<span class="code">Net::DBus</span>'.		Introduction to the Perl DBus Binding '<span class="code">Net::DBus</span>'.

			'''Note''': This section needs updating. Since writing this I have written a more concise introduction to <span class="code">Net::DBus</span> with working examples. Please see: [[TPM Talk: An Introduction to 'D-Bus' in Perl]]

	= Introduction =		= Introduction =

Digimer: /* Simple Client */

2009-10-12T01:26:53Z

Simple Client

← Older revision		Revision as of 01:26, 12 October 2009
Line 223:		Line 223:
	This shows simple how to connect to a bus, connect to a service on that bus, get a handle to an interface and one of it's methods and add a few handles. It uses [[HAL]] to show these methods.		This shows simple how to connect to a bus, connect to a service on that bus, get a handle to an interface and one of it's methods and add a few handles. It uses [[HAL]] to show these methods.

	* [~~http~~://~~wiki~~.~~tle-bu.org~~/~~files~~/dbus_tutorial/client.pl Simple DBus Client] (3,997 bytes, '.pl' perl script).		* [https://alteeve.com/local/dbus_tutorial/client.pl Simple DBus Client] (3,997 bytes, '.pl' perl script).
	* [[Sample Script: client.pl\|View Source]]		* [[Sample Script: client.pl\|View Source]]

Digimer: /* Well Known Name */

2009-10-12T01:24:07Z

Well Known Name

← Older revision		Revision as of 01:24, 12 October 2009
Line 189:		Line 189:
	== Well Known Name ==		== Well Known Name ==

	Well known names in DBus are similar to domain names on the Internet; They simply map to a UCN. This way, a program could be written that will always look for a particular server, method or object and not need to worry about where it actually is. To continue the network analogy; This allows you to say "I want to connect to ~~http~~://~~domain~~.com" and not need to worry about what the underlying IP address is, even if it changes.		Well known names in DBus are similar to domain names on the Internet; They simply map to a UCN. This way, a program could be written that will always look for a particular server, method or object and not need to worry about where it actually is. To continue the network analogy; This allows you to say "I want to connect to https://alteeve.com" and not need to worry about what the underlying IP address is, even if it changes.

	Often times a program will (arbitrarily) define that a given program, say "<span class="code">org.freedesktop.TextEditor</span>" must publish an object at "<span class="code">/org/freedesktop/TextFileManager</span>" and support the interface "<span class="code">org.freedesktop.FileHandler</span>". These conventions are not enforced by DBus however.		Often times a program will (arbitrarily) define that a given program, say "<span class="code">org.freedesktop.TextEditor</span>" must publish an object at "<span class="code">/org/freedesktop/TextFileManager</span>" and support the interface "<span class="code">org.freedesktop.FileHandler</span>". These conventions are not enforced by DBus however.

Digimer: /* First, Some Key Definitions */

2009-10-12T01:17:23Z

First, Some Key Definitions

← Older revision		Revision as of 01:17, 12 October 2009
Line 47:		Line 47:
	If you are unfamiliar with Object Oriented concepts and terms, you may be well served by reading [http://perldoc.perl.org/perltoot.html perltoot]. Read it either on the web or, if you have '<span class="code">perldoc</span>' installed, by running:		If you are unfamiliar with Object Oriented concepts and terms, you may be well served by reading [http://perldoc.perl.org/perltoot.html perltoot]. Read it either on the web or, if you have '<span class="code">perldoc</span>' installed, by running:

	<bash>		<source lang="bash">
	perldoc perltoot		perldoc perltoot
	</~~bash~~>		</source>

	== Address ==		== Address ==
Line 55:		Line 55:
	An address is simply the point at which it watches for connections from clients on. This could be a [[UNIX]] socket, a TCP address, a memory address or some future address that may be added to DBus in the future.		An address is simply the point at which it watches for connections from clients on. This could be a [[UNIX]] socket, a TCP address, a memory address or some future address that may be added to DBus in the future.

	~~Exampled~~:		Example:
	* <span class="font">unix:path=/path/to/socket</span> Server listens on the defined UNIX socket file.		* <span class="font">unix:path=/path/to/socket</span> Server listens on the defined UNIX socket file.
	* <span class="font"></span>

	== Binding ==		== Binding ==

Digimer: /* First, Some Key Definitions */

2009-10-12T01:14:09Z

First, Some Key Definitions

← Older revision		Revision as of 01:14, 12 October 2009
Line 45:		Line 45:
	* [http://dbus.freedesktop.org/doc/dbus-specification.html#id311617 The official DBus Glossary]		* [http://dbus.freedesktop.org/doc/dbus-specification.html#id311617 The official DBus Glossary]

	If you are unfamiliar with Object Oriented concepts and terms, you may be well served by reading [http://perldoc.perl.org/perltoot.html perltoot]. Read it either on the web or, if you have '<span class="code">perldoc</span>' installed, by running '<~~span class="code"~~>$ perldoc perltoot</~~span~~>'		If you are unfamiliar with Object Oriented concepts and terms, you may be well served by reading [http://perldoc.perl.org/perltoot.html perltoot]. Read it either on the web or, if you have '<span class="code">perldoc</span>' installed, by running:

			<bash>
			perldoc perltoot
			</bash>

	== Address ==		== Address ==