#ifndef CONNECT___NCBI_SERVICE_CONNECTOR__H
#define CONNECT___NCBI_SERVICE_CONNECTOR__H

/*  $Id: ncbi_service_connector.h,v 6.12 2006/04/20 14:03:17 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:
 *   Implement CONNECTOR for a named NCBI service
 *
 *   See in "ncbi_connector.h" for the detailed specification of the underlying
 *   connector("CONNECTOR", "SConnectorTag") methods and structures.
 *
 */

#include <connect/ncbi_http_connector.h>
#include <connect/ncbi_service.h>


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


#ifdef __cplusplus
extern "C" {
#endif


typedef const SSERV_Info* (*FSERVICE_GetNextInfo)(SERV_ITER iter, void* data);
typedef void              (*FSERVICE_CleanupData)(void* data);
typedef void              (*FSERVICE_ResetData)  (void* data);


typedef struct {
    void*                data;
    FSERVICE_ResetData   reset;         /* called at each close (before iter)*/
    FSERVICE_CleanupData cleanup;       /* called at destruction             */
    FSERVICE_GetNextInfo get_next_info; /* called to get conn point          */
    THCC_Flags           flags;         /* only fHCC_Flushable is honored    */
} SSERVICE_Extra;


extern NCBI_XCONNECT_EXPORT CONNECTOR SERVICE_CreateConnectorEx
(const char*           service,
 TSERV_Type            types,
 const SConnNetInfo*   net_info,
 const SSERVICE_Extra* params
 );

#define SERVICE_CreateConnector(service) \
    SERVICE_CreateConnectorEx(service, fSERV_Any, 0, 0)


#ifdef __cplusplus
}  /* extern "C" */
#endif


/* @} */


/*
 * --------------------------------------------------------------------------
 * $Log: ncbi_service_connector.h,v $
 * Revision 6.12  2006/04/20 14:03:17  lavr
 * Document that SExtraParams::reset is called before service iter is closed
 *
 * Revision 6.11  2005/08/12 19:20:06  lavr
 * +SSERVICE_Extra::flags (for fHCC_Flushable)
 *
 * Revision 6.10  2003/04/09 19:05:52  siyan
 * Added doxygen support
 *
 * Revision 6.9  2003/01/17 19:44:20  lavr
 * Reduce dependencies
 *
 * Revision 6.8  2003/01/08 01:59:33  lavr
 * DLL-ize CONNECT library for MSVC (add NCBI_XCONNECT_EXPORT)
 *
 * Revision 6.7  2002/09/19 18:05:09  lavr
 * Header file guard macro changed; log moved to end
 *
 * Revision 6.6  2002/04/26 16:27:13  lavr
 * SSERVICE_Params: reset added for use in open/close pairs
 *
 * Revision 6.5  2001/09/24 20:25:11  lavr
 * +SSERVICE_Extra, +4th parameter for SERVICE_CreateConnectorEx()
 * -SERVICE_CreateConnector() - now implemented as macro
 *
 * Revision 6.4  2001/09/10 21:20:19  lavr
 * Few unimportant layout changes
 *
 * Revision 6.3  2001/06/04 17:00:18  lavr
 * Include files adjusted
 *
 * Revision 6.2  2000/12/29 17:48:34  lavr
 * Accepted server types included in SERVICE_CreateConnectorEx arguments.
 *
 * Revision 6.1  2000/10/07 22:15:12  lavr
 * Initial revision
 *
 * ==========================================================================
 */

#endif /* CONNECT___NCBI_SERVICE_CONNECTOR__H */