UTEvent.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_EVENT_H_
#define _UT_EVENT_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UT.h"


//==================================================================================================
//=== Forward name declarations
//==================================================================================================
struct EventPlatformInfo_t;


//==================================================================================================
class UT_EXPORT Event_t
//==================================================================================================
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                            Event_t(    bool initially_set = false,
                                        bool allow_timeouts_other_than_zero_or_infinite = false );

                            ~Event_t();

    bool                    Wait(int32 timeout_ms = -1);

    void                    Set(int release_count = 1);

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    volatile int32          m_avail_count;
    EventPlatformInfo_t*    m_info;
};


#endif // _UT_EVENT_H_