tsocket: Fixed documentation for tsocket_address_bsd_sockaddr().
[ira/wip.git] / lib / tsocket / tsocket_guide.txt
index ed903c602727535b77aa3a3371c0bcf00b19cb3c..b47f153e2e6890f4ae2d1fd44e1eb83ead0f00ef 100644 (file)
@@ -421,6 +421,28 @@ int tstream_unix_socketpair(TALLOC_CTX *mem_ctx1,
                            TALLOC_CTX *mem_ctx2,
                            struct tstream_context **stream2);
 
+In some situations it's needed to create a tsocket_address from
+a given 'struct sockaddr'. You can use tsocket_address_bsd_from_sockaddr()
+for that. This should only be used if really needed, because of
+already existing fixed APIs. Only AF_INET, AF_INET6 and AF_UNIX
+sockets are allowed. The function returns -1 and set errno on error.
+Otherwise it returns 0.
+
+int tsocket_address_bsd_from_sockaddr(TALLOC_CTX *mem_ctx,
+                                     struct sockaddr *sa,
+                                     socklen_t sa_socklen,
+                                     struct tsocket_address **addr);
+
+In some situations it's needed to get a 'struct sockaddr' from a
+given tsocket_address . You can use tsocket_address_bsd_sockaddr()
+for that. This should only be used if really needed. Only AF_INET,
+AF_INET6 and AF_UNIX are supported. It returns the size of '*sa' on
+success, otherwise it returns -1 and sets 'errno'.
+
+int tsocket_address_bsd_sockaddr(const struct tsocket_address *addr,
+                                struct sockaddr *sa,
+                                socklen_t *sa_socklen);
+
 In some situations it's needed to wrap existing file descriptors
 into the tstream abstraction. You can use tstream_bsd_existing_socket()
 for that. But you should read the tsocket_bsd.c code and unterstand it