File:  [ELWIX - Embedded LightWeight unIX -] / libaitsync / inc / aitsync.h
Revision 1.3.2.1: download - view: text, annotated - select for diffs - revision graph
Tue Nov 13 10:00:30 2012 UTC (11 years, 8 months ago) by misho
Branches: sync1_2
Diff to: branchpoint 1.3: preferred, unified
added example dir
changed syncOpen()
moved structures from public header to private

    1: /*************************************************************************
    2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
    3: *  by Michael Pounov <misho@openbsd-bg.org>
    4: *
    5: * $Author: misho $
    6: * $Id: aitsync.h,v 1.3.2.1 2012/11/13 10:00:30 misho Exp $
    7: *
    8: **************************************************************************
    9: The ELWIX and AITNET software is distributed under the following
   10: terms:
   11: 
   12: All of the documentation and software included in the ELWIX and AITNET
   13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
   14: 
   15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
   16: 	by Michael Pounov <misho@elwix.org>.  All rights reserved.
   17: 
   18: Redistribution and use in source and binary forms, with or without
   19: modification, are permitted provided that the following conditions
   20: are met:
   21: 1. Redistributions of source code must retain the above copyright
   22:    notice, this list of conditions and the following disclaimer.
   23: 2. Redistributions in binary form must reproduce the above copyright
   24:    notice, this list of conditions and the following disclaimer in the
   25:    documentation and/or other materials provided with the distribution.
   26: 3. All advertising materials mentioning features or use of this software
   27:    must display the following acknowledgement:
   28: This product includes software developed by Michael Pounov <misho@elwix.org>
   29: ELWIX - Embedded LightWeight unIX and its contributors.
   30: 4. Neither the name of AITNET nor the names of its contributors
   31:    may be used to endorse or promote products derived from this software
   32:    without specific prior written permission.
   33: 
   34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
   35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   44: SUCH DAMAGE.
   45: */
   46: #ifndef __AITSYNC_H
   47: #define __AITSYNC_H
   48: 
   49: 
   50: // sync_GetErrno() Get error code of last operation
   51: inline int sync_GetErrno();
   52: // sync_GetError() Get error text of last operation
   53: inline const char *sync_GetError();
   54: 
   55: /*
   56:  * syncSignature() - Calculate and create signature for diff
   57:  *
   58:  * @csInput = Input file name for calculating check sums
   59:  * @csSig = Output Signature file name
   60:  * @compress = 2 compress signatures output, 0 not compressed
   61:  * return: -1 error, 0 ok
   62:  */
   63: int syncSignature(const char *csInput, const char *csSig, int compress);
   64: 
   65: /*
   66:  * syncDelta() - Create Delta patch file
   67:  *
   68:  * @csInput = Input original source file name for make delta patch file
   69:  * @csSig = Input Signature file name
   70:  * @csDelta = Output Delta patch file name
   71:  * @compress = 3 everything compress, 2 compressed signatures, 1 compress delta output, 0 not compressed
   72:  * return: -1 error, 0 ok, create delta patch, 1 ok, no differences and not create patch
   73:  */
   74: int syncDelta(const char *csInput, const char *csSig, const char *csDelta, int compress);
   75: 
   76: /*
   77:  * syncPatch() - Apply delta patch file to target
   78:  *
   79:  * @csInput = Input target file name for patch
   80:  * @csDelta = Input Delta patch file name
   81:  * @csPatch = After applied patch create new alternate target file, if != NULL
   82:  * @compress = 1 compress delta input, 0 not compressed
   83:  * return: -1 error, 0 ok, create delta patch, 1 ok, no differences and not create patch
   84:  */
   85: int syncPatch(const char *csInput, const char *csDelta, const char *csPatch, int compress);
   86: 
   87: 
   88: struct tagDirName;
   89: 
   90: /*
   91:  * sync_dircmp() Compare directories
   92:  * @csDir1 = Directory 1
   93:  * @csDir2 = Directory 2
   94:  * return: -1 error, 0 is equal or 1 different
   95:  */
   96: int sync_dircmp(const char *csDir1, const char *csDir2);
   97: /*
   98:  * sync_dirCSum() Calculate checksum of directory
   99:  * @csDir = Directory
  100:  * @md = Message digest allocated memory, must be free after use!
  101:  * return: -1 error or !=-1 ok
  102:  */
  103: int sync_dirCSum(const char *csDir, u_char **md);
  104: /*
  105:  * sync_dircmpList() Compare directories or directory and file list
  106:  * @csDir1 = Directory 1
  107:  * @csDir2 = Directory 2 or File list, if "-" get input from console
  108:  * @lm = Long mode options, 1 long output
  109:  * @list = Output diff list, after use must be free!
  110:  * return: -1 error, 0 is equal or >0 count of returned list items
  111:  */
  112: int sync_dircmpList(const char *csDir1, const char *csDir2, int lm, struct tagDirName **list);
  113: 
  114: 
  115: #endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>