tsocket: Fixed documentation for tsocket_address_bsd_sockaddr().
[ira/wip.git] / lib / tsocket / tsocket.h
index 8f69490012e223ea33c7642ba5780a0795bc0f1e..7e9cf9eb19ffcb3f2380c8d47e3d269ab4ae5118 100644 (file)
@@ -3,7 +3,7 @@
 
    Copyright (C) Stefan Metzmacher 2009
 
-     ** NOTE! The following LGPL license applies to the tevent
+     ** NOTE! The following LGPL license applies to the tsocket
      ** library. This does NOT imply that all of Samba is released
      ** under the LGPL
 
 #include <talloc.h>
 #include <tevent.h>
 
-struct tsocket_context;
 struct tsocket_address;
 struct tdgram_context;
+struct tstream_context;
 struct iovec;
 
-enum tsocket_type {
-       TSOCKET_TYPE_STREAM = 1,
-       TSOCKET_TYPE_MESSAGE
-};
-
-typedef void (*tsocket_event_handler_t)(struct tsocket_context *, void *);
-int tsocket_set_event_context(struct tsocket_context *sock,
-                             struct tevent_context *ev);
-int tsocket_set_readable_handler(struct tsocket_context *sock,
-                                tsocket_event_handler_t handler,
-                                void *private_data);
-int tsocket_set_writeable_handler(struct tsocket_context *sock,
-                                 tsocket_event_handler_t handler,
-                                 void *private_data);
-
-int tsocket_connect(struct tsocket_context *sock,
-                   const struct tsocket_address *remote_addr);
-
-int tsocket_listen(struct tsocket_context *sock,
-                  int queue_size);
-
-int _tsocket_accept(struct tsocket_context *sock,
-                   TALLOC_CTX *mem_ctx,
-                   struct tsocket_context **new_sock,
-                   const char *location);
-#define tsocket_accept(sock, mem_ctx, new_sock) \
-       _tsocket_accept(sock, mem_ctx, new_sock, __location__)
-
-ssize_t tsocket_pending(struct tsocket_context *sock);
-
-int tsocket_readv(struct tsocket_context *sock,
-                 const struct iovec *vector, size_t count);
-int tsocket_writev(struct tsocket_context *sock,
-                  const struct iovec *vector, size_t count);
-
-int tsocket_get_status(const struct tsocket_context *sock);
-
-int _tsocket_get_local_address(const struct tsocket_context *sock,
-                              TALLOC_CTX *mem_ctx,
-                              struct tsocket_address **local_addr,
-                              const char *location);
-#define tsocket_get_local_address(sock, mem_ctx, local_addr) \
-       _tsocket_get_local_address(sock, mem_ctx, local_addr, __location__)
-int _tsocket_get_remote_address(const struct tsocket_context *sock,
-                               TALLOC_CTX *mem_ctx,
-                               struct tsocket_address **remote_addr,
-                               const char *location);
-#define tsocket_get_remote_address(sock, mem_ctx, remote_addr) \
-       _tsocket_get_remote_address(sock, mem_ctx, remote_addr, __location__)
-
-int tsocket_get_option(const struct tsocket_context *sock,
-                      const char *option,
-                      TALLOC_CTX *mem_ctx,
-                      char **value);
-int tsocket_set_option(const struct tsocket_context *sock,
-                      const char *option,
-                      bool force,
-                      const char *value);
-
-void tsocket_disconnect(struct tsocket_context *sock);
-
+/*
+ * tsocket_address related functions
+ */
 char *tsocket_address_string(const struct tsocket_address *addr,
                             TALLOC_CTX *mem_ctx);
 
