#if !defined(VOCAL_GARBAGE_CAN_HXX)
#define VOCAL_GARBAGE_CAN_HXX

/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2000 Vovida Networks, Inc.  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. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY 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.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */


static const char* const GarbageCan_hxx_Version = 
    "$Id: GarbageCan.hxx,v 1.3 2002/07/11 18:54:44 veer Exp $";


#include "Mutex.hxx"
#include <list>


/** Infrastructure common to VOCAL.<br><br>
 */
namespace Vocal 
{


class Application;
class Garbage;


using Vocal::Threads::Mutex;
//using Vocal::Application;
using std::list;


/** A container that will destroy the contents upon destruction.
 *  Currently only the Application class and is allowed  to create and 
 *  destroy a garbage can. This is the mechanism by which Singletons 
 *  are destroyed.
 */
class GarbageCan
{
    private:
    
        /** Constructor
         */
        GarbageCan();
        
        
        /** Destructor
         */
        ~GarbageCan();
   
   public:
   

        /** Anyone can add garbage to the garbage can. It will be deleted
         *  when the garbage can is deleted. This is thread safe.
         */
        static void add(Garbage *);

        
    private:

    
        /** Deletes all the items in the garbage can. This is thread safe.
         */        
        void        empty();

    
        /** Protects the garbage list from concurrent access.
         */
        static  Mutex               myMutex;
        
        
        /** The stuff that need to be deleted.
         */
        static  list<Garbage *>     myGarbage;
        

    // Only Applications can create a GarbageCan.
    //
    friend  class Application;
};


} // namespace Vocal


#endif // !defined(VOCAL_GARBAGE_CAN_HXX)