ulxr_protocol.h

Go to the documentation of this file.

/***************************************************************************
                    ulxr_protocol.h  -  rpc prootocol
                             -------------------
    begin                : Mon May 3 2004
    copyright            : (C) 2002-2007 by Ewald Arnold
    email                : ulxmlrpcpp@ewald-arnold.de

    $Id: ulxr_protocol.h 940 2006-12-30 18:22:05Z 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_PROTOCOL_H
#define ULXR_PROTOCOL_H

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

#include <vector>


namespace ulxr {


class MethodCall;
class MethodResponse;
class Connection;

class ULXR_API_DECL0 Protocol
{
 public:

   Protocol(Connection *conn);

   virtual ~Protocol();

   void writeRaw(char const *buff, long len);

   long readRaw(char *buff, long len);

   virtual void open();

   bool accept(int timeout = 0) ;

   bool isOpen() const;

   virtual void shutdown(int mode) = 0;

   virtual void close();

   virtual bool hasBytesToRead() const = 0;

   virtual void resetConnection();

   virtual void sendRpcCall(const MethodCall &call, const CppString &resource, bool wbxml_mode);

   virtual void sendRpcResponse(const MethodResponse &resp, bool wbxml_mode);

   void setPersistent(bool pers);

   bool isPersistent() const;

   virtual bool responseStatus(CppString &phrase) const = 0;

   typedef enum
   {
     ConnStart,                 // 0 start and reset
     ConnPendingCR,             // 1 just found CR, wait for LF or fold whitespace
     ConnPendingHeaderLine,     // 2 new line started, may be folded
     ConnHeaderLine,            // 3 collection chars for current header line
     ConnSwitchToBody,          // 4 header completely read ==> analyse header fields
     ConnBody,                  // 5 in body, do nothing. Never reached if there is no body!
     ConnError,                 // 6 error occured, set status accordingly
     ConnLast                   // 7 last item for continuation
   }
   State;


   virtual State connectionMachine(char * &buffer, long &len);

   void addAuthentication(const CppString &user, const CppString &pass,
                          const CppString &realm);

   virtual void setMessageAuthentication(const CppString &user, const CppString &pass);

   virtual bool checkAuthentication(const CppString &realm) const;

   virtual void rejectAuthentication(const CppString &realm);

   virtual void setTransmitOnly();

   virtual bool isTransmitOnly();

   Connection * getConnection() const;

   virtual Protocol *detach() = 0;

 protected:

   void setConnection(Connection *conn);

   void setConnectionState(State state);

   State getConnectionState() const;

   void setRemainingContentLength(long len);

   long getRemainingContentLength() const;

   long getContentLength() const;

   void setContentLength(long len);

   virtual bool getUserPass(CppString &user, CppString &pass) const;

   virtual void determineContentLength() = 0;

   virtual CppString getProtocolName() = 0;

 private:

   void init();

 private:

   struct AuthData;
   struct PImpl;
   PImpl *pimpl;

 protected:

  Protocol(const Protocol&);

 private:

   Protocol& operator=(const Protocol&); // empty!
};


}  // namespace ulxr


#endif // ULXR_PROTOCOL_H

---