@@ -103,15 +45,6 @@ struct tsocket_address *_tsocket_address_copy(const struct tsocket_address *addr
 #define tsocket_address_copy(addr, mem_ctx) \
        _tsocket_address_copy(addr, mem_ctx, __location__)
 
-int _tsocket_address_create_socket(const struct tsocket_address *addr,
-                                  enum tsocket_type type,
-                                  TALLOC_CTX *mem_ctx,
-                                  struct tsocket_context **sock,
-                                  const char *location);
-#define tsocket_address_create_socket(addr, type, mem_ctx, sock) \
-       _tsocket_address_create_socket(addr, type, mem_ctx, sock,\
-                                      __location__)
-
 /*
  * tdgram_context related functions
  */
@@ -138,6 +71,33 @@ struct tevent_req *tdgram_disconnect_send(TALLOC_CTX *mem_ctx,
 int tdgram_disconnect_recv(struct tevent_req *req,
                           int *perrno);
 
+/*
+ * tstream_context related functions
+ */
+ssize_t tstream_pending_bytes(struct tstream_context *stream);
+
+struct tevent_req *tstream_readv_send(TALLOC_CTX *mem_ctx,
+                                     struct tevent_context *ev,
+                                     struct tstream_context *stream,
+                                     struct iovec *vector,
+                                     size_t count);
+int tstream_readv_recv(struct tevent_req *req,
+                      int *perrno);
+
+struct tevent_req *tstream_writev_send(TALLOC_CTX *mem_ctx,
+                                      struct tevent_context *ev,
+                                      struct tstream_context *stream,
+                                      const struct iovec *vector,
+                                      size_t count);
+int tstream_writev_recv(struct tevent_req *req,
+                       int *perrno);
+
+struct tevent_req *tstream_disconnect_send(TALLOC_CTX *mem_ctx,
+                                          struct tevent_context *ev,
+                                          struct tstream_context *stream);
+int tstream_disconnect_recv(struct tevent_req *req,
+                           int *perrno);
+
 /*
  * BSD sockets: inet, inet6 and unix
  */
@@ -157,8 +117,6 @@ char *tsocket_address_inet_addr_string(const struct tsocket_address *addr,
 uint16_t tsocket_address_inet_port(const struct tsocket_address *addr);
 int tsocket_address_inet_set_port(struct tsocket_address *addr,
                                  uint16_t port);
-void tsocket_address_inet_set_broadcast(struct tsocket_address *addr,
-                                       bool broadcast);
 
 int _tsocket_address_unix_from_path(TALLOC_CTX *mem_ctx,
                                    const char *path,
@@ -170,14 +128,6 @@ int _tsocket_address_unix_from_path(TALLOC_CTX *mem_ctx,
 char *tsocket_address_unix_path(const struct tsocket_address *addr,
                                TALLOC_CTX *mem_ctx);
 
-int _tsocket_context_bsd_wrap_existing(TALLOC_CTX *mem_ctx,
-                                      int fd, bool close_on_disconnect,
-                                      struct tsocket_context **_sock,
-                                      const char *location);
-#define tsocket_context_bsd_wrap_existing(mem_ctx, fd, cod, _sock) \
-       _tsocket_context_bsd_wrap_existing(mem_ctx, fd, cod, _sock, \
-                                          __location__)
-
 int _tdgram_inet_udp_socket(const struct tsocket_address *local,
                            const struct tsocket_address *remote,
                            TALLOC_CTX *mem_ctx,
@@ -186,49 +136,74 @@ int _tdgram_inet_udp_socket(const struct tsocket_address *local,
 #define tdgram_inet_udp_socket(local, remote, mem_ctx, dgram) \
        _tdgram_inet_udp_socket(local, remote, mem_ctx, dgram, __location__)
 
-int _tdgram_unix_dgram_socket(const struct tsocket_address *local,
-                             const struct tsocket_address *remote,
-                             TALLOC_CTX *mem_ctx,
-                             struct tdgram_context **dgram,
-                             const char *location);
-#define tdgram_unix_dgram_socket(local, remote, mem_ctx, dgram) \
-       _tdgram_unix_dgram_socket(local, remote, mem_ctx, dgram, __location__)
+int _tdgram_unix_socket(const struct tsocket_address *local,
+                       const struct tsocket_address *remote,
+                       TALLOC_CTX *mem_ctx,
+                       struct tdgram_context **dgram,
+                       const char *location);
+#define tdgram_unix_socket(local, remote, mem_ctx, dgram) \
+       _tdgram_unix_socket(local, remote, mem_ctx, dgram, __location__)
 
-/*
- * Async helpers
- */
+struct tevent_req * tstream_inet_tcp_connect_send(TALLOC_CTX *mem_ctx,
+                                       struct tevent_context *ev,
+                                       const struct tsocket_address *local,
+                                       const struct tsocket_address *remote);
+int _tstream_inet_tcp_connect_recv(struct tevent_req *req,
+                                  int *perrno,
+                                  TALLOC_CTX *mem_ctx,
+                                  struct tstream_context **stream,
+                                  const char *location);
+#define tstream_inet_tcp_connect_recv(req, perrno, mem_ctx, stream) \
+       _tstream_inet_tcp_connect_recv(req, perrno, mem_ctx, stream, \
+                                      __location__)
 
-struct tevent_req *tsocket_connect_send(struct tsocket_context *sock,
-                                       TALLOC_CTX *mem_ctx,
-                                       const struct tsocket_address *dst);
-int tsocket_connect_recv(struct tevent_req *req, int *perrno);
+struct tevent_req * tstream_unix_connect_send(TALLOC_CTX *mem_ctx,
+                                       struct tevent_context *ev,
+                                       const struct tsocket_address *local,
+                                       const struct tsocket_address *remote);
+int _tstream_unix_connect_recv(struct tevent_req *req,
+                              int *perrno,
+                              TALLOC_CTX *mem_ctx,
+                              struct tstream_context **stream,
+                              const char *location);
+#define tstream_unix_connect_recv(req, perrno, mem_ctx, stream) \
+       _tstream_unix_connect_recv(req, perrno, mem_ctx, stream, \
+                                         __location__)
+
+int _tstream_unix_socketpair(TALLOC_CTX *mem_ctx1,
+                            struct tstream_context **_stream1,
+                            TALLOC_CTX *mem_ctx2,
+                            struct tstream_context **_stream2,
+                            const char *location);
+#define tstream_unix_socketpair(mem_ctx1, stream1, mem_ctx2, stream2) \
+       _tstream_unix_socketpair(mem_ctx1, stream1, mem_ctx2, stream2, \
+                                __location__)
+
+struct sockaddr;
+
+int _tsocket_address_bsd_from_sockaddr(TALLOC_CTX *mem_ctx,
+                                      struct sockaddr *sa,
+                                      size_t sa_socklen,
+                                      struct tsocket_address **_addr,
+                                      const char *location);
+#define tsocket_address_bsd_from_sockaddr(mem_ctx, sa, sa_socklen, _addr) \
+       _tsocket_address_bsd_from_sockaddr(mem_ctx, sa, sa_socklen, _addr, \
+                                          __location__)
 
-struct tevent_req *tsocket_writev_send(struct tsocket_context *sock,
-                                      TALLOC_CTX *mem_ctx,
-                                      const struct iovec *vector,
-                                      size_t count);
-int tsocket_writev_recv(struct tevent_req *req, int *perrno);
+ssize_t tsocket_address_bsd_sockaddr(const struct tsocket_address *addr,
+                                    struct sockaddr *sa,
+                                    size_t sa_socklen);
 
-struct tevent_req *tsocket_writev_queue_send(TALLOC_CTX *mem_ctx,
-                                            struct tsocket_context *sock,
-                                            struct tevent_queue *queue,
-                                            const struct iovec *vector,
-                                            size_t count);
-int tsocket_writev_queue_recv(struct tevent_req *req, int *perrno);
-
-typedef int (*tsocket_readv_next_iovec_t)(struct tsocket_context *sock,
-                                         void *private_data,
-                                         TALLOC_CTX *mem_ctx,
-                                         struct iovec **vector,
-                                         size_t *count);
-struct tevent_req *tsocket_readv_send(struct tsocket_context *sock,
-                                     TALLOC_CTX *mem_ctx,
-                                     tsocket_readv_next_iovec_t next_iovec_fn,
-                                     void *private_data);
-int tsocket_readv_recv(struct tevent_req *req, int *perrno);
+int _tstream_bsd_existing_socket(TALLOC_CTX *mem_ctx,
+                                int fd,
+                                struct tstream_context **_stream,
+                                const char *location);
+#define tstream_bsd_existing_socket(mem_ctx, fd, stream) \
+       _tstream_bsd_existing_socket(mem_ctx, fd, stream, \
+                                    __location__)
 
 /*
- * Queue helpers
+ * Queue and PDU helpers
  */
 
 struct tevent_req *tdgram_sendto_queue_send(TALLOC_CTX *mem_ctx,
@@ -240,5 +215,33 @@ struct tevent_req *tdgram_sendto_queue_send(TALLOC_CTX *mem_ctx,
                                            struct tsocket_address *dst);
 ssize_t tdgram_sendto_queue_recv(struct tevent_req *req, int *perrno);
 
+typedef int (*tstream_readv_pdu_next_vector_t)(struct tstream_context *stream,
+                                              void *private_data,
+                                              TALLOC_CTX *mem_ctx,
+                                              struct iovec **vector,
+                                              size_t *count);
+struct tevent_req *tstream_readv_pdu_send(TALLOC_CTX *mem_ctx,
+                               struct tevent_context *ev,
+                               struct tstream_context *stream,
+                               tstream_readv_pdu_next_vector_t next_vector_fn,
+                               void *next_vector_private);
+int tstream_readv_pdu_recv(struct tevent_req *req, int *perrno);
+
+struct tevent_req *tstream_readv_pdu_queue_send(TALLOC_CTX *mem_ctx,
+                               struct tevent_context *ev,
+                               struct tstream_context *stream,
+                               struct tevent_queue *queue,
+                               tstream_readv_pdu_next_vector_t next_vector_fn,
+                               void *next_vector_private);
+int tstream_readv_pdu_queue_recv(struct tevent_req *req, int *perrno);
+
+struct tevent_req *tstream_writev_queue_send(TALLOC_CTX *mem_ctx,
+                                            struct tevent_context *ev,
+                                            struct tstream_context *stream,
+                                            struct tevent_queue *queue,
+                                            const struct iovec *vector,
+                                            size_t count);
+int tstream_writev_queue_recv(struct tevent_req *req, int *perrno);
+
 #endif /* _TSOCKET_H */