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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
/* $Id: ncbi_memory_connector.c,v 6.8 2005/04/20 18:15:59 lavr 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: Anton Lavrentiev
*
* File Description:
* In-memory CONNECTOR
*
* See <connect/ncbi_connector.h> for the detailed specification of
* the connector's methods and structures.
*
*/
#include <connect/ncbi_buffer.h>
#include <connect/ncbi_memory_connector.h>
#include <assert.h>
#include <stdlib.h>
/***********************************************************************
* INTERNAL -- Auxiliary types and static functions
***********************************************************************/
/* All internal data necessary to perform the (re)connect and i/o
*/
typedef struct {
BUF buf;
MT_LOCK lock;
int/*bool*/ own_buf;
EIO_Status r_status;
EIO_Status w_status;
} SMemoryConnector;
/***********************************************************************
* INTERNAL -- "s_VT_*" functions for the "virt. table" of connector methods
***********************************************************************/
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
static const char* s_VT_GetType (CONNECTOR connector);
static EIO_Status s_VT_Open (CONNECTOR connector,
const STimeout* timeout);
static EIO_Status s_VT_Wait (CONNECTOR connector,
EIO_Event event,
const STimeout* timeout);
static EIO_Status s_VT_Write (CONNECTOR connector,
const void* buf,
size_t size,
size_t* n_written,
const STimeout* timeout);
static EIO_Status s_VT_Read (CONNECTOR connector,
void* buf,
size_t size,
size_t* n_read,
const STimeout* timeout);
static EIO_Status s_VT_Status (CONNECTOR connector,
EIO_Event dir);
static EIO_Status s_VT_Close (CONNECTOR connector,
const STimeout* timeout);
static void s_Setup (SMetaConnector* meta,
CONNECTOR connector);
static void s_Destroy (CONNECTOR connector);
# ifdef IMPLEMENTED__CONN_WaitAsync
static EIO_Status s_VT_WaitAsync(void* connector,
FConnectorAsyncHandler func,
SConnectorAsyncHandler* data);
# endif
#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */
/*ARGSUSED*/
static const char* s_VT_GetType
(CONNECTOR connector)
{
return "MEMORY";
}
/*ARGSUSED*/
static EIO_Status s_VT_Open
(CONNECTOR connector,
const STimeout* timeout)
{
SMemoryConnector* xxx = (SMemoryConnector*) connector->handle;
xxx->r_status = eIO_Success;
xxx->w_status = eIO_Success;
return eIO_Success;
}
/*ARGSUSED*/
static EIO_Status s_VT_Write
(CONNECTOR connector,
const void* buf,
size_t size,
size_t* n_written,
const STimeout* timeout)
{
SMemoryConnector* xxx = (SMemoryConnector*) connector->handle;
int written;
if ( !size )
return eIO_Success;
MT_LOCK_Do(xxx->lock, eMT_Lock);
written = BUF_Write(&xxx->buf, buf, size);
MT_LOCK_Do(xxx->lock, eMT_Unlock);
if ( !written ) {
xxx->w_status = eIO_Unknown;
return eIO_Unknown;
}
*n_written = size;
xxx->w_status = eIO_Success;
return eIO_Success;
}
/*ARGSUSED*/
static EIO_Status s_VT_Read
(CONNECTOR connector,
void* buf,
size_t size,
size_t* n_read,
const STimeout* timeout)
{
SMemoryConnector* xxx = (SMemoryConnector*) connector->handle;
if ( !size )
return eIO_Success;
MT_LOCK_Do(xxx->lock, eMT_Lock);
*n_read = BUF_Read(xxx->buf, buf, size);
MT_LOCK_Do(xxx->lock, eMT_Unlock);
if ( !*n_read ) {
xxx->r_status = eIO_Closed;
return eIO_Closed;
}
xxx->r_status = eIO_Success;
return eIO_Success;
}
/*ARGSUSED*/
static EIO_Status s_VT_Wait
(CONNECTOR connector,
EIO_Event event,
const STimeout* timeout)
{
return eIO_Success;
}
static EIO_Status s_VT_Status
(CONNECTOR connector,
EIO_Event dir)
{
SMemoryConnector* xxx = (SMemoryConnector*) connector->handle;
switch (dir) {
case eIO_Read:
return xxx->r_status;
case eIO_Write:
return xxx->w_status;
default:
assert(0); /* should never happen as checked by connection */
return eIO_InvalidArg;
}
}
/*ARGSUSED*/
static EIO_Status s_VT_Close
(CONNECTOR connector,
const STimeout* timeout)
{
SMemoryConnector* xxx = (SMemoryConnector*) connector->handle;
BUF_Erase(xxx->buf);
return eIO_Success;
}
static void s_Setup
(SMetaConnector* meta,
CONNECTOR connector)
{
/* initialize virtual table */
CONN_SET_METHOD(meta, get_type, s_VT_GetType, connector);
CONN_SET_METHOD(meta, open, s_VT_Open, connector);
CONN_SET_METHOD(meta, wait, s_VT_Wait, connector);
CONN_SET_METHOD(meta, write, s_VT_Write, connector);
CONN_SET_METHOD(meta, flush, 0, 0);
CONN_SET_METHOD(meta, read, s_VT_Read, connector);
CONN_SET_METHOD(meta, status, s_VT_Status, connector);
CONN_SET_METHOD(meta, close, s_VT_Close, connector);
#ifdef IMPLEMENTED__CONN_WaitAsync
CONN_SET_METHOD(meta, wait_async, s_VT_WaitAsync, connector);
#endif
meta->default_timeout = 0/*infinite*/;
}
static void s_Destroy
(CONNECTOR connector)
{
SMemoryConnector* xxx = (SMemoryConnector*) connector->handle;
if (xxx->own_buf)
BUF_Destroy(xxx->buf);
free(xxx);
connector->handle = 0;
free(connector);
}
/***********************************************************************
* EXTERNAL -- the connector's "constructors"
***********************************************************************/
extern CONNECTOR MEMORY_CreateConnector(MT_LOCK lock)
{
return MEMORY_CreateConnectorEx(0, lock);
}
extern CONNECTOR MEMORY_CreateConnectorEx(BUF buf, MT_LOCK lock)
{
CONNECTOR ccc = (SConnector*) malloc(sizeof(SConnector));
SMemoryConnector* xxx = (SMemoryConnector*) malloc(sizeof(*xxx));
/* initialize internal data structures */
xxx->buf = buf;
xxx->lock = lock;
xxx->own_buf = buf ? 0/*false*/ : 1/*true*/;
/* initialize connector data */
ccc->handle = xxx;
ccc->next = 0;
ccc->meta = 0;
ccc->setup = s_Setup;
ccc->destroy = s_Destroy;
return ccc;
}
/*
* --------------------------------------------------------------------------
* $Log: ncbi_memory_connector.c,v $
* Revision 6.8 2005/04/20 18:15:59 lavr
* +<assert.h>
*
* Revision 6.7 2004/10/27 19:16:33 lavr
* Reuse MEMORY_CreateConnectorEx() in MEMORY_CreateConnector()
*
* Revision 6.6 2004/10/27 18:44:56 lavr
* +MEMORY_CreateConnectorEx() and not-owned buffer management
*
* Revision 6.5 2003/05/31 05:15:39 lavr
* Add ARGSUSED where args are meant to be unused, remove Flush
*
* Revision 6.4 2003/05/14 03:53:13 lavr
* Log moved to end
*
* Revision 6.3 2002/10/22 15:11:24 lavr
* Zero connector's handle to crash if revisited
*
* Revision 6.2 2002/04/26 16:32:49 lavr
* Added setting of default timeout in meta-connector's setup routine
*
* Revision 6.1 2002/02/20 19:14:08 lavr
* Initial revision
*
* ==========================================================================
*/
|
