Skip to content

Commit 0c28068

Browse files
committed
doc: Improve IPC interface comments
Fix some comments that were referring to previous versions of these methods and did not make sense.
1 parent 7f65aac commit 0c28068

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/interfaces/ipc.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ class Ipc
5959
//! true. If this is not a spawned child process, return false.
6060
virtual bool startSpawnedProcess(int argc, char* argv[], int& exit_status) = 0;
6161

62-
//! Connect to a socket address and make a client interface proxy object
63-
//! using provided callback. connectAddress returns an interface pointer if
64-
//! the connection was established, returns null if address is empty ("") or
65-
//! disabled ("0") or if a connection was refused but not required ("auto"),
66-
//! and throws an exception if there was an unexpected error.
62+
//! Connect to a socket address and return a pointer to its Init interface.
63+
//! Returns a non-null pointer if the connection was established, returns
64+
//! null if address is empty ("") or disabled ("0") or if a connection was
65+
//! refused but not required ("auto"), and throws an exception if there was
66+
//! an unexpected error.
6767
virtual std::unique_ptr<Init> connectAddress(std::string& address) = 0;
6868

69-
//! Connect to a socket address and make a client interface proxy object
70-
//! using provided callback. Throws an exception if there was an error.
69+
//! Listen on a socket address exposing this process's init interface to
70+
//! clients. Throws an exception if there was an error.
7171
virtual void listenAddress(std::string& address) = 0;
7272

7373
//! Disconnect any incoming connections that are still connected.

0 commit comments

Comments
 (0)