Return to Scanner.h CVS log

Up to [Development] / fam / fam

Annotation of fam/fam/Scanner.h, Revision 1.1

1.1     ! trev        1: //  Copyright (C) 1999 Silicon Graphics, Inc.  All Rights Reserved.
        !             2: //
        !             3: //  This program is free software; you can redistribute it and/or modify it
        !             4: //  under the terms of version 2 of the GNU General Public License as
        !             5: //  published by the Free Software Foundation.
        !             6: //
        !             7: //  This program is distributed in the hope that it would be useful, but
        !             8: //  WITHOUT ANY WARRANTY; without even the implied warranty of
        !             9: //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  Further, any
        !            10: //  license provided herein, whether implied or otherwise, is limited to
        !            11: //  this program in accordance with the express provisions of the GNU
        !            12: //  General Public License.  Patent licenses, if any, provided herein do not
        !            13: //  apply to combinations of this program with other product or programs, or
        !            14: //  any other product whatsoever.  This program is distributed without any
        !            15: //  warranty that the program is delivered free of the rightful claim of any
        !            16: //  third person by way of infringement or the like.  See the GNU General
        !            17: //  Public License for more details.
        !            18: //
        !            19: //  You should have received a copy of the GNU General Public License along
        !            20: //  with this program; if not, write the Free Software Foundation, Inc., 59
        !            21: //  Temple Place - Suite 330, Boston MA 02111-1307, USA.
        !            22:
        !            23: #ifndef Scanner_included
        !            24: #define Scanner_included
        !            25:
        !            26: #include "Boolean.h"
        !            27: #include "Request.h"
        !            28:
        !            29: class Client;
        !            30: class Event;
        !            31:
        !            32: //  Scanner is an abstract base class for a short-lived object that
        !            33: //  scans an Interest.
        !            34: //
        !            35: //  Why?  Well, we can potentially generate a lot of data while
        !            36: //  scanning a directory, so output could get blocked in mid scan, so
        !            37: //  we need something to hold the scan's context while we wait for
        !            38: //  output to unblock.
        !            39: //
        !            40: //  Since the output flow control is managed by the Client, the Client
        !            41: //  owns the Scanner.  But the Scanner is created by a ClientInterest.
        !            42: //
        !            43: //  Yes, it's messy.
        !            44:
        !            45: class Scanner {
        !            46:
        !            47: public:
        !            48:
        !            49:     virtual ~Scanner();
        !            50:     virtual bool done();
        !            51:
        !            52: };
        !            53:
        !            54: #endif /* !Scanner_included */