feedc0de/sdbus-cpp
1
0
Fork 0
forked from Kistler-Group/sdbus-cpp
Code Pull Requests Activity

Add essential information to doxy comments of createObjectProxy

Browse Source
This commit is contained in:
sangelovic
2019-01-25 19:24:20 +01:00
parent 0b27f222c4
commit 1dafd6262c
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/sdbus-c++/IObjectProxy.h
View File

@@ -223,7 +223,11 @@ namespace sdbus {
* @return Pointer to the object proxy instance
*
* The provided connection will be used by the proxy to issue calls against the object,
* and signals, if any, will be subscribed to on this connection.
* and signals, if any, will be subscribed to on this connection. Since the caller still
* remains the owner of the connection (the proxy just keeps reference to it) after the call,
* the proxy will not start its own background processing loop for incoming signals (if any),
* as it will rely on the client as an owner of the connection to handle processing of
* incoming messages on that connection by themselves.
*
* Code example:
* @code
@@ -244,7 +248,10 @@ namespace sdbus {
*
* The provided connection will be used by the proxy to issue calls against the object,
* and signals, if any, will be subscribed to on this connection. Object proxy becomes
* an exclusive owner of this connection.
* an exclusive owner of this connection. The effect of this is that when there is at
* least one signal in proxy's interface, then the proxy will immediately start its own
* processing loop for this connection in a separate internal thread, causing incoming
* signals to be correctly received and processed in the context of that internal thread.
*
* Code example:
* @code
@@ -263,6 +270,9 @@ namespace sdbus {
* @return Pointer to the object proxy instance
*
* This factory overload creates a proxy that manages its own D-Bus connection(s).
* When there is at least one signal in proxy's interface, then the proxy will immediately
* start its own processing loop for this connection in its own separate thread, causing
* incoming signals to be correctly received and processed in the context of that thread.
*
* Code example:
* @code