1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
#ifndef CONNECT___NCBI_BUFFER__H
#define CONNECT___NCBI_BUFFER__H
/* $Id: ncbi_buffer.h,v 6.9 2003/04/10 12:52:15 siyan Exp $
* ===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
* Author: Denis Vakatov
*
* File Description:
* Memory-resident FIFO storage area (to be used e.g. in I/O buffering)
*
* Handle: BUF
*
* Functions:
* BUF_SetChunkSize
* BUF_Size
* BUF_Write
* BUF_PushBack
* BUF_Peek
* BUF_PeekAt
* BUF_Read
* BUF_Destroy
*
*/
#if defined(NCBIBUF__H)
# error "<ncbibuf.h> and <ncbi_buffer.h> must never be #include'd together"
#endif
#include <connect/connect_export.h>
#include <stddef.h> /* ...to define "size_t"... */
/** @addtogroup BuffServices
*
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
struct BUF_tag;
typedef struct BUF_tag* BUF; /* handle of a buffer */
/* Set minimal size of a buffer memory chunk.
* Return the actually set chunk size on success; zero on error
* NOTE: if "*pBuf" == NULL then create it
* if "chunk_size" is passed 0 then set it to BUF_DEF_CHUNK_SIZE
*/
#define BUF_DEF_CHUNK_SIZE 1024
extern NCBI_XCONNECT_EXPORT size_t BUF_SetChunkSize
(BUF* pBuf,
size_t chunk_size
);
/* Return the number of bytes stored in "buf".
* NOTE: return 0 if "buf" == NULL
*/
extern NCBI_XCONNECT_EXPORT size_t BUF_Size(BUF buf);
/* Add new data to the end of "*pBuf" (to be read last).
* On error (failed memory allocation), return zero value.
* NOTE: if "*pBuf" == NULL then create it.
*/
extern NCBI_XCONNECT_EXPORT /*bool*/int BUF_Write
(BUF* pBuf,
const void* data,
size_t size
);
/* Write the data to the very beginning of "*pBuf" (to be read first).
* On error (failed memory allocation), return zero value.
* NOTE: if "*pBuf" == NULL then create it.
*/
extern NCBI_XCONNECT_EXPORT /*bool*/int BUF_PushBack
(BUF* pBuf,
const void* data,
size_t size
);
/* Equivalent to "BUF_PeekAt(buf, 0, data, size)", see description below.
*/
extern NCBI_XCONNECT_EXPORT size_t BUF_Peek
(BUF buf,
void* data,
size_t size
);
/* Copy up to "size" bytes stored in "buf" (starting at position "pos")
* to "data".
* Return the # of copied bytes (can be less than "size").
* Return zero and do nothing if "buf" is NULL or "pos" >= BUF_Size(buf).
* Do nothing and return min(BUF_Size(buf)-pos, size) if "data" is NULL.
*/
extern NCBI_XCONNECT_EXPORT size_t BUF_PeekAt
(BUF buf,
size_t pos,
void* data,
size_t size
);
/* Copy up to "size" bytes stored in "buf" to "data" and remove
* copied data from the "buf".
* Return the # of copied-and/or-removed bytes(can be less than "size")
* NOTE: if "buf" == NULL then do nothing and return 0
* if "data" == NULL then do not copy data anywhere(still, remove it)
*/
extern NCBI_XCONNECT_EXPORT size_t BUF_Read
(BUF buf,
void* data,
size_t size
);
/* Destroy all internal data.
* NOTE: do nothing if "buf" == NULL
*/
extern NCBI_XCONNECT_EXPORT void BUF_Destroy(BUF buf);
#ifdef __cplusplus
}
#endif
/* @} */
/*
* ---------------------------------------------------------------------------
* $Log: ncbi_buffer.h,v $
* Revision 6.9 2003/04/10 12:52:15 siyan
* Changed group name for doxygen
*
* Revision 6.8 2003/04/09 17:58:40 siyan
* Added doxygen support
*
* Revision 6.7 2003/01/08 01:59:32 lavr
* DLL-ize CONNECT library for MSVC (add NCBI_XCONNECT_EXPORT)
*
* Revision 6.6 2002/09/19 17:59:53 lavr
* Header file guard macro changed; log moved to the end
*
* Revision 6.5 2001/04/23 22:20:26 vakatov
* BUF_PeekAt() -- special case for "data" == NULL
*
* Revision 6.4 2001/04/23 18:07:19 vakatov
* + BUF_PeekAt()
*
* Revision 6.3 2000/02/23 22:33:37 vakatov
* Can work both "standalone" and as a part of NCBI C++ or C toolkits
*
* Revision 6.2 1999/10/12 16:30:10 vakatov
* include <string.h> to define "size_t"
*
* Revision 6.1 1999/08/17 19:45:22 vakatov
* Moved all real code from NCBIBUF to NCBI_BUFFER; the code has been cleaned
* from the NCBI C toolkit specific types and API calls.
* NCBIBUF module still exists for the backward compatibility -- it
* provides old NCBI-wise interface.
*
* ===========================================================================
*/
#endif /* CONNECT___NCBI_BUFFER__H */
|
