Event.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018, NVIDIA CORPORATION. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
 
#ifndef __MULTITHREAD_EVENT_H_
#define __MULTITHREAD_EVENT_H_

#include "Mutex.h"
#include "timespec.h"

class Event
{
public:
        Event( bool auto_reset=true );

        ~Event();

        void Wake();

        inline void Reset()                                                     { mQueryMutex.Lock(); mQuery = false; mQueryMutex.Unlock(); }

        bool Query();

        bool Wait();

        bool Wait( const timespec& timeout );
        
        inline bool Wait( uint64_t timeout )            { return (timeout == UINT64_MAX) ? Wait() : Wait(timeNew(timeout*1000*1000)); }
        
        inline bool WaitNs( uint64_t timeout )          { return (timeout == UINT64_MAX) ? Wait() : Wait(timeNew(timeout)); }
        
        inline bool WaitUs( uint64_t timeout )          { return (timeout == UINT64_MAX) ? Wait() : Wait(timeNew(timeout*1000)); }
        
        inline pthread_cond_t* GetID()                  { return &mID; }

protected:

        pthread_cond_t mID;

        Mutex mQueryMutex;
        bool  mQuery;
        bool  mAutoReset;
};


#endif