summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGünther Deschner <gd@samba.org>2011-04-13 17:35:44 +0200
committerVolker Lendecke <vl@samba.org>2011-04-13 18:13:34 +0200
commit8b8014198c16a11f48e13e2c11f3114cd20ad8d3 (patch)
tree08ee4480ee58c1abd5b190ec469d2d5ccb94a5bd
parent015511d12a8cc1982249254b8893f83171ec2edf (diff)
downloadsamba-8b8014198c16a11f48e13e2c11f3114cd20ad8d3.tar.gz
samba-8b8014198c16a11f48e13e2c11f3114cd20ad8d3.tar.bz2
samba-8b8014198c16a11f48e13e2c11f3114cd20ad8d3.zip
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
-rw-r--r--source3/lib/util_sock.c10
1 files changed, 10 insertions, 0 deletions
diff --git a/source3/lib/util_sock.c b/source3/lib/util_sock.c
index b010c991f7..71f6a8f29c 100644
--- 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;
}
+/**
+* @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)
{