Net::DB...Service(3)

🌈 NAME 🌈

Net::DBus::RemoteService — Access services provided on the bus.

okay so bestie, this page comes from the User Contributed Perl Documentation manual, and the full title is Net::DBus::RemoteService — it's the remote service handle situation, the thing that gives you access to services provided on the bus. 💖

---

✨ SYNOPSIS ✨

my $bus = Net::DBus->find;
my $service = $bus->get_service("org.freedesktop.DBus");

my $object = $service->get_object("/org/freedesktop/DBus");
foreach (@{$object->ListNames}) {
  print "$_\n";
}

---

🌸 DESCRIPTION 🌸

okay so this object is literally a handle to a remote service on the bus. From this handle it is possible to access objects associated with the service. And if a service is not running? No crisis — an attempt will be made to activate it the first time a method is called against one of its objects. 🦋

---

💅 METHODS 💅

here's the method menu, bestie — signatures stay exact, vibes stay immaculate ✨

🌟 new — new handle for a remote service

my $service = Net::DBus::RemoteService->new($bus, $owner, $service_name);

Creates a new handle for a remote service. The $bus parameter is an instance of Net::DBus, $owner is the name of the client providing the service, while $service_name is the well known name of the service on the bus. Service names consist of two or more tokens, separated by periods, while the tokens comprise the letters a-z, A-Z, 0-9 and _, for example "org.freedesktop.DBus". There is generally no need to call this constructor, instead the get_service method on Net::DBus should be used. This caches handles to remote services, eliminating repeated retrieval of introspection data.

🦋 get_bus — where's the bus at?

my $bus = $service->get_bus;

Retrieves a handle for the bus to which this service is attached. The returned object will be an instance of Net::DBus.

🎀 get_service_name — what's the service called?

my $service_name = $service->get_service_name

Retrieves the name of the remote service as known to the bus.

🐚 get_owner_name — who owns this service?

my $owner_name = $service->get_owner_name;

Retrieves the name of the client owning the service at the time it was connected to.

🧚 get_object — grab a remote object

my $object = $service->get_object($object_path[, $interface]);
my $object = $service->get_object($object_path, \%params);

Retrieves a handle to the remote object provided by the service with the name of $object_path. If the optional $interface parameter is provided, the object will immediately be cast to the designated interface. NB, it is only necessary to cast an object to a specific interface if there are multiple interfaces on the object providing methods with the same name, or the remote object does support introspection. The returned object will be an instance of Net::DBus::RemoteObject.

An alternate form of the method is available, passing a hash reference of extra parameters. Valid keys in the hash are "interface" specifying the interface name to cast to, and "timeout" specifying a timeout in milliseconds.

the original signature line has a stray =item wedged between the two forms — the two actual signatures are the ones above. 💀

yes, the caveat says or the remote object does support introspection — I'm repeating it exactly, no edits. 🙈

💜 timeout — set or read the timeout

my $timeout = $service->timeout(60 * 1000);

Sets or retrieves the timeout value which will be used for DBus requests that belong to this service. The value is in milliseconds. If the timeout for a service is undefined, then the default timeout from the bus will apply.

---

👑 AUTHOR 👑

Daniel Berrange <dan@berrange.com>

---

💀 COPYRIGHT 💀

The copyright line is literally:

Copright (C) 2004-2011, Daniel Berrange.

yes, it says Copright, not Copyright — I'm keeping it exactly, bestie. 💅

---

🔥 SEE ALSO 🔥

• Net::DBus::RemoteObject
• Net::DBus::Service
• Net::DBus

---

that's the whole page, bestie 🫶 — it's from perl v5.42.0, dated 2019-12-17, and the footer tags it Net::DB...Service(3). byeeee 💋