gzProtocol.h

Go to the documentation of this file.

// *****************************************************************************
// File         : gzProtocol.h
// Module       : gzBase
// Description  : Class definition of serialize protocol classes
// Author       : Anders Modén      
// Product      : GizmoBase 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden       
//          
// NOTE:    GizmoBase is a platform abstraction utility layer for C++. It contains 
//          design patterns and C++ solutions for the advanced programmer.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981019  Created file    
//
// ******************************************************************************

#ifndef __GZ_PROTOCOL_H__
#define __GZ_PROTOCOL_H__

#include "gzSerialize.h"
#include "gzNotify.h"
#include "gzLex.h"
#include "gzNetwork.h"

enum gzParseHttpState
{
    GZ_HTTP_PARSE_STATE_RESET,
    GZ_HTTP_PARSE_STATE_PUBLIC,
    GZ_HTTP_PARSE_STATE_LAST
};

//******************************************************************************
// Class    : gzSerializeAdapterHttp
//                                  
// Purpose  : Class for Serialize data to Web Server
//                                  
// Notes    : This class is responsible to write/read data to a http adapter
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  040203  Created 
//                                  
//******************************************************************************
class  gzSerializeAdapterHttp : public gzSerializeAdapter , 
                                public gzNotifyInterface , 
                                public gzParserFunction<gzSerializeAdapterHttp,gzBasicParser>
{
public:
    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_BASE_EXPORT);   // RTTI

    GZ_BASE_EXPORT gzSerializeAdapterHttp(const gzString &url,gzSerializeAction action,gzSerializeAdapterFlags flags, const gzString &password);

    GZ_BASE_EXPORT virtual ~gzSerializeAdapterHttp();

    GZ_BASE_EXPORT virtual gzVoid flush();

    GZ_BASE_EXPORT gzBool openURL(const gzString &url);

    GZ_PROPERTY_GET_EXPORT( gzString,       User                ,GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzString,       Password            ,GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzUShort,       HostPort            ,GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzString,       Host                ,GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzString,       Path                ,GZ_BASE_EXPORT);

    GZ_PROPERTY_EXPORT(     gzString,       AttributeString     ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzULong,        MajorVersion        ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzULong,        MinorVersion        ,GZ_BASE_EXPORT);

    GZ_PROPERTY_EXPORT(     gzString,       DefaultUser         ,GZ_BASE_EXPORT);
    GZ_PROPERTY_EXPORT(     gzUShort,       DefaultHostPort     ,GZ_BASE_EXPORT);

    
    GZ_PROPERTY_GET_EXPORT( gzULong,        LastContentLength   ,GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzString,       LastContentType     ,GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzString,       LastContentBase     ,GZ_BASE_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzULong,        LastErrorCode       ,GZ_BASE_EXPORT);

    GZ_BASE_EXPORT  gzBool  hasPublicMethod(const gzString &methodName);

    GZ_BASE_EXPORT  gzVoid  resetLastError();   

