file_transfer_tentacle.h

Go to the documentation of this file.

#ifndef FILE_TRANSFER_TENTACLE_CLASS
#define FILE_TRANSFER_TENTACLE_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : file_transfer_tentacle                                            *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2005-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include "file_transfer_infoton.h"
 
#include <basis/mutex.h>
#include <filesystem/directory_tree.h>
#include <filesystem/filename_list.h>
#include <octopus/tentacle_helper.h>
#include <timely/time_stamp.h>
 
namespace octopi {
 
class file_transfer_cleaner;
class file_transfer_status;
 
 
class file_transfer_tentacle
: public tentacle_helper<file_transfer_infoton>
{
public:
  enum transfer_modes {
    ONLY_REPORT_DIFFS = 0x1,  
    COMPARE_SIZE_AND_TIME = 0x2,  
    COMPARE_CONTENT_SAMPLE = 0x4,  
    COMPARE_ALL = 0x6  
  };
 
 
  file_transfer_tentacle(int maximum_transfer, transfer_modes mode_of_transfer);
 
  virtual ~file_transfer_tentacle();
 
  DEFINE_CLASS_NAME("file_transfer_tentacle");
 
  basis::astring text_form() const;
 
  filesystem::directory_tree *lock_directory(const basis::astring &source_mapping);
  void unlock_directory();
 
  // these methods are for the "server" side--the side that has files to offer.
 
  basis::outcome add_correspondence(const basis::astring &source_mapping,
          const basis::astring &source_root, int refresh_interval);
 
  basis::outcome remove_correspondence(const basis::astring &source_mapping);
 
  basis::outcome refresh_now(const basis::astring &source_mapping);
 
  bool add_path(const basis::astring &source_mapping, const basis::astring &new_path);
 
  bool remove_path(const basis::astring &source_mapping, const basis::astring &old_path);
 
  // these methods are for the client side--the side that wants to get files.
 
  basis::outcome register_file_transfer(const octopus_entity &ent,
          const basis::astring &src_root, const basis::astring &dest_root,
          const structures::string_array &include);
 
  basis::outcome cancel_file_transfer(const octopus_entity &ent,
          const basis::astring &src_root, const basis::astring &dest_root);
 
  bool status(const octopus_entity &ent, const basis::astring &src,
        const basis::astring &dest, double &total_size, int &total_files,
        double &current_size, int &current_files, bool &done,
        timely::time_stamp &last_active);
 
  bool get_differences(const octopus_entity &ent, const basis::astring &src,
        const basis::astring &dest, filesystem::filename_list &diffs);
 
  // required tentacle methods...
 
  virtual basis::outcome reconstitute(const structures::string_array &classifier,
          basis::byte_array &packed_form, infoton * &reformed);
 
  virtual basis::outcome consume(infoton &to_chow, const octopus_request_id &item_id,
          basis::byte_array &transformed);
 
  virtual void expunge(const octopus_entity &to_remove);
 
  // internal use only.
 
  void periodic_actions();  
 
private:
  int _maximum_transfer;  
  file_transfer_status *_transfers;  
  file_transfer_status *_correspondences;  
  basis::mutex *_lock;  
  file_transfer_cleaner *_cleaner;  
  int _mode;  
 
  // these process the request and response infotons that are passed to us.
  basis::outcome handle_build_target_tree_request(file_transfer_infoton &req,
          const octopus_request_id &item_id);
  basis::outcome handle_build_target_tree_response(file_transfer_infoton &resp,
          const octopus_request_id &item_id);
  basis::outcome handle_tree_compare_request(file_transfer_infoton &req,
          const octopus_request_id &item_id);
  basis::outcome handle_tree_compare_response(file_transfer_infoton &resp,
          const octopus_request_id &item_id);
  basis::outcome handle_storage_request(file_transfer_infoton &req,
          const octopus_request_id &item_id);
  basis::outcome handle_storage_response(file_transfer_infoton &resp,
          const octopus_request_id &item_id);
  basis::outcome conclude_storage_request(file_transfer_infoton &req,
          const octopus_request_id &item_id);
  basis::outcome conclude_storage_response(file_transfer_infoton &resp,
          const octopus_request_id &item_id);
};
 
} //namespace.
 
#endif