s3-util_sock: very brief documentation for open_socket_out().

The most important bit is to document that timeout is in MILLIseconds, not
seconds.

Guenther

diff --git a/source3/lib/util_sock.c b/source3/lib/util_sock.c
index b010c991f798bfdcce93ab065d184361727b41d1..71f6a8f29c91d676a4f1287a714846920cf335a8 100644 (file)
--- a/source3/lib/util_sock.c
+++ b/source3/lib/util_sock.c
@@ -983,6 +983,16 @@ NTSTATUS open_socket_out_recv(struct tevent_req *req, int *pfd)
        return NT_STATUS_OK;
 }
 
        return NT_STATUS_OK;
 }
 

+/**
+* @brief open a socket
+*
+* @param pss a struct sockaddr_storage defining the address to connect to
+* @param port to connect to
+* @param timeout in MILLISECONDS
+* @param pfd file descriptor returned
+*
+* @return NTSTATUS code
+*/

 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
                         int timeout, int *pfd)
 {
 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
                         int timeout, int *pfd)
 {