xapian-core/common/replicate_utils.h

   1 /** @file replicate_utils.h
   2  * @brief Utility functions for replication implementations
   3  */
   4 /* Copyright (C) 2010 Richard Boulton
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef XAPIAN_INCLUDED_REPLICATE_UTILS_H
  22 #define XAPIAN_INCLUDED_REPLICATE_UTILS_H
  23
  24 #include <string>
  25
  26 /** Create a new changeset file, and return an open fd for writing to it.
  27  *
  28  *  Creates the changeset directory, if required.
  29  *
  30  *  If there is already a changeset file of the given name, it is truncated by
  31  *  this.
  32  *
  33  *  @param changeset_dir The directory for the changesets.
  34  *  @param filename The name of the changeset file.
  35  *  @param changes_name A string which will be set to the path of the changeset
  36  *  file.
  37  *
  38  *  @return The open file descriptor.
  39  *
  40  *  @exception Xapian::DatabaseError if the changeset couldn't be opened.
  41  */
  42 int
  43 create_changeset_file(const std::string & changeset_dir,
  44                       const std::string & filename,
  45                       std::string & changes_name);
  46
  47 /** Write some changes from a buffer, and then drop them from the buffer.
  48  *
  49  *  @param changes_fd The filedescriptor to write to (-1 to skip writing).
  50  *  @param buf The buffer holding the changes.
  51  *  @param bytes The number of bytes to write and drop.
  52  */
  53 void
  54 write_and_clear_changes(int changes_fd, std::string & buf, size_t bytes);
  55
  56 #endif // XAPIAN_INCLUDED_REPLICATE_UTILS_H