ulxr_mtrpc_server.h

Go to the documentation of this file.

/***************************************************************************
           ulxr_mtrpc_server.h  -  a simple multithreaded rpc server
                             -------------------
    begin                : Wed Oct 10 2003
    copyright            : (C) 2002-2007 by Ewald Arnold
    email                : ulxmlrpcpp@ewald-arnold.de

    $Id: ulxr_mtrpc_server.h 991 2007-07-15 09:02:35Z ewald-arnold $

 ***************************************************************************/

/**************************************************************************
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2 of the License,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 ***************************************************************************/

#ifndef ULXR_MTRPC_SERVER_H
#define ULXR_MTRPC_SERVER_H

#include <ulxmlrpcpp/ulxmlrpcpp.h>  // always first header

#ifdef ULXR_MULTITHREADED

#include <vector>

#include <ulxmlrpcpp/ulxr_dispatcher.h>
#include <ulxmlrpcpp/ulxr_method_adder.h>

#ifdef __WIN32__
#include <process.h>
#include <windows.h>
#endif

#ifdef __unix__
#include <pthread.h>
#endif


namespace ulxr {


class Exception;
class Protocol;

class ULXR_API_DECL0 MultiThreadRpcServer : public MethodAdder
{
  public:
    class ThreadData;

    typedef void* (*ThreadLoopFunction)(ThreadData*);

    MultiThreadRpcServer(Protocol *prot, unsigned num, bool wbxml_mode = false);

    virtual ~MultiThreadRpcServer();

    unsigned dispatchAsync();

    unsigned numThreads() const;

    void terminateAllThreads(unsigned time = 0);

    void shutdownAllThreads(unsigned time = 0);

    void waitAsync(bool term, bool stat = false);

   void addMethod (MethodAdder::StaticMethodCall_t adr,
                   const CppString &ret_signature,
                   const CppString &name,
                   const CppString &signature,
                   const CppString &help);

   void addMethod (MethodAdder::DynamicMethodCall_t wrapper,
                   const CppString &ret_signature,
                   const CppString &name,
                   const CppString &signature,
                   const CppString &help);

   void addMethod (MethodAdder::SystemMethodCall_t adr,
                   const CppString &ret_signature,
                   const CppString &name,
                   const CppString &signature,
                   const CppString &help);

   void addMethod (MethodAdder::StaticMethodCall_t adr,
                   const Signature &ret_signature,
                   const CppString &name,
                   const Signature &signature,
                   const CppString &help);

   void addMethod (MethodAdder::DynamicMethodCall_t wrapper,
                   const Signature &ret_signature,
                   const CppString &name,
                   const Signature &signature,
                   const CppString &help);

   void addMethod (MethodAdder::SystemMethodCall_t adr,
                   const Signature &ret_signature,
                   const CppString &name,
                   const Signature &signature,
                   const CppString &help);

   void removeMethod(const CppString &name);

  protected:

   virtual void forwardThreadedError(const Exception &ex) const;

  /* The threaded function that does the work.
   * @param  conn  pointer to communication object
   * @param  td    pointer to working data
   */
   void *serverLoop(Protocol *protocol, ThreadData *td);

   void printStatistics() const;

   virtual void preProcessCall(MethodCall &call);

   virtual void preProcessResponse(MethodResponse &resp);

  private:

   static void *startThread(ThreadData *td);

   void releaseThreads();

   typedef void *(Thread_t) (ThreadData*);

   std::vector<ThreadData*>       threads;
   Dispatcher                     dispatcher;
   bool                           wbxml_mode;

 private:

   // forbid them all due to internal pointers
   MultiThreadRpcServer(const MultiThreadRpcServer&);
   MultiThreadRpcServer& operator=(const MultiThreadRpcServer&);
};


}  // namespace ulxr


#endif // ULXR_MULTITHREADED


#endif // ULXR_MTRPC_SERVER_H

---