https://alteeve.com/w/index.php?action=history&feed=atom&title=Net%3A%3ADBus_MethodsNet::DBus Methods - Revision history2026-06-11T09:23:38ZRevision history for this page on the wikiMediaWiki 1.42.3https://alteeve.com/w/index.php?title=Net::DBus_Methods&diff=432&oldid=prevDigimer: Created page with '{{dbtut_header}} = find = Usage: <source lang="perl">my $bus=Net::DBus->find(%params);</source> Where '<span class="code">$bus</span>' is a handle to either the '<span class="…'2009-10-12T01:43:44Z<p>Created page with '{{dbtut_header}} = find = Usage: <source lang="perl">my $bus=Net::DBus->find(%params);</source> Where '<span class="code">$bus</span>' is a handle to either the '<span class="…'</p>
<p><b>Páàjì titun</b></p><div>{{dbtut_header}}<br />
<br />
= find =<br />
<br />
Usage:<br />
<source lang="perl">my $bus=Net::DBus->find(%params);</source><br />
<br />
Where '<span class="code">$bus</span>' is a handle to either the '<span class="code">system</span>' or '<span class="code">session</span>' bus, as chosen by '<span class="code">find</span>'.<br />
<br />
This attempts to determine which bus, '<span class="code">system</span>' or '<span class="code">session</span>', is best to connect to. It does this by examining a few system variables. They are, in order that they are searched:<br />
<br />
* '<span class="code">DBUS_STARTER_BUS_TYPE</span>'; If defined and equals '<span class="code">session</span>', it returns a connection to the session bus.<br />
* '<span class="code">DBUS_STARTER_BUS_TYPE</span>'; If defined and equals '<span class="code">system</span>', it returns a connection to the system bus.<br />
* '<span class="code">DBUS_SESSION_BUS_ADDRESS</span>'; If exists, returns a connection to the session bus.<br />
* Failing the above, it returns a connection to the system bus.<br />
<br />
= system =<br />
<br />
Usage:<br />
<source lang="perl">my $bus=Net::DBus->system(%params);</source><br />
<br />
This simply returns a connection to the (default/Freedesktop.org?) DBus '<span class="code">system</span>' bus. Given that the system bus is available to all programs and users on the system, certain restrictions are in effect.<br />
<br />
= session =<br />
<br />
Usage:<br />
<source lang="perl">my $bus=Net::DBus->session(%params);</source><br />
<br />
This simply returns a connection to the (default/Freedesktop.org?) DBus '<span class="code">session</span>' bus. This bus is only accessible by the user invoking the connection.<br />
<br />
= new =<br />
<br />
Usage:<br />
<source lang="perl">my $bus=Net::DBus->new($address, %params);</source><br />
<br />
This returns a connection to a specified, user-defined bus. It is used when you want to connect to a bus other than the default '<span class="code">system</span>' or '<span class="code">session</span>' bus.<br />
<br />
Where;<br />
'<span class="code">$address</span>' is the address of a bus to connect to. This value may look like;<br />
* <span class="code">my $address="unix:abstract=/tmp/dbus-PBFyyuUiVb,guid=191e0a43c3efc222e0818be556d67500";</span> (connect to a 'session' bus.)<br />
* <span class="code">my $address="unix:/var/run/dbus/system_bus_socket";</span> (connect to a 'system' bus.)<br />
<br />
= get_service =<br />
<br />
Usage:<br />
<source lang="perl">my $service=$bus->get_service($name);</source><br />
<br />
This returns a handle to the remote service specified in the '$name' variable. <br />
<br />
When the name is not "<span class="code">org.freedesktop.DBus</span>", this method checks to see if the name *doesn't* start with a colon (:). If it doesn't, it tries to see if the owner of the service can be determined using the '<span class="code">get_service_owner</span>' method. Should that fail, it will try to start the remote service using the '<span class="code">get_bus_object->StartServiceByName</span>' method and then tries to determine the owner again. Finally, the local list of services are checked for a matching name and, if found, it is returned. If a local service of the given name is not found, '<span class="code">Net::DBus::RemoteService->new</span>' is called and the returned handle is fed into a local service of the same name and that is returned.<br />
<br />
Where;<br />
'<span class="code">$name</span>' can be;<br />
* "<span class="code">org.freedesktop.DBus</span>" which simply returns a connection to the default bus service. (accurate?)<br />
* A value that does not begin with '<span class="code">:</span>'.<br />
* (others valid? If so, what restrictions?)<br />
<br />
= export_service =<br />
<br />
Usage:<br />
<source lang="perl">my $service=$bus->export_service($name);</source><br />
<br />
This takes a name and registers a service by that name on the bus. A handle to the new service is returned.<br />
<br />
= get_bus_object =<br />
<br />
Usage:<br />
<source lang="perl">my $object=$bus->get_bus_object;</source><br />
<br />
Returns a handle to the bus object "<span class="code">/org/freedesktop/DBus</span>" provided by the service '<span class="code">org.freedesktop.DBus</span>'.<br />
* When would this be used? What about when using a custom bus?<br />
<br />
= get_unique_name =<br />
<br />
Usage:<br />
<source lang="perl">my $name=$bus->get_unique_name;</source><br />
<br />
This returns the unique name of the active client's connection to the bus.<br />
<br />
= get_service_owner =<br />
<br />
Usage:<br />
<source lang="perl">my $name = $bus->get_service_owner($service);</source><br />
<br />
This takes the name of a service and returns the unique name of the client on the bus that owns that service. The method '<span class="code">$bus->GetNameOwner($service);</span>' is called in an '<span class="code">eval</span>'. If a value is retrieved, it is returned. If an error is raised and the error is "<span class="code">org.freedesktop.DBus.Error.NameHasNoOwner</span>", '<span class="code">undef</span>' is returned. Otherwise an exception is thrown and the error set by the '<span class="code">eval</span>' is displayed.<br />
<br />
= 'Typing' Methods =<br />
<br />
Normally, introspection data is provided by a service so a client will not need to specifically define the type of data being used. If the introspection data is not complete though, you may need to explicitely specify the data typing.<br />
<br />
Before you can use any of the following typing methods, you will need to change how you call '<span class="code">Net::DBus</span>' to explicitly export the typing methods by using '<span class="code">use Net::DBus (:typing);</span>'.<br />
<br />
Please review the [[List of DBus data types]] to get a better feel for the various data types and signatures below.<br />
<br />
== dbus_int16 ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_int16($value);</source><br />
<br />
Mark a value as being a signed 16-bit integer. Valid values are (+/-) 0 to 65,535.<br />
<br />
== dbus_uint16 ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_uint16($value);</source><br />
<br />
Mark a value as being an unsigned 16-bit integer. Valid values are 0 to 65,535.<br />
<br />
== dbus_int32 ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_int32($value);</source><br />
<br />
Mark a value as being a signed 32-bit integer. Valid values are (+/-) 0 to 4,294,967,295.<br />
<br />
== dbus_uint32 ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_int32($value);</source><br />
<br />
Mark a value as being an unsigned 32-bit integer. Valid values are 0 to 4,294,967,295.<br />
<br />
== dbus_int64 ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_int64($value);</source><br />
<br />
Mark a value as being a signed 64-bit integer. Valid values are (+/-) 0 to 18,446,744,073,709,551,616.<br />
<br />
== dbus_uint64 ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_int64($value);</source><br />
<br />
Mark a value as being an unsigned 64-bit integer. Valid values are 0 to 18,446,744,073,709,551,616.<br />
<br />
== dbus_double ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_double($value);</source><br />
<br />
Mark a value as being a double-precision [[IEEE 754]] floating point value.<br />
<br />
== dbus_byte ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_byte($value);</source><br />
<br />
Mark a value as being a [[byte]].<br />
<br />
== dbus_string ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_string($value);</source><br />
<br />
Mark a value as being a UTF-8 encoded string. This is generally not needed as Perl's default scalar value is 'string'.<br />
<br />
== dbus_signature ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_signature($value);</source><br />
<br />
Mark a value as being a UTF-8 string whose value is a valid [[List_of_DBus_data_types|DBus type signature]].<br />
<br />
== dbus_object_path ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_object_path($value);</source><br />
<br />
Mark a value as being a UTF-8 string whose value is a valid DBus object path.<br />
<br />
== dbus_boolean ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_boolean($value);</source><br />
<br />
Mark a value as being a [[boolean]] value.<br />
<br />
== dbus_array ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_array($value);</source><br />
<br />
Mark a value as being a DBus array.<br />
<br />
== dbus_struct ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value=dbus_struct($value);</source><br />
<br />
Mark a value as being a DBus structure.<br />
<br />
== dbus_dict ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value = dbus_dict($value);</source><br />
<br />
Mark a value as being a DBus dictionary.<br />
<br />
== dbus_variant ==<br />
<br />
Usage:<br />
<source lang="perl">my $typed_value = dbus_variant($value);</source><br />
<br />
Mark a value as being a DBus variant.<br />
<br />
= get_connection =<br />
<br />
Usage:<br />
<source lang="perl">my $connection=$bus->get_connection;</source><br />
<br />
This returns a handle to the underlying connection object of the '<span class="code">$bus</span>'. Generally speaking, programmers won't need to use this. As such, you should avoid using this call unless you have a good reason to be doing so.<br />
- That said, an example of when you might want to this is ... (I think this should be defined, if only "for the record").<br />
* Calling '<span class="code">my $name=$bus->get_unique_name;</span>' simply calls '<span class="code">$bus->get_connection->get_unique_name;</span>'.<br />
<br />
= test =<br />
<br />
Usage:<br />
<source lang="perl">my $bus=Net::DBus->test(%params);</source><br />
<br />
This is used for unit testing. It connects to an in-memory bus used for testing purposes.<br />
{{footer}}</div>Digimer