(* Copyright 1996-2003 John D. Polstra.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgment:
 *      This product includes software developed by John D. Polstra.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $Id: TreeList.i3,v 1.15 2003/03/04 19:26:11 jdp Exp $ *)

INTERFACE TreeList;

IMPORT CVProto, Logger, Reaper, StreamWr, SupFileRecSeq, Thread;

TYPE
  T <: Public;

  Public = Thread.Closure OBJECT
  METHODS
    init(proto: CVProto.T;
         wr: StreamWr.T;
         collections: SupFileRecSeq.T;
         compLevel: [-1..9] := -1;
         reaper: Reaper.T := NIL;
         stats: Stats := NIL;
         trace: Logger.T := NIL): T;
  END;

  Stats <: StatsPublic;

  StatsPublic = MUTEX OBJECT
    numFiles, numDirs: CARDINAL := 0;
    bytesOut, wireBytesOut := 0.0d0;
  METHODS
    init(): Stats;
    start();
    update();
    finish();
  END;

(* A "TreeList.T" is the thread that traverses the client's directory
   tree, and sends its list of files to the server's Tree Differ.

   "proto" is the descriptor describing the version of the protocol
   that is being used.

   "wr" is the output stream to the Tree Differ.

   "collections" is a sequence of supfile records specifying which
   collections and releases to transfer.

   "compLevel" specifies the compression level to use.

   If a "reaper" is given, it will be notified just before the thread
   terminates.

   If "stats" is specified, the tree lister will maintain various
   statistics in the given object.  It will call the "start" method
   initially, then the "update" method after each update of the
   statistics, and finally, the "finish" method just before terminating. 

   Debugging information is written to the "trace" stream, if specified. *)

END TreeList.