Skip to content

Commit 616d9a7

Browse files
committed
doc: Document ProxyClientBase destroy_connection option
Suggested by Sjors Provoost <[email protected]> #160 (comment)
1 parent 56fff76 commit 616d9a7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

include/mp/proxy.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,15 @@ class ProxyClientBase : public Impl_
8989
using Sub = ProxyClient<Interface>;
9090
using Super = ProxyClientBase<Interface, Impl>;
9191

92+
//! Construct libmultiprocess client object wrapping Cap'n Proto client
93+
//! object with a reference to the associated mp::Connection object.
94+
//!
95+
//! The destroy_connection option determines whether destroying this client
96+
//! object closes the connection. It is set to true for the
97+
//! ProxyClient<InitInterface> object returned by ConnectStream, to let IPC
98+
//! clients close the connection by freeing the object. It is false for
99+
//! other client objects so they can be destroyed without affecting the
100+
//! connection.
92101
ProxyClientBase(typename Interface::Client client, Connection* connection, bool destroy_connection);
93102
~ProxyClientBase() noexcept;
94103

0 commit comments

Comments
 (0)