71a7cd36da29db65cf6777e01e0fb32f42721dcd
[nivanova/samba-autobuild/.git] / source3 / include / packet.h
1 /* 
2    Unix SMB/CIFS implementation.
3    Packet handling
4    Copyright (C) Volker Lendecke 2007
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 /*
21  * A packet context is a wrapper around a bidirectional file descriptor,
22  * hiding the handling of individual requests.
23  */
24
25 struct packet_context;
26
27 /*
28  * Initialize a packet context. The fd is given to the packet context, meaning
29  * that it is automatically closed when the packet context is freed.
30  */
31 struct packet_context *packet_init(TALLOC_CTX *mem_ctx, int fd);
32
33 /*
34  * Pull data from the fd
35  */
36 NTSTATUS packet_fd_read(struct packet_context *ctx);
37
38 /*
39  * Sync read, wait for the next chunk
40  */
41 NTSTATUS packet_fd_read_sync(struct packet_context *ctx);
42
43 /*
44  * Handle an incoming packet:
45  * Return False if none is available
46  * Otherwise return True and store the callback result in *status
47  */
48 BOOL packet_handler(struct packet_context *ctx,
49                     BOOL (*full_req)(const struct data_blob *data,
50                                      size_t *length,
51                                      void *private_data),
52                     NTSTATUS (*callback)(const struct data_blob *data,
53                                          void *private_data),
54                     void *private_data,
55                     NTSTATUS *status);
56
57 /*
58  * How many bytes of outgoing data do we have pending?
59  */
60 size_t packet_outgoing_bytes(struct packet_context *ctx);
61
62 /*
63  * Push data to the fd
64  */
65 NTSTATUS packet_fd_write(struct packet_context *ctx);
66
67 /*
68  * Sync flush all outgoing bytes
69  */
70 NTSTATUS packet_flush(struct packet_context *ctx);
71
72 /*
73  * Send a list of DATA_BLOBs
74  *
75  * Example:  packet_send(ctx, 2, data_blob_const(&size, sizeof(size)),
76  *                       data_blob_const(buf, size));
77  */
78 NTSTATUS packet_send(struct packet_context *ctx, int num_blobs, ...);
79
80 /*
81  * Get the packet context's file descriptor
82  */
83 int packet_get_fd(struct packet_context *ctx);