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 <octopus/tentacle_helper.h>

// forward.
class directory_tree;
class file_transfer_cleaner;
class file_transfer_status;
class filename_list;
class mutex;
class time_stamp;


class TENTACLES_CLASS_STYLE file_transfer_tentacle
: public tentacle_helper<file_transfer_infoton>
{
public:
  file_transfer_tentacle(int maximum_transfer, bool only_provide_comparisons);

  virtual ~file_transfer_tentacle();

  IMPLEMENT_CLASS_NAME("file_transfer_tentacle");

  istring text_form() const;

  directory_tree *lock_directory(const istring &source_mapping);
  void unlock_directory();

  // these methods are for the "server" side--the side that has files to offer.

  outcome add_correspondence(const istring &source_mapping,
          const istring &source_root, int refresh_interval);

  outcome remove_correspondence(const istring &source_mapping);

  outcome refresh_now(const istring &source_mapping);

  bool add_path(const istring &source_mapping, const istring &new_path);

  bool remove_path(const istring &source_mapping, const istring &old_path);

  // these methods are for the client side--the side that wants to get files.

  outcome register_file_transfer(const octopus_entity &ent,
          const istring &src_root, const istring &dest_root,
          const string_array &include);

  outcome cancel_file_transfer(const octopus_entity &ent,
          const istring &src_root, const istring &dest_root);

  bool status(const octopus_entity &ent, const istring &src,
        const istring &dest, double &total_size, int &total_files,
        double &current_size, int &current_files, bool &done,
        time_stamp &last_active);

  bool get_differences(const octopus_entity &ent, const istring &src,
        const istring &dest, filename_list &diffs);

  // required tentacle methods...

  virtual outcome reconstitute(const string_array &classifier,
          byte_array &packed_form, infoton * &reformed);

  virtual outcome consume(infoton &to_chow, const octopus_request_id &item_id,
          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;  
  mutex *_lock;  
  file_transfer_cleaner *_cleaner;  
  bool _only_comparisons;  

  // these process the request and response infotons that are passed to us.
  outcome handle_tree_compare_request(file_transfer_infoton &req,
          const octopus_request_id &item_id);
  outcome handle_tree_compare_response(file_transfer_infoton &req,
          const octopus_request_id &item_id);
  outcome handle_storage_request(file_transfer_infoton &req,
          const octopus_request_id &item_id);
  outcome handle_storage_response(file_transfer_infoton &req,
          const octopus_request_id &item_id);
};

#endif

---