ulxr_dispatcher.h

Go to the documentation of this file.

/***************************************************************************
         ulxr_dispatcher.h  -  answer rpc requests ("rpc-server")
                             -------------------
    begin                : Sat Mar 23 2002
    copyright            : (C) 2002-2007 by Ewald Arnold
    email                : ulxmlrpcpp@ewald-arnold.de

    $Id: ulxr_dispatcher.h 1026 2007-07-25 07:48:09Z 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_DISPATCHER_H
#define ULXR_DISPATCHER_H

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

#include <ulxmlrpcpp/ulxr_call.h>
#include <ulxmlrpcpp/ulxr_response.h>
#include <ulxmlrpcpp/ulxr_method_adder.h>


namespace ulxr {


class Protocol;
class Connection;
class Struct;
class Signature;


class ULXR_API_DECL0 Dispatcher : public MethodAdder
{
 public:

   struct ULXR_API_DECL0 MethodCallDescriptor
   {

     friend class Dispatcher;

     MethodCallDescriptor(const MethodCall &call);

     MethodCallDescriptor(CallType calltype,
                          const CppString &ret_sig,
                          const CppString &name,
                          const CppString &signature,
                          const CppString &help);

     bool operator == (const MethodCallDescriptor &desc) const
       { return getSignature(true, false) == desc.getSignature(true, false); }

     bool operator < (const MethodCallDescriptor &desc) const
       { return getSignature(true, false) < desc.getSignature(true, false); }

     CppString getSignature(bool with_name, bool with_return) const;

     unsigned long getInvoked() const;

     void incInvoked() const;

     bool isEnabled() const;

     void setEnabled(bool ena) const;

     CppString getMethodName() const;

     CppString getParameterSignature() const;

     CppString getReturnValueSignature() const;

     CppString getDocumentation() const;

     CallType getCallType() const;

    private:

     CallType         calltype;
     CppString        method_name;
     CppString        signature;
     CppString        return_signature;
     CppString        documentation;

     mutable unsigned long  invoked;
     mutable bool           enabled;
   };

 protected:

   typedef std::map<MethodCallDescriptor, MethodCall_t> MethodCallMap;

   friend void free_dynamic_method(const MethodCallMap::value_type &);

   friend struct MethodCallDescriptor;

 public:

   Dispatcher (Protocol* prot = 0, bool wbxml_mode = false);

   virtual ~Dispatcher ();

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

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

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

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

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

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

   virtual MethodCall waitForCall(int timeout = 0);

   virtual MethodResponse dispatchCall(const MethodCall &call) const;

   virtual MethodResponse dispatchCallLoc(const MethodCall &call) const;

   virtual void sendResponse(const MethodResponse &resp);

   Protocol* getProtocol() const;

   void setProtocol(Protocol *prot);

   unsigned numMethods() const;

   const MethodCallDescriptor * const getMethod(unsigned index);

   bool hasMethod(const MethodCall &call) const;

   void removeMethod(const CppString &name);

 protected:

   void addMethodDescriptor (const MethodCallDescriptor &desc,
                             MethodCall_t mct);

   void setupSystemMethods();

   static MethodResponse xml_pretty_print(const MethodCall &calldata,
                                          const Dispatcher *disp);

   static MethodResponse system_listMethods(const MethodCall &calldata,
                                            const Dispatcher *disp);

   static MethodResponse system_methodSignature(const MethodCall &calldata,
                                                const Dispatcher *disp);

   static MethodResponse system_methodHelp(const MethodCall &calldata,
                                           const Dispatcher *disp);

  static MethodResponse system_getCapabilities(const MethodCall &calldata,
                                               const Dispatcher *disp);

   virtual void getCapabilities (Struct &str) const;

 private:

   MethodCallMap             methodcalls;
   Protocol                 *protocol;
   bool                      wbxml_mode;
};


}  // namespace ulxr


#endif // ULXR_DISPATCHER_H

---