s4: fix various warnings (not "const" related ones)
[sfrench/samba-autobuild/.git] / source4 / lib / socket / socket.h
1 /* 
2    Unix SMB/CIFS implementation.
3    Socket functions
4    Copyright (C) Stefan Metzmacher 2004
5    
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef _SAMBA_SOCKET_H
21 #define _SAMBA_SOCKET_H
22
23 struct tevent_context;
24 struct tevent_fd;
25 struct socket_context;
26
27 enum socket_type {
28         SOCKET_TYPE_STREAM,
29         SOCKET_TYPE_DGRAM
30 };
31
32 struct socket_address {
33         const char *family;
34         char *addr;
35         int port;
36         struct sockaddr *sockaddr;
37         size_t sockaddrlen;
38 };
39
40 struct socket_ops {
41         const char *name;
42
43         NTSTATUS (*fn_init)(struct socket_context *sock);
44
45         /* client ops */
46         NTSTATUS (*fn_connect)(struct socket_context *sock,
47                                const struct socket_address *my_address,
48                                const struct socket_address *server_address,
49                                uint32_t flags);
50
51         /* complete a non-blocking connect */
52         NTSTATUS (*fn_connect_complete)(struct socket_context *sock,
53                                         uint32_t flags);
54
55         /* server ops */
56         NTSTATUS (*fn_listen)(struct socket_context *sock,
57                               const struct socket_address *my_address, 
58                               int queue_size, uint32_t flags);
59         NTSTATUS (*fn_accept)(struct socket_context *sock,      
60                               struct socket_context **new_sock);
61
62         /* general ops */
63         NTSTATUS (*fn_recv)(struct socket_context *sock, void *buf,
64                             size_t wantlen, size_t *nread);
65         NTSTATUS (*fn_send)(struct socket_context *sock, 
66                             const DATA_BLOB *blob, size_t *sendlen);
67
68         NTSTATUS (*fn_sendto)(struct socket_context *sock, 
69                               const DATA_BLOB *blob, size_t *sendlen,
70                               const struct socket_address *dest_addr);
71         NTSTATUS (*fn_recvfrom)(struct socket_context *sock, 
72                                 void *buf, size_t wantlen, size_t *nread,
73                                 TALLOC_CTX *addr_ctx, struct socket_address **src_addr);
74         NTSTATUS (*fn_pending)(struct socket_context *sock, size_t *npending);      
75
76         void (*fn_close)(struct socket_context *sock);
77
78         NTSTATUS (*fn_set_option)(struct socket_context *sock, const char *option, const char *val);
79
80         char *(*fn_get_peer_name)(struct socket_context *sock, TALLOC_CTX *mem_ctx);
81         struct socket_address *(*fn_get_peer_addr)(struct socket_context *sock, TALLOC_CTX *mem_ctx);
82         struct socket_address *(*fn_get_my_addr)(struct socket_context *sock, TALLOC_CTX *mem_ctx);
83
84         int (*fn_get_fd)(struct socket_context *sock);
85 };
86
87 enum socket_state {
88         SOCKET_STATE_UNDEFINED,
89
90         SOCKET_STATE_CLIENT_START,
91         SOCKET_STATE_CLIENT_CONNECTED,
92         SOCKET_STATE_CLIENT_STARTTLS,
93         SOCKET_STATE_CLIENT_ERROR,
94         
95         SOCKET_STATE_SERVER_LISTEN,
96         SOCKET_STATE_SERVER_CONNECTED,
97         SOCKET_STATE_SERVER_STARTTLS,
98         SOCKET_STATE_SERVER_ERROR
99 };
100
101 #define SOCKET_FLAG_BLOCK        0x00000001
102 #define SOCKET_FLAG_PEEK         0x00000002
103 #define SOCKET_FLAG_TESTNONBLOCK 0x00000004
104 #define SOCKET_FLAG_ENCRYPT      0x00000008 /* This socket
105                                              * implementation requires
106                                              * that re-sends be
107                                              * consistant, because it
108                                              * is encrypting data.
109                                              * This modifies the
110                                              * TESTNONBLOCK case */
111 #define SOCKET_FLAG_NOCLOSE      0x00000010 /* don't auto-close on free */
112
113
114 struct socket_context {
115         enum socket_type type;
116         enum socket_state state;
117         uint32_t flags;
118
119         int fd;
120
121         void *private_data;
122         const struct socket_ops *ops;
123         const char *backend_name;
124
125         /* specific to the ip backend */
126         int family;
127 };
128
129 struct resolve_context;
130
131 /* prototypes */
132 NTSTATUS socket_create_with_ops(TALLOC_CTX *mem_ctx, const struct socket_ops *ops,
133                                 struct socket_context **new_sock, 
134                                 enum socket_type type, uint32_t flags);
135 NTSTATUS socket_create(const char *name, enum socket_type type, 
136                        struct socket_context **new_sock, uint32_t flags);
137 NTSTATUS socket_connect(struct socket_context *sock,
138                         const struct socket_address *my_address, 
139                         const struct socket_address *server_address,
140                         uint32_t flags);
141 NTSTATUS socket_connect_complete(struct socket_context *sock, uint32_t flags);
142 NTSTATUS socket_listen(struct socket_context *sock, 
143                        const struct socket_address *my_address, 
144                        int queue_size, uint32_t flags);
145 NTSTATUS socket_accept(struct socket_context *sock, struct socket_context **new_sock);
146 NTSTATUS socket_recv(struct socket_context *sock, void *buf, 
147                      size_t wantlen, size_t *nread);
148 NTSTATUS socket_recvfrom(struct socket_context *sock, void *buf, 
149                          size_t wantlen, size_t *nread, 
150                          TALLOC_CTX *addr_ctx, struct socket_address **src_addr);
151 NTSTATUS socket_send(struct socket_context *sock, 
152                      const DATA_BLOB *blob, size_t *sendlen);
153 NTSTATUS socket_sendto(struct socket_context *sock, 
154                        const DATA_BLOB *blob, size_t *sendlen,
155                        const struct socket_address *dest_addr);
156 NTSTATUS socket_pending(struct socket_context *sock, size_t *npending);
157 NTSTATUS socket_set_option(struct socket_context *sock, const char *option, const char *val);
158 char *socket_get_peer_name(struct socket_context *sock, TALLOC_CTX *mem_ctx);
159 struct socket_address *socket_get_peer_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx);
160 struct socket_address *socket_get_my_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx);
161 int socket_get_fd(struct socket_context *sock);
162 NTSTATUS socket_dup(struct socket_context *sock);
163 struct socket_address *socket_address_from_strings(TALLOC_CTX *mem_ctx,
164                                                    const char *type, 
165                                                    const char *host,
166                                                    int port);
167 struct socket_address *socket_address_from_sockaddr(TALLOC_CTX *mem_ctx, 
168                                                     struct sockaddr *sockaddr, 
169                                                     size_t addrlen);
170 struct socket_address *socket_address_copy(TALLOC_CTX *mem_ctx,
171                                            const struct socket_address *oaddr);
172 const struct socket_ops *socket_getops_byname(const char *name, enum socket_type type);
173 bool allow_access(TALLOC_CTX *mem_ctx,
174                   const char **deny_list, const char **allow_list,
175                   const char *cname, const char *caddr);
176 bool socket_check_access(struct socket_context *sock, 
177                          const char *service_name,
178                          const char **allow_list, const char **deny_list);
179
180 struct composite_context *socket_connect_send(struct socket_context *sock,
181                                               struct socket_address *my_address,
182                                               struct socket_address *server_address, 
183                                               uint32_t flags,
184                                               struct tevent_context *event_ctx);
185 NTSTATUS socket_connect_recv(struct composite_context *ctx);
186 NTSTATUS socket_connect_ev(struct socket_context *sock,
187                            struct socket_address *my_address,
188                            struct socket_address *server_address, 
189                            uint32_t flags, 
190                            struct tevent_context *ev);
191
192 struct composite_context *socket_connect_multi_send(TALLOC_CTX *mem_ctx,
193                                                     const char *server_address,
194                                                     int num_server_ports,
195                                                     uint16_t *server_ports,
196                                                     struct resolve_context *resolve_ctx,
197                                                     struct tevent_context *event_ctx);
198 NTSTATUS socket_connect_multi_recv(struct composite_context *ctx,
199                                    TALLOC_CTX *mem_ctx,
200                                    struct socket_context **result,
201                                    uint16_t *port);
202 NTSTATUS socket_connect_multi(TALLOC_CTX *mem_ctx, const char *server_address,
203                               int num_server_ports, uint16_t *server_ports,
204                               struct resolve_context *resolve_ctx,
205                               struct tevent_context *event_ctx,
206                               struct socket_context **result,
207                               uint16_t *port);
208 void set_socket_options(int fd, const char *options);
209 void socket_set_flags(struct socket_context *sock, unsigned flags);
210
211 void socket_tevent_fd_close_fn(struct tevent_context *ev,
212                                struct tevent_fd *fde,
213                                int fd,
214                                void *private_data);
215
216 extern bool testnonblock;
217
218 #endif /* _SAMBA_SOCKET_H */