Codex

Net::DBus::Object

Section: User Contributed Perl Documentation (3pm)

Updated: 2011-06-30

Index?action=index Return to Main Contents


NAME

Net::DBus::Object - Provide objects to the bus for clients to use

SYNOPSIS

DESCRIPTION

This the base of all objects which are exported to the message bus. It provides the core support for type introspection required for objects exported to the message. When sub-classing this object, methods can be created & tested as per normal Perl modules. Then just as the Exporter module is used to export methods within a script, the Net::DBus::Exporter module is used to export methods (and signals) to the message bus.

All packages inheriting from this, will automatically have the interface registered with Net::DBus::Exporter, and the method within this exported.

METHODS

my $object = Net
:DBus::Object->new($service, $path):This creates a new DBus object with an path of registered within the service . The parameter should be a string complying with the usual DBus requirements for object paths, while the parameter should be an instance of Net::DBus::Service. The latter is typically obtained by calling the method on the Net::DBus object.:
my $object = Net
:DBus::Object->new($parentobj, $subpath):This creates a new DBus child object with an path of relative to its parent . The parameter should be a string complying with the usual DBus requirements for object paths, while the parameter should be an instance of Net::DBus::Object.:
$object->disconnect();
This method disconnects the object from the bus, such that it will no longer receive messages sent by other clients. Any child objects will be recursively disconnected too. After an object has been disconnected, it is possible for Perl to garbage collect the object instance. It will also make it possible to connect a newly created object to the same path.:
my $bool = $object->is_connected
Returns a true value if the object is connected to the bus, and thus capable of being accessed by remote clients. Returns false if the object is disconnected & thus ready for garbage collection. All objects start off in the connected state, and will only transition if the method is called.:
my $service = $object->get_service
Retrieves the Net::DBus::Service object within which this object is exported.:
my $path = $object->get_object_path
Retrieves the path under which this object is exported:
$object->emit_signal_in($name, $interface, $client, @args);
Emits a signal from the object, with a name of . If the parameter is defined, the signal will be scoped within that interface. If the parameter is defined, the signal will be unicast to that client on the bus. The signal and the data types of the arguments must have been registered with Net::DBus::Exporter by calling the method.:
$self->emit_signal_to($name, $client, @args);
Emits a signal from the object, with a name of . The signal and the data types of the arguments must have been registered with Net::DBus::Exporter by calling the method. The signal will be sent only to the client named by the parameter.:
$self->emit_signal($name, @args);
Emits a signal from the object, with a name of . The signal and the data types of the arguments must have been registered with Net::DBus::Exporter by calling the method. The signal will be broadcast to all clients on the bus.:
$object->connect_to_signal_in($name, $interface, $coderef);
Connects a callback to a signal emitted by the object. The parameter is the name of the signal within the object, and is a reference to an anonymous subroutine. When the signal is emitted by the remote object, the subroutine will be invoked, and passed the parameters from the signal. The parameter is used to specify the explicit interface defining the signal to connect to.:
$object->connect_to_signal($name, $coderef);
Connects a callback to a signal emitted by the object. The parameter is the name of the signal within the object, and is a reference to an anonymous subroutine. When the signal is emitted by the remote object, the subroutine will be invoked, and passed the parameters from the signal.:

AUTHOR

Daniel P. Berrange

COPYRIGHT

Copyright (C) 2005-2011 Daniel P. Berrange

SEE ALSO

Net::DBus, Net::DBus::Service, Net::DBus::RemoteObject, Net::DBus::Exporter.


Index

NAME

SYNOPSIS

DESCRIPTION

METHODS

AUTHOR

COPYRIGHT

SEE ALSO