protected:

    // Utilities
    GZ_BASE_EXPORT          gzBool      waitForAnswer( gzULong timeOut=GZ_SLEEP_INFINITE);

    GZ_BASE_EXPORT virtual  gzVoid      initConnection();
    GZ_BASE_EXPORT virtual  gzVoid      sendOptionRequest();
        
    // Adapter
    GZ_BASE_EXPORT  virtual gzVoid      write_imp(gzUByte data);
    GZ_BASE_EXPORT  virtual gzUByte     read_imp();

    GZ_BASE_EXPORT  virtual gzVoid      write_imp(gzUByte *data,gzULong count);
    GZ_BASE_EXPORT  virtual gzULong     read_imp(gzUByte *data,gzULong maxcount);
    GZ_BASE_EXPORT  virtual gzULong     length_imp();
    GZ_BASE_EXPORT  virtual gzBool      hasData_imp();

    // parsing

    GZ_BASE_EXPORT virtual gzParseResult parseMessage();
    GZ_BASE_EXPORT virtual gzParseResult parseRequest();
    GZ_BASE_EXPORT virtual gzParseResult parseRequestLine();
    GZ_BASE_EXPORT virtual gzParseResult parseRequestHeader();
    GZ_BASE_EXPORT virtual gzParseResult parseRequestURI();
    GZ_BASE_EXPORT virtual gzParseResult parseResponse();
    GZ_BASE_EXPORT virtual gzParseResult parseResponseHeader();
    GZ_BASE_EXPORT virtual gzParseResult parseGeneralHeader();
    GZ_BASE_EXPORT virtual gzParseResult parseEntityHeader();
    GZ_BASE_EXPORT virtual gzParseResult parseStatusLine();
    GZ_BASE_EXPORT virtual gzParseResult parseMessageBody();
    GZ_BASE_EXPORT virtual gzParseResult parseVersion();
    GZ_BASE_EXPORT virtual gzParseResult parseStatusCode();
    GZ_BASE_EXPORT virtual gzParseResult parseReasonPhrase();
    GZ_BASE_EXPORT virtual gzParseResult parseWWWAuthenticate();
    GZ_BASE_EXPORT virtual gzParseResult parseAllow();
    GZ_BASE_EXPORT virtual gzParseResult parseContentBase();
    GZ_BASE_EXPORT virtual gzParseResult parseContentEncoding();
    GZ_BASE_EXPORT virtual gzParseResult parseContentLanguage();
    GZ_BASE_EXPORT virtual gzParseResult parseContentLength();
    GZ_BASE_EXPORT virtual gzParseResult parseContentLocation();
    GZ_BASE_EXPORT virtual gzParseResult parseContentType();
    GZ_BASE_EXPORT virtual gzParseResult parseExpires();
    GZ_BASE_EXPORT virtual gzParseResult parseLastModified();
    GZ_BASE_EXPORT virtual gzParseResult parseExtensionHeader();
    GZ_BASE_EXPORT virtual gzParseResult parseCacheControl();
    GZ_BASE_EXPORT virtual gzParseResult parseConnection();
    GZ_BASE_EXPORT virtual gzParseResult parseDate();
    GZ_BASE_EXPORT virtual gzParseResult parseVia();
    GZ_BASE_EXPORT virtual gzParseResult parseServer();
    GZ_BASE_EXPORT virtual gzParseResult parseVary();
    GZ_BASE_EXPORT virtual gzParseResult parseRetryAfter();
    GZ_BASE_EXPORT virtual gzParseResult parsePublic();
    GZ_BASE_EXPORT virtual gzParseResult parseProxyAuthenticate();
    GZ_BASE_EXPORT virtual gzParseResult parseLocation();
    GZ_BASE_EXPORT virtual gzParseResult parseMethod();
    GZ_BASE_EXPORT virtual gzParseResult parseExtensionMethod();
    GZ_BASE_EXPORT virtual gzParseResult parseMethodList();
    GZ_BASE_EXPORT virtual gzParseResult parseCacheDirectiveList();
    GZ_BASE_EXPORT virtual gzParseResult parseCacheDirective();
    GZ_BASE_EXPORT virtual gzParseResult parseCacheResponce();
    GZ_BASE_EXPORT virtual gzParseResult parseCacheRequest();
    GZ_BASE_EXPORT virtual gzParseResult parseFieldNameList();
    
    // Basics

    GZ_BASE_EXPORT gzParseResult parseToken();
    
    // Compounds

    GZ_BASE_EXPORT gzParseResult parseDigit_();
    GZ_BASE_EXPORT gzParseResult parseHEX_();
    GZ_BASE_EXPORT gzParseResult parseToken_();
    GZ_BASE_EXPORT gzParseResult parseTokenOrSP_();
    GZ_BASE_EXPORT gzParseResult parseLWS();
    GZ_BASE_EXPORT gzParseResult parseLWS_();
    GZ_BASE_EXPORT gzParseResult parseText();
    GZ_BASE_EXPORT gzParseResult parseText_();
    GZ_BASE_EXPORT gzParseResult parseTSpecials();
    GZ_BASE_EXPORT gzParseResult parseCText();
    GZ_BASE_EXPORT gzParseResult parseComment();
    GZ_BASE_EXPORT gzParseResult parseDQText();
    GZ_BASE_EXPORT gzParseResult parseDQString();
    GZ_BASE_EXPORT gzParseResult parseAbsoluteURI();
    GZ_BASE_EXPORT gzParseResult parseReserved();
    GZ_BASE_EXPORT gzParseResult parseScheme();
    GZ_BASE_EXPORT gzParseResult parseScheme_();
    GZ_BASE_EXPORT gzParseResult parseUChar();
    GZ_BASE_EXPORT gzParseResult parseEscape();
    GZ_BASE_EXPORT gzParseResult parseUnreserved();
    GZ_BASE_EXPORT gzParseResult parseSafe();
    GZ_BASE_EXPORT gzParseResult parseUnsafe();
    GZ_BASE_EXPORT gzParseResult parseExtra();
    GZ_BASE_EXPORT gzParseResult parseNational();
    GZ_BASE_EXPORT gzParseResult parseMediaType();
    GZ_BASE_EXPORT gzParseResult parseParameter();
    GZ_BASE_EXPORT gzParseResult parseHost();
    GZ_BASE_EXPORT gzParseResult parseHostName();
    GZ_BASE_EXPORT gzParseResult parseDomainLabel();
    GZ_BASE_EXPORT gzParseResult parseTopLabel();
    GZ_BASE_EXPORT gzParseResult parseProduct();


    GZ_BASE_EXPORT gzBool checkMethod(const gzString &methodName);


    // Socket callback
    GZ_BASE_EXPORT virtual gzVoid onNotify(gzNotifyManager *master,gzRefPointer<gzNotifyMessage> &data,gzULong senderClass);

    // parse callback
    GZ_BASE_EXPORT virtual gzVoid parseInput(gzUByte *buffer,gzULong len);
    GZ_BASE_EXPORT virtual gzVoid onMessageBody(gzUByte *buffer,gzULong len);


    gzSocket                    m_socket;

    gzDict<gzString,gzVoid>     m_publicMethods;

    gzQueue<gzParseHttpState>   m_currentState;

    gzEvent                     m_event;

    gzULong                     m_pendingBodyData;

    gzMutex                     m_dataLocker;
};

#endif // __GZ_PROTOCOL_H__

---