code.grnet.gr Git - pithos-ms-client/blob - trunk/hammock/src/net35/ICSharpCode.SharpZipLib.Silverlight/Checksums/IChecksum.cs

   1 // IChecksum.cs - Interface to compute a data checksum
   2 // Copyright (C) 2001 Mike Krueger
   3 //
   4 // This file was translated from java, it was part of the GNU Classpath
   5 // Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License
   9 // as published by the Free Software Foundation; either version 2
  10 // of the License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20 //
  21 // Linking this library statically or dynamically with other modules is
  22 // making a combined work based on this library.  Thus, the terms and
  23 // conditions of the GNU General Public License cover the whole
  24 // combination.
  25 //
  26 // As a special exception, the copyright holders of this library give you
  27 // permission to link this library with independent modules to produce an
  28 // executable, regardless of the license terms of these independent
  29 // modules, and to copy and distribute the resulting executable under
  30 // terms of your choice, provided that you also meet, for each linked
  31 // independent module, the terms and conditions of the license of that
  32 // module.  An independent module is a module which is not derived from
  33 // or based on this library.  If you modify this library, you may extend
  34 // this exception to your version of the library, but you are not
  35 // obligated to do so.  If you do not wish to do so, delete this
  36 // exception statement from your version.
  37
  38 namespace ICSharpCode.SharpZipLib.Silverlight.Checksums
  39 {
  40     /// <summary>
  41     /// Interface to compute a data checksum used by checked input/output streams.
  42     /// A data checksum can be updated by one byte or with a byte array. After each
  43     /// update the value of the current checksum can be returned by calling
  44     /// <code>getValue</code>. The complete checksum object can also be reset
  45     /// so it can be used again with new data.
  46     /// </summary>
  47     public interface IChecksum
  48     {
  49         /// <summary>
  50         /// Returns the data checksum computed so far.
  51         /// </summary>
  52         long Value
  53         {
  54             get;
  55         }
  56
  57         /// <summary>
  58         /// Resets the data checksum as if no update was ever called.
  59         /// </summary>
  60         void Reset();
  61
  62         /// <summary>
  63         /// Adds one byte to the data checksum.
  64         /// </summary>
  65         /// <param name = "value">
  66         /// the data value to add. The high byte of the int is ignored.
  67         /// </param>
  68         void Update(int value);
  69
  70         /// <summary>
  71         /// Updates the data checksum with the bytes taken from the array.
  72         /// </summary>
  73         /// <param name="buffer">
  74         /// buffer an array of bytes
  75         /// </param>
  76         void Update(byte[] buffer);
  77
  78         /// <summary>
  79         /// Adds the byte array to the data checksum.
  80         /// </summary>
  81         /// <param name = "buffer">
  82         /// The buffer which contains the data
  83         /// </param>
  84         /// <param name = "offset">
  85         /// The offset in the buffer where the data starts
  86         /// </param>
  87         /// <param name = "count">
  88         /// the number of data bytes to add.
  89         /// </param>
  90         void Update(byte[] buffer, int offset, int count);
  91     }
  92 }