ncbi_namedpipe_connector.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: ncbi_namedpipe_connector.hpp,v $
 * PRODUCTION Revision 1000.1  2004/04/12 17:05:57  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.5
 * PRODUCTION
 * ===========================================================================
 */

#ifndef CONNECT___NCBI_NAMEDPIPE_CONNECTOR__HPP
#define CONNECT___NCBI_NAMEDPIPE_CONNECTOR__HPP

/*  $Id: ncbi_namedpipe_connector.hpp,v 1000.1 2004/04/12 17:05:57 gouriano 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:  Vladimir Ivanov
 *
 *
 */

/// @file ncbi_namedpipe_connector.hpp
/// Implement CONNECTOR for a named pipe interprocess communication
/// (based on the NCBI CNamedPipe).
///
/// See in "connectr.h" for the detailed specification of the underlying
/// connector("CONNECTOR", "SConnectorTag") methods and structures.
 

#include <connect/ncbi_connector.h>
#include <connect/ncbi_namedpipe.hpp>


/** @addtogroup Connectors
 *
 * @{
 */


BEGIN_NCBI_SCOPE


/* Create new CONNECTOR structure to handle a data transfer between two
 * processes over named pipe. Return NULL on error.
 *
 */

/// Create CNamedPipe-based CONNECTOR.
///
/// Create new CONNECTOR structure to handle a data transfer between two
/// process over nemed pipe.  Return NULL on error.
extern NCBI_XCONNECT_EXPORT CONNECTOR NAMEDPIPE_CreateConnector
(const string& pipename,
 size_t        pipebufsize = 0 /* use default */
 );


END_NCBI_SCOPE


/* @} */


/*
 * ===========================================================================
 * $Log: ncbi_namedpipe_connector.hpp,v $
 * Revision 1000.1  2004/04/12 17:05:57  gouriano
 * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.5
 *
 * Revision 1.5  2004/03/22 17:00:17  ivanov
 * Replaced CNamedPipe::kDefaultPipeSize with 0 -- default pipe buffer size.
 *
 * Revision 1.4  2003/09/23 21:02:21  lavr
 * Rename BufferSize into PipeSize; accept string instead of char*
 *
 * Revision 1.3  2003/09/03 13:56:11  ivanov
 * Renamed to .hpp
 *
 * Revision 1.2  2003/08/21 20:07:54  ivanov
 * Added NAMEDPIPE_CreateConnectorEx
 *
 * Revision 1.1  2003/08/18 19:17:32  ivanov
 * Initial revision
 *
 * ==========================================================================
 */

#endif /* CONNECT___NCBI_NAMEDPIPE_CONNECTOR__HPP */