xapian-core/common/replicationprotocol.h

   1 /** @file replicationprotocol.h
   2  *  @brief Replication protocol version and message numbers
   3  */
   4 /* Copyright (C) 2008 Lemur Consulting Ltd
   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_REPLICATIONPROTOCOL_H
  22 #define XAPIAN_INCLUDED_REPLICATIONPROTOCOL_H
  23
  24 // Versions:
  25 // 1: Initial support
  26 #define XAPIAN_REPLICATION_PROTOCOL_MAJOR_VERSION 1
  27 #define XAPIAN_REPLICATION_PROTOCOL_MINOR_VERSION 0
  28
  29 // Reply types (master -> slave)
  30 enum replicate_reply_type {
  31     REPL_REPLY_END_OF_CHANGES,  // No more changes to transfer.
  32     REPL_REPLY_FAIL,            // Couldn't generate full set of changes.
  33     REPL_REPLY_DB_HEADER,       // The start of a whole DB copy.
  34     REPL_REPLY_DB_FILENAME,     // The name of a file in a DB copy.
  35     REPL_REPLY_DB_FILEDATA,     // Contents of a file in a DB copy.
  36     REPL_REPLY_DB_FOOTER,       // End of a whole DB copy.
  37     REPL_REPLY_CHANGESET        // A changeset file is being sent.
  38 };
  39
  40 // The maximum number of copies of a database to send in a single conversation.
  41 // If more copies than this are required, a REPL_REPLY_FAIL message will be
  42 // sent.
  43 #define MAX_DB_COPIES_PER_CONVERSATION 5
  44
  45 #endif // XAPIAN_INCLUDED_REPLICATIONPROTOCOL_H