AJAEvent Class Reference

#include <event.h>

Public Member Functions
	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 *pSignaled)
virtual AJAStatus	SetManualReset (bool manualReset)
virtual AJAStatus	GetManualReset (bool *pManualReset)
virtual AJAStatus	WaitForSignal (uint32_t timeout=0xffffffff)
virtual AJAStatus	GetEventObject (uint64_t *pEventObject)

Friends
AJA_EXPORT AJAStatus	AJAWaitForEvents (AJAEvent *, uint32_t, bool, uint32_t)

Detailed Description

System independent event class for signaling between threads.

Definition at line 21 of file event.h.

Constructor & Destructor Documentation

AJAEvent()

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

Constructor obtains an event object from the system.

The event is automatically reset when the first waiting thread is released. Set manualReset to control the reset with the api. Specify a name if the event is to be shared system wide.

Parameters

[in]	manualReset	true if event must be reset by caller. false if event automatically reset.
[in]	name	Name of a shared lock object.

Definition at line 25 of file event.cpp.

~AJAEvent()

AJAEvent::~AJAEvent ( )

virtual

Definition at line 32 of file event.cpp.

Member Function Documentation

Clear()

AJAStatus AJAEvent::Clear ( )

virtual

Set the event to a non signaled state.

Returns

AJA_STATUS_SUCCESS Event cleared AJA_STATUS_FAIL Clear failed AJA_STATUS_OPEN Event not initialized

Definition at line 52 of file event.cpp.

GetEventObject()

AJAStatus AJAEvent::GetEventObject ( uint64_t *  pEventObject )

virtual

Get the system event object.

Parameters

[out]

pEventObject

The system event object

Returns

AJA_STATUS_SUCCESS Event object returned AJA_STATUS_OPEN Event not initialized

Definition at line 94 of file event.cpp.

GetManualReset()

AJAStatus AJAEvent::GetManualReset ( bool *  pManualReset )

virtual

Get the manual reset state.

Parameters

[out]

pManualReset

True indicates manually reset of signal is required, False indicates it is automatic

Returns

AJA_STATUS_SUCCESS Manual reset state initialized AJA_STATUS_FAIL Manual reset state not initialized

Definition at line 80 of file event.cpp.

GetState()

AJAStatus AJAEvent::GetState ( bool *  pSignaled )

virtual

Get the current state of the event.

Parameters

[out]

pSignaled

True if signaled

Returns

AJA_STATUS_SUCCESS State available AJA_STATUS_OPEN Event not initialized AJA_STATUS_FAIL Event error

Definition at line 66 of file event.cpp.

SetManualReset()

AJAStatus AJAEvent::SetManualReset ( bool  manualReset )

virtual

Set the manual reset state.

Parameters

[in]

manualReset

True to enable manual signal reset, False to enabled automatically reset of signal

Returns

AJA_STATUS_SUCCESS Manual reset state set AJA_STATUS_FAIL Manual reset state not set

Definition at line 73 of file event.cpp.

SetState()

AJAStatus AJAEvent::SetState ( bool  signaled = true )

virtual

Set the event to the state specified by the parameter signaled.

Parameters

[in]

signaled

True to signal, false to clear

Returns

AJA_STATUS_SUCCESS State set AJA_STATUS_FAIL State not set AJA_STATUS_OPEN Event not initialized

Definition at line 59 of file event.cpp.

Signal()

AJAStatus AJAEvent::Signal ( )

virtual

Set the event to the signaled state.

Returns

AJA_STATUS_SUCCESS Event signaled AJA_STATUS_FAIL Signal failed AJA_STATUS_OPEN Event not initialized

Definition at line 45 of file event.cpp.

WaitForSignal()

AJAStatus AJAEvent::WaitForSignal ( uint32_t  timeout = 0xffffffff )

virtual

Wait for the event to be signaled.

Parameters

[in]

timeout

Wait timeout in milliseconds.

Returns

AJA_STATUS_SUCCESS Event was signaled AJA_STATUS_TIMEOUT Event wait timeout AJA_STATUS_OPEN Event not initialized AJA_STATUS_FAIL Event error

Definition at line 87 of file event.cpp.

Friends And Related Function Documentation

AJAWaitForEvents

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

friend

Wait for a list of events to be signaled.

The wait can terminate when one or all of the events in the list is signaled.

Parameters

[in]	pList	An array of events (AJAEventPtr).
[in]	numEvents	Number of events in the event array.
[in]	all	true to wait for all events to be signaled.
[in]	timeout	Wait timeout in milliseconds (0xffffffff infinite).

Returns

AJA_STATUS_SUCCESS events signaled AJA_STATUS_TIMEOUT event wait timeout AJA_STATUS_OPEN event not initialized AJA_STATUS_RANGE numEvents out of range AJA_STATUS_FAIL event error

Definition at line 199 of file eventimpl.cpp.

---

The documentation for this class was generated from the following files:

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajabase/system/event.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajabase/system/event.cpp