event.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_EVENT_H
#define AJA_EVENT_H

#include "ajabase/common/public.h"
#include <string>

// forward declarations.
class AJAEventImpl;

class AJA_EXPORT AJAEvent
{
public:

    friend AJA_EXPORT AJAStatus AJAWaitForEvents(AJAEvent*, uint32_t, bool, uint32_t);

    AJAEvent(bool manualReset = true, const std::string& name = "");
    virtual ~AJAEvent();

    virtual AJAStatus Signal();

    virtual AJAStatus Clear();

    virtual AJAStatus SetState(bool signaled = true);

    virtual AJAStatus GetState(bool & outSignaled);
    
    virtual AJAStatus SetManualReset(bool manualReset);
    
    virtual AJAStatus GetManualReset(bool* pManualReset);

    virtual AJAStatus WaitForSignal(uint32_t timeout = 0xffffffff);

    virtual AJAStatus GetEventObject(uint64_t* pEventObject);

    virtual inline AJAStatus GetState(bool* pSignaled)  {return pSignaled ? GetState(*pSignaled) : AJA_STATUS_BAD_PARAM;}   

private:

    AJAEventImpl* mpImpl;
};

    AJA_EXPORT AJAStatus AJAWaitForEvents(  AJAEvent* pList, 
                                            uint32_t numEvents, 
                                            bool all = true, 
                                            uint32_t timeout = 0xffffffff);

#endif  //  AJA_EVENT_H