← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to source3/include/packet.h

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 * Callback must either talloc_move or talloc_free buf
 
48
 */
 
49
bool packet_handler(struct packet_context *ctx,
 
50
                    bool (*full_req)(const uint8_t *buf,
 
51
                                     size_t available,
 
52
                                     size_t *length,
 
53
                                     void *private_data),
 
54
                    NTSTATUS (*callback)(uint8_t *buf, size_t length,
 
55
                                         void *private_data),
 
56
                    void *private_data,
 
57
                    NTSTATUS *status);
 
58
 
 
59
/*
 
60
 * How many bytes of outgoing data do we have pending?
 
61
 */
 
62
size_t packet_outgoing_bytes(struct packet_context *ctx);
 
63
 
 
64
/*
 
65
 * Push data to the fd
 
66
 */
 
67
NTSTATUS packet_fd_write(struct packet_context *ctx);
 
68
 
 
69
/*
 
70
 * Sync flush all outgoing bytes
 
71
 */
 
72
NTSTATUS packet_flush(struct packet_context *ctx);
 
73
 
 
74
/*
 
75
 * Send a list of DATA_BLOBs
 
76
 *
 
77
 * Example:  packet_send(ctx, 2, data_blob_const(&size, sizeof(size)),
 
78
 *                       data_blob_const(buf, size));
 
79
 */
 
80
NTSTATUS packet_send(struct packet_context *ctx, int num_blobs, ...);
 
81
 
 
82
/*
 
83
 * Get the packet context's file descriptor
 
84
 */
 
85
int packet_get_fd(struct packet_context *ctx);