Add nxlinkConnectToHost note about the socket driver

Add a comment that the socket driver must be initialized prior to calling this function, otherwise this function will fail.
This commit is contained in:
alloncm 2025-04-26 18:44:18 +03:00 committed by GitHub
parent 60bf943ec1
commit 6744eb5705
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -21,6 +21,7 @@ extern struct in_addr __nxlink_host;
* @param[in] redirStderr Whether to redirect stderr to nxlink output.
* @return Socket fd on success, negative number on failure.
* @note The socket should be closed with close() during application cleanup.
* The socket driver must be initialized, otherwise the call will fail.
*/
int nxlinkConnectToHost(bool redirStdout, bool redirStderr);