source: mainline/uspace/lib/http/receive-buffer.h@ ff364f1

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since ff364f1 was ff364f1, checked in by Martin Sucha <sucha14@…>, 12 years ago

Abstract away the receive buffer

  • Property mode set to 100644
File size: 2.3 KB
Line 
1/*
2 * Copyright (c) 2013 Martin Sucha
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup http
30 * @{
31 */
32/**
33 * @file
34 */
35
36#ifndef HTTP_RECEIVE_BUFFER_H_
37#define HTTP_RECEIVE_BUFFER_H_
38
39
40/** Receive data.
41 *
42 * @param client_data client data
43 * @param buf buffer to store the data
44 * @param buf_size buffer size
45 * @return number of bytes received or negative error code
46 */
47typedef ssize_t (*receive_func_t)(void *, void *, size_t);
48
49typedef struct {
50 size_t size;
51 char *buffer;
52 size_t in;
53 size_t out;
54
55 void *client_data;
56 receive_func_t receive;
57} receive_buffer_t;
58
59extern int recv_buffer_init(receive_buffer_t *, size_t, receive_func_t, void *);
60extern void recv_buffer_fini(receive_buffer_t *);
61extern void recv_reset(receive_buffer_t *);
62extern int recv_char(receive_buffer_t *, char *, bool);
63extern ssize_t recv_buffer(receive_buffer_t *, char *, size_t);
64extern int recv_discard(receive_buffer_t *, char);
65extern ssize_t recv_line(receive_buffer_t *, char *, size_t);
66
67
68
69#endif
70
71/** @}
72 */
Note: See TracBrowser for help on using the repository browser.