winss::EventWrapper Class Reference

Wraps a windows event. More...

#include <event_wrapper.hpp>

Public Member Functions
	EventWrapper ()
	Creates the event wrapper. More...
	EventWrapper (const EventWrapper &e)=default
	Copies the event wrapper. More...
	EventWrapper (EventWrapper &&e)=default
	Move the event wrapper. More...
bool	IsSet () const
	Gets if the event is set or not. More...
winss::HandleWrapper	GetHandle () const
	Gets a handle to the event. More...
bool	Set ()
	Trigger the event. More...
bool	Reset ()
	Resets the event. More...
EventWrapper &	operator= (const EventWrapper &e)=default
	Copies the event wrapper. More...
EventWrapper &	operator= (EventWrapper &&e)=default
	Move the event wrapper. More...

Detailed Description

Wraps a windows event.

Constructor & Destructor Documentation

winss::EventWrapper::EventWrapper

(

)

Creates the event wrapper.

winss::EventWrapper::EventWrapper ( const EventWrapper &  e )

default

Copies the event wrapper.

Any ownership rights will not be copied.

Parameters

e	The event wrapper to copy.

winss::EventWrapper::EventWrapper ( EventWrapper &&  e )

default

Move the event wrapper.

Any ownership rights will be moved

Parameters

e	The event wrapper to move.

Member Function Documentation

winss::HandleWrapper winss::EventWrapper::GetHandle

(

)

const

Gets a handle to the event.

Returns

The handle as a handle wrapper.

See also

HandleWrapper

References winss::TrustedHandleWrapper::GetHandleWrapper().

Referenced by winss::WaitMultiplexer::AddCloseEvent(), winss::SvScanTmpl< TService, TMutex, TProcess >::SvScanTmpl(), and winss::SvScanTmpl< TService, TMutex, TProcess >::Terminate().

bool winss::EventWrapper::IsSet

(

)

const

Gets if the event is set or not.

Returns

True if the event has been set otherwise false.

References winss::TrustedHandleWrapper::GetHandle(), and WINDOWS.

EventWrapper& winss::EventWrapper::operator= ( const EventWrapper &  e )

default

Copies the event wrapper.

Any ownership rights will not be copied.

Parameters

e	The event wrapper to copy.

Returns

This event wrapper.

EventWrapper& winss::EventWrapper::operator= ( EventWrapper &&  e )

default

Move the event wrapper.

Any ownership rights will be moved

Parameters

e	The event wrapper to move.

Returns

This event wrapper.

bool winss::EventWrapper::Reset

(

)

Resets the event.

Returns

True if the reset event succeeded.

References winss::TrustedHandleWrapper::GetHandle(), and WINDOWS.

Referenced by winss::SvScanTmpl< TService, TMutex, TProcess >::Terminate().

bool winss::EventWrapper::Set

(

)

Trigger the event.

Returns

True if the set event succeeded.

References winss::TrustedHandleWrapper::GetHandle(), and WINDOWS.

Referenced by winss::CtrlHandler().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/latest/lib/winss/event_wrapper.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/latest/lib/winss/event_wrapper.cpp