ACE/examples/Web_Crawler/Web_Crawler.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Web_Crawler.h
   6  *
   7  *  @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef _WEB_CRAWLER_H
  13 #define _WEB_CRAWLER_H
  14
  15 #include "URL_Addr.h"
  16 #include "HTTP_URL.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 #pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 // Forward declaration.
  23 class URL_Visitor_Factory;
  24
  25 /**
  26  * @class Web_Crawler
  27  *
  28  * @brief An abstraction for a Web Crawler.
  29  *
  30  * This class is a Facade that organizes the other classes in the
  31  * solution, which include a factory that creates a visitor,
  32  * which in turn embodies the appropriate visitation strategy.
  33  */
  34 class Web_Crawler
  35 {
  36 public:
  37   /// Constructor.
  38   Web_Crawler ();
  39
  40   /// Destructor.
  41   ~Web_Crawler ();
  42
  43   /// Parses the command-line options and initializes the
  44   /// <URL_Visitor_Factory>.
  45   int open (int argc, ACE_TCHAR *argv[]);
  46
  47   /// Run the Web Crawler and carries out whatever visitation strategy
  48   /// is configured.  Returns -1 on failure and 0 on success.
  49   int run ();
  50
  51 private:
  52   /**
  53    * Pointer to a factory that creates visitors that explore URLs and
  54    * perform various tasks.  Subclasses of <URL_Visitor_Factory>
  55    * determine what happens during a visitation.
  56    */
  57   URL_Visitor_Factory *url_visitor_factory_;
  58 };
  59
  60 #endif /* _WEB_CRAWLER_H */