threaded_server.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:5k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: threaded_server.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 16:33:19  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R6.8
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef CONNECT___THREADED_SERVER__HPP
  10. #define CONNECT___THREADED_SERVER__HPP
  11. /*  $Id: threaded_server.hpp,v 1000.0 2003/10/29 16:33:19 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Author:  Aaron Ucko
  37.  *
  38.  * File Description:
  39.  *   Framework for a multithreaded network server
  40.  *
  41.  */
  42. #include <corelib/ncbistd.hpp>
  43. #include <connect/ncbi_conn_exception.hpp>
  44. #include <connect/ncbi_socket.h>
  45. /** @addtogroup ThreadedServer
  46.  *
  47.  * @{
  48.  */
  49. BEGIN_NCBI_SCOPE
  50. /// Exceptions thrown by CThreadedServer::Run
  51. class NCBI_XCONNECT_EXPORT CThreadedServerException
  52.     : EXCEPTION_VIRTUAL_BASE public CConnException
  53. {
  54. public:
  55.     enum EErrCode {
  56.         eBadParameters, ///< Out-of-range parameters given
  57.         eCouldntListen  ///< Unable to bind listening port
  58.     };
  59.     virtual const char* GetErrCodeString(void) const
  60.     {
  61.         switch (GetErrCode()) {
  62.         case eBadParameters: return "eBadParameters";
  63.         case eCouldntListen: return "eCouldntListen";
  64.         default:             return CException::GetErrCodeString();
  65.         }
  66.     }
  67.     NCBI_EXCEPTION_DEFAULT(CThreadedServerException, CConnException);
  68. };
  69. // CThreadedServer - abstract class for network servers using thread pools.
  70. //   This code maintains a pool of threads (initially m_InitThreads, but
  71. //   potentially as many as m_MaxThreads) to deal with incoming connections;
  72. //   each connection gets assigned to one of the worker threads, allowing
  73. //   the server to handle multiple requests in parallel while still checking
  74. //   for new requests.
  75. //
  76. //   You must define Process() to indicate what to do with each incoming
  77. //   connection; .../src/connect/test_threaded_server.cpp illustrates
  78. //   how you might do this.
  79. class NCBI_XCONNECT_EXPORT CThreadedServer
  80. {
  81. public:
  82.     CThreadedServer(unsigned int port) :
  83.         m_InitThreads(5), m_MaxThreads(10), m_QueueSize(20),
  84.         m_SpawnThreshold(1), m_TemporarilyStopListening(false), m_Port(port)
  85.         {}
  86.     void Run(void);
  87.     // Runs asynchronously (from a separate thread) for each request
  88.     // Implementor must take care of closing socket when done
  89.     virtual void Process(SOCK sock) = 0;
  90. protected:
  91.     // Runs synchronously when request queue is full
  92.     // Implementor must take care of closing socket when done
  93.     virtual void ProcessOverflow(SOCK sock) { SOCK_Close(sock); }
  94.     // Called at the beginning of Run, before creating thread pool
  95.     virtual void SetParams() {}
  96.     // Settings for thread pool
  97.     unsigned int m_InitThreads;     // Number of initial threads
  98.     unsigned int m_MaxThreads;      // Maximum simultaneous threads
  99.     unsigned int m_QueueSize;       // Maximum size of request queue
  100.     unsigned int m_SpawnThreshold;  // Controls when to spawn more threads
  101.     // Temporarily close listener when queue fills?
  102.     bool         m_TemporarilyStopListening;
  103. private:
  104.     unsigned int m_Port; // TCP port to listen on
  105. };
  106. END_NCBI_SCOPE
  107. /* @} */
  108. /*
  109.  * ---------------------------------------------------------------------------
  110.  * $Log: threaded_server.hpp,v $
  111.  * Revision 1000.0  2003/10/29 16:33:19  gouriano
  112.  * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R6.8
  113.  *
  114.  * Revision 6.8  2003/08/12 19:27:52  ucko
  115.  * +CThreadedServerException
  116.  *
  117.  * Revision 6.7  2003/04/09 19:06:05  siyan
  118.  * Added doxygen support
  119.  *
  120.  * Revision 6.6  2002/12/19 14:51:48  dicuccio
  121.  * Added export specifier for Win32 DLL builds.
  122.  *
  123.  * Revision 6.5  2002/09/19 18:06:04  lavr
  124.  * Header file guard macro changed
  125.  *
  126.  * Revision 6.4  2002/01/25 15:39:29  ucko
  127.  * Completely reorganized threaded servers.
  128.  *
  129.  * Revision 6.3  2002/01/24 20:18:56  ucko
  130.  * Add comments
  131.  * Add magic TemporarilyStopListening overflow processor
  132.  *
  133.  * Revision 6.2  2002/01/24 18:36:07  ucko
  134.  * Allow custom queue-overflow handling.
  135.  *
  136.  * Revision 6.1  2001/12/11 19:55:21  ucko
  137.  * Introduce thread-pool-based servers.
  138.  *
  139.  */
  140. #endif  /* CONNECT___THREADED_SERVER__HPP */