/usr/share/doc/python-dbus-doc/api/dbus.proxies.ProxyObject-class.html is in python-dbus-doc 1.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>dbus.proxies.ProxyObject</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="dbus-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="dbus-module.html">Package dbus</a> ::
<a href="dbus.proxies-module.html" onclick="show_private();">Module proxies</a> ::
Class ProxyObject
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="dbus.proxies.ProxyObject-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ProxyObject</h1><p class="nomargin-top"><span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">ProxyObject</strong>
</pre>
<hr />
<p>A proxy to the remote Object.</p>
<p>A ProxyObject is provided by the Bus. ProxyObjects
have member functions, and can be called like normal Python objects.</p>
<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Nested Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-NestedClasses"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="dbus.proxies._ProxyMethod-class.html" class="summary-name">ProxyMethodClass</a><br />
A proxy method.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="dbus.proxies._DeferredMethod-class.html" class="summary-name">DeferredMethodClass</a><br />
A proxy method which will only get called once we have its
introspection reply.
</td>
</tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="dbus.proxies.ProxyObject-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">conn</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">bus_name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">object_path</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">introspect</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">follow_name_owner_changes</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Initialize the proxy object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="dbus.proxies.ProxyObject-class.html#connect_to_signal" class="summary-sig-name">connect_to_signal</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">signal_name</span>,
<span class="summary-sig-arg">handler_function</span>,
<span class="summary-sig-arg">dbus_interface</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**keywords</span>)</span><br />
Arrange for the given function to be called when the given signal
is received.</td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.connect_to_signal">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_Introspect"></a><span class="summary-sig-name">_Introspect</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject._Introspect">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_introspect_execute_queue"></a><span class="summary-sig-name">_introspect_execute_queue</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject._introspect_execute_queue">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_introspect_reply_handler"></a><span class="summary-sig-name">_introspect_reply_handler</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">data</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject._introspect_reply_handler">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_introspect_error_handler"></a><span class="summary-sig-name">_introspect_error_handler</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">error</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject._introspect_error_handler">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_introspect_block"></a><span class="summary-sig-name">_introspect_block</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject._introspect_block">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_introspect_add_to_queue"></a><span class="summary-sig-name">_introspect_add_to_queue</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">callback</span>,
<span class="summary-sig-arg">args</span>,
<span class="summary-sig-arg">kwargs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject._introspect_add_to_queue">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__getattr__"></a><span class="summary-sig-name">__getattr__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">member</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.__getattr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="dbus.proxies.ProxyObject-class.html#get_dbus_method" class="summary-sig-name">get_dbus_method</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">member</span>,
<span class="summary-sig-arg">dbus_interface</span>=<span class="summary-sig-default">None</span>)</span><br />
Return a proxy method representing the given D-Bus method. The
returned proxy method can be called in the usual way. For instance,</td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.get_dbus_method">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="dbus.proxies.ProxyObject-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.__repr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="dbus.proxies.ProxyObject-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.__repr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="INTROSPECT_STATE_DONT_INTROSPECT"></a><span class="summary-name">INTROSPECT_STATE_DONT_INTROSPECT</span> = <code title="0">0</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="INTROSPECT_STATE_INTROSPECT_IN_PROGRESS"></a><span class="summary-name">INTROSPECT_STATE_INTROSPECT_IN_PROGRESS</span> = <code title="1">1</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="INTROSPECT_STATE_INTROSPECT_DONE"></a><span class="summary-name">INTROSPECT_STATE_INTROSPECT_DONE</span> = <code title="2">2</code>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="dbus.proxies.ProxyObject-class.html#bus_name" class="summary-name">bus_name</a><br />
The bus name to which this proxy is bound. (Read-only,
may change.)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="dbus.proxies.ProxyObject-class.html#requested_bus_name" class="summary-name">requested_bus_name</a><br />
The bus name which was requested when this proxy was
instantiated.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="dbus.proxies.ProxyObject-class.html#object_path" class="summary-name">object_path</a><br />
The object-path of this proxy.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">conn</span>=<span class="sig-default">None</span>,
<span class="sig-arg">bus_name</span>=<span class="sig-default">None</span>,
<span class="sig-arg">object_path</span>=<span class="sig-default">None</span>,
<span class="sig-arg">introspect</span>=<span class="sig-default">True</span>,
<span class="sig-arg">follow_name_owner_changes</span>=<span class="sig-default">False</span>,
<span class="sig-arg">**kwargs</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.__init__">source code</a></span>
</td>
</tr></table>
Initialize the proxy object.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>conn</code></strong> (<a href="dbus.connection.Connection-class.html" class="link">dbus.connection.Connection</a>) - The bus or connection on which to find this object.
The keyword argument <a href="dbus.bus-module.html" class="link" onclick="show_private();">bus</a> is a deprecated alias for this.</li>
<li><strong class="pname"><code>bus_name</code></strong> (str) - A bus name for the application owning the object, to be used
as the destination for method calls and the sender for
signal matches. The keyword argument <tt class="rst-docutils literal">named_service</tt> is a
deprecated alias for this.</li>
<li><strong class="pname"><code>object_path</code></strong> (str) - The object path at which the application exports the object</li>
<li><strong class="pname"><code>introspect</code></strong> (bool) - If true (default), attempt to introspect the remote
object to find out supported methods and their signatures</li>
<li><strong class="pname"><code>follow_name_owner_changes</code></strong> (bool) - If true (default is false) and the <a href="dbus.proxies.ProxyObject-class.html#bus_name" class="link">bus_name</a> is a
well-known name, follow ownership changes for that name</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="connect_to_signal"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">connect_to_signal</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">signal_name</span>,
<span class="sig-arg">handler_function</span>,
<span class="sig-arg">dbus_interface</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**keywords</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.connect_to_signal">source code</a></span>
</td>
</tr></table>
Arrange for the given function to be called when the given signal
is received.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>signal_name</code></strong> (str) - The name of the signal</li>
<li><strong class="pname"><code>handler_function</code></strong> (callable) - A function to be called when the signal is emitted by
the remote object. Its positional arguments will be the
arguments of the signal; optionally, it may be given
keyword arguments as described below.</li>
<li><strong class="pname"><code>dbus_interface</code></strong> (str) - Optional interface with which to qualify the signal name.
If None (the default) the handler will be called whenever a
signal of the given member name is received, whatever
its interface.</li>
<li><strong class="pname"><code>utf8_strings</code></strong> (bool) - If True, the handler function will receive any string
arguments as dbus.UTF8String objects (a subclass of str
guaranteed to be UTF-8). If False (default) it will receive
any string arguments as dbus.String objects (a subclass of
unicode).</li>
<li><strong class="pname"><code>byte_arrays</code></strong> (bool) - If True, the handler function will receive any byte-array
arguments as dbus.ByteArray objects (a subclass of str).
If False (default) it will receive any byte-array
arguments as a dbus.Array of dbus.Byte (subclasses of:
a list of ints).</li>
<li><strong class="pname"><code>sender_keyword</code></strong> (str) - If not None (the default), the handler function will receive
the unique name of the sending endpoint as a keyword
argument with this name</li>
<li><strong class="pname"><code>destination_keyword</code></strong> (str) - If not None (the default), the handler function will receive
the bus name of the destination (or None if the signal is a
broadcast, as is usual) as a keyword argument with this name.</li>
<li><strong class="pname"><code>interface_keyword</code></strong> (str) - If not None (the default), the handler function will receive
the signal interface as a keyword argument with this name.</li>
<li><strong class="pname"><code>member_keyword</code></strong> (str) - If not None (the default), the handler function will receive
the signal name as a keyword argument with this name.</li>
<li><strong class="pname"><code>path_keyword</code></strong> (str) - If not None (the default), the handler function will receive
the object-path of the sending object as a keyword argument
with this name</li>
<li><strong class="pname"><code>message_keyword</code></strong> (str) - If not None (the default), the handler function will receive
the <a href="dbus.lowlevel.SignalMessage-class.html" class="link">dbus.lowlevel.SignalMessage</a> as a keyword argument with
this name.</li>
<li><strong class="pname"><code>arg...</code></strong> (unicode or UTF-8 str) - If there are additional keyword parameters of the form
<tt class="rst-docutils literal">arg</tt><em>n</em>, match only signals where the <em>n</em>th argument
is the value given for that keyword parameter. As of this time
only string arguments can be matched (in particular,
object paths and signatures can't).</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="get_dbus_method"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_dbus_method</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">member</span>,
<span class="sig-arg">dbus_interface</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.get_dbus_method">source code</a></span>
</td>
</tr></table>
<p>Return a proxy method representing the given D-Bus method. The
returned proxy method can be called in the usual way. For instance,</p>
<pre class="rst-literal-block">
proxy.get_dbus_method("Foo", dbus_interface='com.example.Bar')(123)
</pre>
<p>is equivalent to:</p>
<pre class="rst-literal-block">
proxy.Foo(123, dbus_interface='com.example.Bar')
</pre>
<p>or even:</p>
<pre class="rst-literal-block">
getattr(proxy, "Foo")(123, dbus_interface='com.example.Bar')
</pre>
<p>However, using <a href="dbus.proxies.ProxyObject-class.html#get_dbus_method" class="link">get_dbus_method</a> is the only way to call D-Bus
methods with certain awkward names - if the author of a service
implements a method called <tt class="rst-docutils literal">connect_to_signal</tt> or even
<tt class="rst-docutils literal">__getattr__</tt>, you'll need to use <a href="dbus.proxies.ProxyObject-class.html#get_dbus_method" class="link">get_dbus_method</a> to call them.</p>
<p>For services which follow the D-Bus convention of CamelCaseMethodNames
this won't be a problem.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.__repr__">source code</a></span>
</td>
</tr></table>
str(x)
<dl class="fields">
<dt>Overrides:
object.__repr__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="dbus.proxies-pysrc.html#ProxyObject.__repr__">source code</a></span>
</td>
</tr></table>
str(x)
<dl class="fields">
<dt>Overrides:
object.__str__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Property Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-PropertyDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="bus_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">bus_name</h3>
<p>The bus name to which this proxy is bound. (Read-only,
may change.)</p>
<p>If the proxy was instantiated using a unique name, this property
is that unique name.</p>
<p>If the proxy was instantiated with a well-known name and with
<tt class="rst-docutils literal">follow_name_owner_changes</tt> set false (the default), this
property is the unique name of the connection that owned that
well-known name when the proxy was instantiated, which might
not actually own the requested well-known name any more.</p>
<p>If the proxy was instantiated with a well-known name and with
<tt class="rst-docutils literal">follow_name_owner_changes</tt> set true, this property is that
well-known name.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">self</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="requested_bus_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">requested_bus_name</h3>
The bus name which was requested when this proxy was
instantiated.
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">self</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="object_path"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">object_path</h3>
The object-path of this proxy.
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>(<span class="summary-sig-arg">self</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="dbus-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Jun 3 19:32:21 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|