XmlRpcServer.h

Go to the documentation of this file.

// this file modified by Morgan Quigley on 22 Apr 2008.
// added features: server can be opened on port 0 and you can read back
// what port the OS gave you

#ifndef _XMLRPCSERVER_H_
#define _XMLRPCSERVER_H_
//
// XmlRpc++ Copyright (c) 2002-2003 by Chris Morley
//
#if defined(_MSC_VER)
# pragma warning(disable:4786)    // identifier was truncated in debug info
#endif

#ifndef MAKEDEPEND
# include <map>
# include <string>
# include <vector>
# ifndef _WINDOWS
#  include <poll.h>
# endif
#endif

#include "xmlrpcpp/XmlRpcDispatch.h"
#include "xmlrpcpp/XmlRpcSource.h"
#include "xmlrpcpp/XmlRpcDecl.h"

namespace XmlRpc {


  // An abstract class supporting XML RPC methods
  class XmlRpcServerMethod;

  // Class representing connections to specific clients
  class XmlRpcServerConnection;

  // Class representing argument and result values
  class XmlRpcValue;


  class XMLRPCPP_DECL XmlRpcServer : public XmlRpcSource {
  public:
    XmlRpcServer();
    virtual ~XmlRpcServer();

    void enableIntrospection(bool enabled=true);

    void addMethod(XmlRpcServerMethod* method);

    void removeMethod(XmlRpcServerMethod* method);

    void removeMethod(const std::string& methodName);

    XmlRpcServerMethod* findMethod(const std::string& name) const;

    bool bindAndListen(int port, int backlog = 5);

    void work(double msTime);

    void exit();

    void shutdown();

    void listMethods(XmlRpcValue& result);

    // XmlRpcSource interface implementation

    virtual unsigned handleEvent(unsigned eventType);

    virtual void removeConnection(XmlRpcServerConnection*);

    inline int get_port() { return _port; }

    XmlRpcDispatch *get_dispatch() { return &_disp; }

  protected:

    virtual unsigned acceptConnection();

    virtual XmlRpcServerConnection* createConnection(int socket);

    bool enoughFreeFDs();

    // Whether the introspection API is supported by this server
    bool _introspectionEnabled;

    // Event dispatcher
    XmlRpcDispatch _disp;

    // Collection of methods. This could be a set keyed on method name if we wanted...
    typedef std::map< std::string, XmlRpcServerMethod* > MethodMap;
    MethodMap _methods;

    // system methods
    XmlRpcServerMethod* _listMethods;
    XmlRpcServerMethod* _methodHelp;

    int _port;

    // Flag indicating that accept had an error and needs to be retried.
    bool _accept_error;
    // If we cannot accept(), retry after this many seconds. Hopefully there
    // will be more free file descriptors later.
    static const double ACCEPT_RETRY_INTERVAL_SEC;
    // Retry time for accept.
    double _accept_retry_time_sec;

    // Minimum number of free file descriptors before rejecting clients.
    static const int FREE_FD_BUFFER;
#ifndef _WINDOWS
    // List of all file descriptors, used for counting open files.
    std::vector<struct pollfd> pollfds;
#endif
  };
} // namespace XmlRpc

#endif //_XMLRPCSERVER_H_