ulxr_requester.h

Go to the documentation of this file.

/***************************************************************************
             ulxr_requester.h  -  send rpc request ("rpc-client")
                             -------------------
    begin                : Sat Mar 23 2002
    copyright            : (C) 2002-2007 by Ewald Arnold
    email                : ulxmlrpcpp@ewald-arnold.de

    $Id: ulxr_requester.h 942 2006-12-31 13:10:54Z 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_REQUESTER_H
#define ULXR_REQUESTER_H

#include <exception>

#include <ulxmlrpcpp/ulxmlrpcpp.h>  // always first header
#include <ulxmlrpcpp/ulxr_call.h>
#include <ulxmlrpcpp/ulxr_mutex.h>
#include <ulxmlrpcpp/ulxr_response.h>


namespace ulxr {


class Protocol;
class Connection;
class Exception;

namespace hidden {


class ULXR_API_DECL0 ReceiverWrapperBase
{
  public:

    virtual ~ReceiverWrapperBase();

    virtual void receive(const MethodResponse &resp) const = 0;
};


template <class T>
class ReceiverWrapper : public ReceiverWrapperBase
{
  public:

   typedef void (T::*PMF)(const MethodResponse &resp);

   virtual ~ReceiverWrapper()
   {}

   virtual void receive(const MethodResponse &resp) const
   {
      (obj->*adr) (resp);
   }

  public:

   ReceiverWrapper(T *o, PMF a)
    : obj(o), adr(a)
   {}

  private:
   T    *obj;
   PMF   adr ;

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


typedef void (*StaticReceiver_t)(const MethodResponse &);

typedef ReceiverWrapperBase *DynamicReceiver_t;    // call Wrappers receiver

class ULXR_API_DECL0 Receiver_t
{
 public:
    Receiver_t(StaticReceiver_t recv);

    Receiver_t(DynamicReceiver_t recv);

    void receive(const MethodResponse &resp);

    void free();

 protected:

   StaticReceiver_t    static_recv;
   DynamicReceiver_t   dynamic_recv;
/*
 private:
    // forbid them all due to internal pointers
    const Receiver_t& operator= (const Receiver_t&);
    Receiver_t (const Receiver_t&);
*/
};


}  // namespace hidden


struct DispatcherData;


class ULXR_API_DECL0 Requester
{
 public:

   Requester(Protocol* prot, bool wbxml_mode = false);

   virtual ~Requester();

   MethodResponse call (const MethodCall& call,
                        const CppString &resource);

   MethodResponse call (const MethodCall& call,
                        const CppString &resource,
                        const CppString &user,
                        const CppString &pass);

#ifdef ULXR_MULTITHREADED

   void call (const MethodCall& call,
              const CppString &resource,
              hidden::Receiver_t recv);

   void call (const MethodCall& call,
              const CppString &resource,
              const CppString &user,
              const CppString &pass,
              hidden::Receiver_t recv);

#endif // ULXR_MULTITHREADED

   void transmit (const MethodCall& call,
                  const CppString &resource);

   void transmit (const MethodCall& call,
                  const CppString &resource,
                  const CppString &user,
                  const CppString &pass);

   static MethodResponse waitForResponse(Protocol *conn, bool wbxml);

#ifdef ULXR_MULTITHREADED

   unsigned numPendingRequests() const;

#endif

   bool isWbXml() const;

 protected:

   void send_call(const MethodCall& call,
                  const CppString &resource);

   MethodResponse waitForResponse();

#ifdef ULXR_MULTITHREADED

   void startDispatch(const MethodCall& call,
                      const CppString &resource,
                      hidden::Receiver_t recv);

#endif // ULXR_MULTITHREADED

 private:

#ifdef ULXR_MULTITHREADED

   friend void *dispatchThreaded(DispatcherData *data);

   virtual void forwardException();

   virtual void forwardException(const Exception &ex);

   virtual void forwardException(const std::exception &ex);

   void incPending();

   void decPending();

#endif

   bool               wbxml_mode;
   Protocol          *protocol;
   unsigned           cntPendingRequests;
   Mutex              pendingMutex;
};


#ifndef _MSC_VER

template <class T>
inline hidden::ReceiverWrapperBase*
make_receiver(T &w, typename hidden::ReceiverWrapper<T>::PMF pmf)
{
  return new hidden::ReceiverWrapper<T> (&w, pmf);
}

#else // work around m$vc bug

template <class T, class U>
inline hidden::ReceiverWrapper<T>*
make_receiver(T &w, U pmf)
{
  return new hidden::ReceiverWrapper<T> (&w, pmf);
}

#endif

inline hidden::StaticReceiver_t
make_receiver(hidden::StaticReceiver_t ptr)
{
  return ptr;
}


}  // namespace ulxr


#endif // ULXR_REQUESTER_H

---