Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
wsbuffer.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  *
59  * wsbuffer.h
60  *
61  * Author: Markku Rossi <mtr@iki.fi>
62  *
63  * Copyright (c) 1999-2000 WAPIT OY LTD.
64  * All rights reserved.
65  *
66  * A multipurpose buffer.
67  *
68  */
69 
70 #ifndef WSBUFFER_H
71 #define WSBUFFER_H
72 
73 /********************* Types and defintions *****************************/
74 
75 /* A multipurpose buffer. The contents of the buffer handle is
76  visible but its internals should not be modified directly. */
78 {
79  size_t len;
80  unsigned char *data;
81 };
82 
83 typedef struct WsBufferRec WsBuffer;
84 
85 /********************* Global functions *********************************/
86 
87 /* Initialize the buffer `buffer'. The buffer is not allocated; the
88  argument `buffer' must point to allocated buffer. */
89 void ws_buffer_init(WsBuffer *buffer);
90 
91 /* Uninitialize buffer `buffer'. The actual buffer structure is not
92  freed; only its internally allocated buffer is freed. */
93 void ws_buffer_uninit(WsBuffer *buffer);
94 
95 /* Allocate and initialize a new buffer. The function returns NULL if
96  the allocation failed. */
98 
99 /* Free the buffer `buffer' and all its resources. */
100 void ws_buffer_free(WsBuffer *buffer);
101 
102 /* Append `size' bytes of data from `data' to the buffer `buffer'.
103  The function returns WS_TRUE if the operation was successful or
104  WS_FALSE otherwise. */
105 WsBool ws_buffer_append(WsBuffer *buffer, unsigned char *data, size_t len);
106 
107 /* Append `size' bytes of space to the buffer `buffer'. If the
108  argument `p' is not NULL, it is set to point to the beginning of
109  the appended space. The function returns WS_TRUE if the operation
110  was successful of WS_FALSE otherwise. */
111 WsBool ws_buffer_append_space(WsBuffer *buffer, unsigned char **p, size_t size);
112 
113 /* Return a pointer to the beginning of the buffer's data. */
114 unsigned char *ws_buffer_ptr(WsBuffer *buffer);
115 
116 /* Return the length of the buffer `buffer'. */
117 size_t ws_buffer_len(WsBuffer *buffer);
118 
119 /* Steal the buffer's data. The function returns a pointer to the
120  beginning of the buffer's data and re-initializes the buffer to
121  empty data. The returned data must be with the ws_free() function
122  by the caller. */
123 unsigned char *ws_buffer_steal(WsBuffer *buffer);
124 
125 #endif /* not WSBUFFER_H */
int size
Definition: wsasm.c:84
unsigned char * ws_buffer_ptr(WsBuffer *buffer)
Definition: wsbuffer.c:133
void ws_buffer_free(WsBuffer *buffer)
Definition: wsbuffer.c:95
size_t ws_buffer_len(WsBuffer *buffer)
Definition: wsbuffer.c:139
void ws_buffer_uninit(WsBuffer *buffer)
Definition: wsbuffer.c:81
size_t len
Definition: wsbuffer.h:79
WsBuffer * ws_buffer_alloc(void)
Definition: wsbuffer.c:89
WsBool ws_buffer_append_space(WsBuffer *buffer, unsigned char **p, size_t size)
Definition: wsbuffer.c:115
WsBool
Definition: wsint.h:128
unsigned char * data
Definition: wsbuffer.h:80
unsigned char * ws_buffer_steal(WsBuffer *buffer)
Definition: wsbuffer.c:145
WsBool ws_buffer_append(WsBuffer *buffer, unsigned char *data, size_t len)
Definition: wsbuffer.c:102
void ws_buffer_init(WsBuffer *buffer)
Definition: wsbuffer.c:74
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.