net::dbus::annotation(3pm) [debian man page]

Net::DBus::Annotation(3pm)				User Contributed Perl Documentation				Net::DBus::Annotation(3pm)

NAME

       Net::DBus::Annotation - annotations for changing behaviour of APIs

SYNOPSIS

	 use Net::DBus::Annotation qw(:call);

	 my $object = $service->get_object("/org/example/systemMonitor");

	 # Block until processes are listed
	 my $processes = $object->list_processes("someuser");

	 # Just throw away list of processes, pretty pointless
	 # in this example, but useful if the method doesn't have
	 # a return value
	 $object->list_processes(dbus_call_noreply, "someuser");

	 # List processes & get on with other work until
	 # the list is returned.
	 my $asyncreply = $object->list_processes(dbus_call_async, "someuser");

	 ... some time later...
	 my $processes = $asyncreply->get_data;

DESCRIPTION

       This module provides a number of annotations which will be useful when dealing with the DBus APIs. There are annotations for switching
       remote calls between sync, async and no-reply mode. More annotations may be added over time.

METHODS

       dbus_call_sync
	   Requests that a method call be performed synchronously, waiting for the reply or error return to be received before continuing.

       dbus_call_async
	   Requests that a method call be performed a-synchronously, returning a pending call object, which will collect the reply when it
	   eventually arrives.

       dbus_call_noreply
	   Requests that a method call be performed a-synchronously, discarding any possible reply or error message.

AUTHOR

       Daniel Berrange <dan@berrange.com>

COPYRIGHT

       Copright (C) 2006-2011, Daniel Berrange.

SEE ALSO

       Net::DBus, Net::DBus::RemoteObject

perl v5.14.2							    2011-06-30						Net::DBus::Annotation(3pm)

Net::DBus::Binding::PendingCall(3pm)			User Contributed Perl Documentation		      Net::DBus::Binding::PendingCall(3pm)

NAME

       Net::DBus::Binding::PendingCall - A handler for pending method replies

SYNOPSIS

	 my $call = Net::DBus::Binding::PendingCall->new(method_call => $call,
							 pending_call => $reply);

	 # Wait for completion
	 $call->block;

	 # And get the reply message
	 my $msg = $call->get_reply;

DESCRIPTION

       This object is used when it is necessary to make asynchronous method calls. It provides the means to be notified when the reply is finally
       received.

METHODS

       my $call = Net::DBus::Binding::PendingCall->new(method_call => $method_call, pending_call => $pending_call);
	   Creates a new pending call object, with the "method_call" parameter being a reference to the "Net::DBus::Binding::Message::MethodCall"
	   object whose reply is being waiting for. The "pending_call" parameter is a reference to the raw C pending call object.

       $call->cancel
	   Cancel the pending call, causing any reply that is later received to be discarded.

       my $boolean = $call->get_completed
	   Returns a true value if the pending call has received its reply, or a timeout has occurred.

       $call->block
	   Block the caller until the reply is received or a timeout occurrs.

       my $msg = $call->get_reply;
	   Retrieves the "Net::DBus::Binding::Message" object associated with the complete call.

       $call->set_notify($coderef);
	   Sets a notification function to be invoked when the pending call completes. The callback will be passed a single argument which is this
	   pending call object.

AUTHOR

       Daniel P. Berrange

COPYRIGHT

       Copyright (C) 2006-2011 Daniel P. Berrange

SEE ALSO

       Net::DBus::Binding::Connection, Net::DBus::Binding::Message, Net::DBus::ASyncReply

perl v5.14.2							    2011-06-30				      Net::DBus::Binding::PendingCall(3pm)