NCBI C++ ToolKit
ncbi_memory_connector.h
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef CONNECT___NCBI_MEMORY_CONNECTOR__H
2 #define CONNECT___NCBI_MEMORY_CONNECTOR__H
3 
4 /* $Id: ncbi_memory_connector.h 51161 2011-09-11 01:15:00Z lavr $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Author: Anton Lavrentiev
30  *
31  * File Description:
32  * In-memory CONNECTOR
33  *
34  * See <connect/ncbi_connector.h> for the detailed specification of
35  * the connector's methods and structures.
36  *
37  */
38 
39 #include <connect/ncbi_buffer.h>
40 #include <connect/ncbi_connector.h>
41 
42 
43 /** @addtogroup Connectors
44  *
45  * @{
46  */
47 
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 
54 /* Create new CONNECTOR structure to handle a data transfer in-memory.
55  * Return NULL on error.
56  */
58 
59 
60 /* Onwership of "buf" (if passed non-NULL) controlled by the 2nd parameter */
62 (BUF buf, /* may be NULL; see param-less ctor above */
63  unsigned int/*bool*/ own_buf /* non-zero if connector is to own "buf" */
64  );
65 
66 
67 #ifdef __cplusplus
68 } /* extern "C" */
69 #endif
70 
71 
72 /* @} */
73 
74 #endif /* CONNECT___NCBI_MEMORY_CONNECTOR__H */
CONNECTOR MEMORY_CreateConnector(void)
CONNECTOR MEMORY_CreateConnectorEx(BUF buf, unsigned int own_buf)
#define NCBI_XCONNECT_EXPORT
char * buf
Connector specification.
Modified on Sat Apr 13 11:46:22 2024 by modify_doxy.py rev. 669887