phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-04-29 14:59:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

doc: Improve IPC interface comments

Browse source 
Fix some comments that were referring to previous versions of these methods and
did not make sense.
This commit is contained in:
Ryan Ofsky 2025-04-24 15:13:05 -04:00
parent 8ca7049cea
commit 6427d6f175
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/interfaces/ipc.h
View file

@ -59,15 +59,15 @@ public:
//! true. If this is not a spawned child process, return false. //! true. If this is not a spawned child process, return false.
virtual bool startSpawnedProcess(int argc, char* argv[], int& exit_status) = 0; virtual bool startSpawnedProcess(int argc, char* argv[], int& exit_status) = 0;
//! Connect to a socket address and make a client interface proxy object //! Connect to a socket address and return a pointer to its Init interface.
//! using provided callback. connectAddress returns an interface pointer if //! Returns a non-null pointer if the connection was established, returns
//! the connection was established, returns null if address is empty ("") or //! null if address is empty ("") or disabled ("0") or if a connection was
//! disabled ("0") or if a connection was refused but not required ("auto"), //! refused but not required ("auto"), and throws an exception if there was
//! and throws an exception if there was an unexpected error. //! an unexpected error.
virtual std::unique_ptr<Init> connectAddress(std::string& address) = 0; virtual std::unique_ptr<Init> connectAddress(std::string& address) = 0;
//! Connect to a socket address and make a client interface proxy object //! Listen on a socket address exposing this process's init interface to
//! using provided callback. Throws an exception if there was an error. //! clients. Throws an exception if there was an error.
virtual void listenAddress(std::string& address) = 0; virtual void listenAddress(std::string& address) = 0;
//! Disconnect any incoming connections that are still connected. //! Disconnect any incoming connections that are still connected.