NCBI C++ ToolKit
ncbi_namedpipe_connector.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef CONNECT___NCBI_NAMEDPIPE_CONNECTOR__HPP
2 #define CONNECT___NCBI_NAMEDPIPE_CONNECTOR__HPP
3 
4 /* $Id: ncbi_namedpipe_connector.hpp 89534 2020-04-06 16:26:33Z 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: Vladimir Ivanov
30  *
31  *
32  */
33 
34 /// @file ncbi_namedpipe_connector.hpp
35 /// Implement CONNECTOR for a named pipe interprocess communication
36 /// (based on the NCBI CNamedPipe).
37 ///
38 /// See in "ncbi_connector.h" for the detailed specification of the underlying
39 /// connector(CONNECTOR, SConnectorTag) methods and structures.
40 
41 
43 #include <connect/ncbi_connector.h>
44 
45 
46 /** @addtogroup Connectors
47  *
48  * @{
49  */
50 
51 
53 
54 
55 /// Create CNamedPipe-based CONNECTOR.
56 ///
57 /// Create new CONNECTOR structure to handle a data transfer between two
58 /// processes through a named pipe. Return NULL on error.
60 (const string& pipename,
61  size_t pipesize = 0/**< use default */
62  );
63 
64 
66 
67 
68 /* @} */
69 
70 #endif /* CONNECT___NCBI_NAMEDPIPE_CONNECTOR__HPP */
CONNECTOR NAMEDPIPE_CreateConnector(const string &pipename, size_t pipesize=0)
Create CNamedPipe-based CONNECTOR.
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_XCONNECT_EXPORT
Portable interprocess named pipe API for: UNIX, MS-Win.
Connector specification.
Modified on Thu Jun 13 17:31:00 2024 by modify_doxy.py rev. 669887