heavy_file_ops.h

Go to the documentation of this file.

#ifndef HEAVY_FILE_OPERATIONS_CLASS
#define HEAVY_FILE_OPERATIONS_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : heavy file operations                                             *
*  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 "opsysdll.h"

#include <basis/object_base.h>
#include <basis/packable.h>

// forward.
class file_transfer_header;
class filename_list;


class OPSYSTEM_CLASS_STYLE heavy_file_operations
{
public:
  virtual ~heavy_file_operations();

  enum outcomes {
    OKAY = common::OKAY,
    BAD_INPUT = common::BAD_INPUT,
//    GARBAGE = common::GARBAGE,
//    NOT_FOUND = common::NOT_FOUND,
//    NONE_READY = common::NONE_READY,
//    FAILURE = common::FAILURE,
    DEFINE_OUTCOME(SOURCE_MISSING, -47, "The source file is not accessible"),
    DEFINE_OUTCOME(TARGET_DIR_ERROR, -48, "The target's directory could not "
        "be created"),
    DEFINE_OUTCOME(TARGET_ACCESS_ERROR, -49, "The target file could not be "
        "created")
  };
  static const char *outcome_name(const outcome &to_name);

  IMPLEMENT_CLASS_NAME("heavy_file_operations");

  static const size_t COPY_CHUNK_FACTOR;
  static const size_t copy_chunk_factor();

  static outcome copy_file(const istring &source, const istring &destination,
          int copy_chunk_factor = copy_chunk_factor());

//can't live here due to use of tentacles.
/*  static outcome copy_hierarchy(const istring &source_dir,
          const istring &target_dir,
          const istring &source_start = istring::empty_string()); */

  static outcome write_file_chunk(const istring &target, double byte_start,
          const byte_array &chunk, bool truncate = true,
          int copy_chunk_factor = copy_chunk_factor());

  static outcome buffer_files(const istring &source_root,
          const filename_list &to_transfer, file_transfer_header &last_action,
          byte_array &storage, int maximum_bytes);

};



class OPSYSTEM_CLASS_STYLE file_transfer_header : public packable
{
public:
  istring _filename;  
  double _byte_start;  
  int _length;  

  file_transfer_header();

  virtual void pack(byte_array &packed_form) const;
  virtual bool unpack(byte_array &packed_form);

  virtual int packed_size() const;

  istring text_form() const;
};

#endif

---