System documentation of the GNU Image-Finding Tool

CCommunicationHandler.h

/* -*- mode: c++ -*- 
*/
/* 

    GIFT, a flexible content based image retrieval system.
    Copyright (C) 1998, 1999, 2000, 2001, 2002, CUI University of Geneva

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU 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 General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/



//configuration files for sessions and algorithms/collections
#ifndef _CCOMMUNICATIONHANDLER
#define _CCOMMUNICATIONHANDLER
#include "libMRML/include/uses-declarations.h"
//the expat xml parser by J.Clark
#include <expat.h>
//a class for using xpat attributes in a nice way
#include "libMRML/include/CAttributeList.h"

//This is mrml+gift specific
#include "libMRML/include/CSessionManager.h"
#include "libMRML/include/CXMLElement.h"
#include <functional>
#include <iostream>
#include <fstream>
#include "libMRML/include/CMutex.h"
//----------------------------------------
extern void startMRMLElement(void *userData, 
                             const char *inElementName, 
                             const char **inAttributes);
extern void endMRMLElement(void *userData, const char *name);

class CCommunicationHandler{

  CSelfDestroyPointer<CXMLElement> mDocumentRoot;
  
  XML_Parser mParser;  
  
  CSessionManager& mSessionManager;
  CAlgorithm* mAlgorithmTree;
  CSelfDestroyPointer<CXMLElement> mCurrentTree;

  string mPeerAddressString;
  
public:
  CSelfDestroyPointer<CXMLElement> mMultiResponse;

protected:
  int mQueryAtRandomCount;
protected:
  int mSocket;
  ofstream& mLog;
public:
  //----------------------------------------
  //----------------------------------------
  void setSocket(int inSocket);

  //----------------------------------------
  //----------------------------------------
  string preamble();



  string frame(const string& inSession,
               const string& inString);

    
  //----------------------------------------
  string toAttribute(string inName,
                     string inString);

  
  string toAttribute(string inName,
                     int inInt);

  
  string toAttribute(string inName,
                     double inFloat);
    
  //     //----------------------------------------
  //     /** turning a relevance level element into a string */
  //     /** (obsolete) */
  //     string stringOfRelevanceLevelElement(const CRelevanceLevel& inRE,
  //                                     double inUserRelevance=0.5);
    
  //     string stringOfRelevanceLevelList(const CRelevanceLevelList& inRLL);
    
    
  //----------------------------------------
  int sendError(const string& inSession,
                const string& inMessage);

  //----------------------------------------
  void openSession(const string& inUserName,
                   const string& inSessionName);
  void renameSession(const string& inSessionID,
                     const string& inNewName);

  void deleteSession(const string& inName);


  void getPropertySheet(const string& inSessionID,
                        const string& inAlgorithmID);
  //----------------------------------------
  int sendHandshake(const string& inUser);
    
  void getSessions(const string& inUser);
  void getCollections();
  void getAlgorithms();
  //----------------------------------------
  int sendResult(const string& inSession,
                 const CXMLElement& inRLL);

  
  //----------------------------------------
  int sendRandomImages(const string& inSession,
                       const string& inAlgorithm,
                       const string& inCollection,
                       const string& inNumberOfImages) ;
  ;
  
  
  //----------------------------------------
  //----------------------------------------
  CXMLElement* gQueryImages;
  string mSessionID;
  int    mResultSize;
  double mCutoff;
  string mCollection;
  string mAlgorithm;

  //----------------------------------------
  void setResultSize(int inResultSize);


  void setResultCutoff(const string& inCutoff);

  void setResultCutoff(double inCutoff);


  void setCollectionID(const string& inID);


  void setAlgorithmID(const string& inID);

  //----------------------------------------
  void startTreeBuilding(const char* inElementName,
                         const char*const*const inAttributes);
  void addToCurrentTree(const char* inElementName,
                        const char*const*const inAttributes);
  void moveUpCurrentTree();
  bool isBuildingTree()const;

  //----------------------------------------
  //----------------------------------------
  void parseString(const string& inMessage);


  //----------------------------------------
  void clearAlgorithmElement();
  //----------------------------------------
  //----------------------------------------
  void startAlgorithmElement(const char* inName,
                             const char* const* const inAttributes);
  //----------------------------------------
  //----------------------------------------
  void endAlgorithmElement();
  //----------------------------------------
  //----------------------------------------
  void initAlgorithmElement();
  //----------------------------------------
  //----------------------------------------
  CAlgorithm* readAlgorithmElement();
  //----------------------------------------
  void endConfiguration();

  //----------------------------------------
  bool mParsingFinished;
  void clearParsingFinished();
  void setParsingFinished();
  bool isParsingFinished()const;

  bool readAndParse();

  

  void makeParser();


  void startMultiRequest(const string& inSessionID, const string& inLanguageCode="en");
  void endMultiRequest();
  void addToMultiResponse(CXMLElement* inElement);


  
  //----------------------------------------
  //----------------------------------------
  CSessionManager& getSessionManager();
  
  void incrementQueryAtRandomCount();
  int getQueryAtRandomCount()const;

  void setPeerAddressString(string);
  const string& getPeerAddressString()const;
  
  //----------------------------------------
  //----------------------------------------
  CCommunicationHandler(CSessionManager& inSessionManager,
                        ofstream& inLogFile);

  ~CCommunicationHandler();
};


#endif

---

Need for discussion? Want to contribute? Contact