Skip to content

Commit 408c5ad

Browse files
committed
doc UPDATE details about NC version for unix proxy messages
1 parent 94e1588 commit 408c5ad

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/proxy_unix.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ int nc_proxy_unix_connect(const char *address, const char *username);
4444
/**
4545
* @brief Read a full chunked-framing message from a FD.
4646
*
47+
* Set @p version according to the current [NETCONF specification](https://datatracker.ietf.org/doc/html/rfc6241#section-8.1).
48+
* That will almost always result in using NETCONF 1.0 encapsulation for the hello message (first exchanged message)
49+
* and NETCONF 1.1 for all the following messages (as long as the server supports this NETCONF version).
50+
*
4751
* @param[in] fd File descriptor to read from.
4852
* @param[in] version NETCONF version to use for message encapsulation.
4953
* @param[in] timeout_ms Timeout for reading in milliseconds. Use negative value for blocking read, 0 for non-blocking read.
@@ -60,6 +64,8 @@ int nc_proxy_read_msg(int fd, NC_PROT_VERSION version, int timeout_ms, char **bu
6064
*
6165
* Keeps writing until all the data are written or a fatal error is encountered.
6266
*
67+
* Set @p version based on the information for ::nc_proxy_read_msg().
68+
*
6369
* @param[in] fd File descriptor to write to.
6470
* @param[in] version NETCONF version to use for message encapsulation.
6571
* @param[in] buf Buffer with the message to write.

0 commit comments

Comments
 (0)