#if !defined(VOCAL_FIFO_HXX)
#define VOCAL_FIFO_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 FifoHeaderVersion =
    "$Id: Fifo.h,v 1.28.2.2 2003/01/30 22:39:09 bko Exp $";


#include "FifoBase.h"
#include "Condition.hxx"
#include <cerrno>


/* Infrastructure common to VOCAL.
 */
namespace Vocal 
{


/** 
    This template class implements a thread safe FIFO (first in first
    out) queue of messages.  @see FifoBase# for its methods.

 */
template <class Msg> class Fifo : public FifoBase<Msg>
{
    public:


        /** Create an empty FIFO
         */
        Fifo();


        /** Delete the FIFO - must be empty when deleted
         */
        virtual ~Fifo();

    private:


        /** Wake's up the blocked thread.
         */
        virtual void	wakeup()
        throw ( VException );


        /** Blocks the thread, waiting for a message. Note that the
         *  mutex_ is locked upon entry. It is the responsibility
         *  of the user to unlock the mutex if necessary.
         */
        virtual int	wait(milliseconds_t relativeTime)
        throw ( VException );


        /** Conditional variable for waiting until the FIFO is not empty
         */
        Condition       myCondition;
};


#include "Fifo.cc"


} // namespace Vocal


#endif // !defined(VOCAL_FIFO_HXX)