privmx::endpoint::stream::Events Class Reference

#include <privmx/endpoint/stream/Events.hpp>

Static Public Member Functions
static bool	isStreamRoomCreatedEvent (const core::EventHolder &eventHolder)
static StreamRoomCreatedEvent	extractStreamRoomCreatedEvent (const core::EventHolder &eventHolder)
static bool	isStreamRoomUpdatedEvent (const core::EventHolder &eventHolder)
static StreamRoomUpdatedEvent	extractStreamRoomUpdatedEvent (const core::EventHolder &eventHolder)
static bool	isStreamRoomDeletedEvent (const core::EventHolder &eventHolder)
static StreamRoomDeletedEvent	extractStreamRoomDeletedEvent (const core::EventHolder &eventHolder)
static bool	isStreamPublishedEvent (const core::EventHolder &eventHolder)
static StreamPublishedEvent	extractStreamPublishedEvent (const core::EventHolder &eventHolder)
static bool	isStreamUpdatedEvent (const core::EventHolder &eventHolder)
static StreamUpdatedEvent	extractStreamUpdatedEvent (const core::EventHolder &eventHolder)
static bool	isStreamRoomJoinedEvent (const core::EventHolder &eventHolder)
static StreamRoomJoinedEvent	extractStreamRoomJoinedEvent (const core::EventHolder &eventHolder)
static bool	isStreamUnpublishedEvent (const core::EventHolder &eventHolder)
static StreamUnpublishedEvent	extractStreamUnpublishedEvent (const core::EventHolder &eventHolder)
static bool	isStreamRoomLeftEvent (const core::EventHolder &eventHolder)
static StreamRoomLeftEvent	extractStreamRoomLeftEvent (const core::EventHolder &eventHolder)
static bool	isStreamSubscribedEvent (const core::EventHolder &eventHolder)
static StreamSubscribedEvent	extractStreamSubscribedEvent (const core::EventHolder &eventHolder)
static bool	isStreamUnsubscribedEvent (const core::EventHolder &eventHolder)
static StreamUnsubscribedEvent	extractStreamUnsubscribedEvent (const core::EventHolder &eventHolder)

Detailed Description

'Events' provides the helpers methods for module's events management.

Member Function Documentation

extractStreamPublishedEvent()

StreamPublishedEvent privmx::endpoint::stream::Events::extractStreamPublishedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'StreamPublishedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamPublishedEvent' object

extractStreamRoomCreatedEvent()

StreamRoomCreatedEvent privmx::endpoint::stream::Events::extractStreamRoomCreatedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'StreamRoomCreatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamRoomCreatedEvent' object

extractStreamRoomDeletedEvent()

StreamRoomDeletedEvent privmx::endpoint::stream::Events::extractStreamRoomDeletedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'StreamRoomDeletedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamRoomDeletedEvent' object

extractStreamRoomJoinedEvent()

StreamRoomJoinedEvent privmx::endpoint::stream::Events::extractStreamRoomJoinedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as a 'StreamRoomJoinedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamRoomJoinedEvent' object

extractStreamRoomLeftEvent()

StreamRoomLeftEvent privmx::endpoint::stream::Events::extractStreamRoomLeftEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as a 'StreamRoomLeftEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamRoomLeftEvent' object

extractStreamRoomUpdatedEvent()

StreamRoomUpdatedEvent privmx::endpoint::stream::Events::extractStreamRoomUpdatedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'StreamRoomUpdatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamRoomUpdatedEvent' object

extractStreamSubscribedEvent()

StreamSubscribedEvent privmx::endpoint::stream::Events::extractStreamSubscribedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as a 'StreamSubscribedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamSubscribedEvent' object

extractStreamUnpublishedEvent()

StreamUnpublishedEvent privmx::endpoint::stream::Events::extractStreamUnpublishedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'StreamUnpublishedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamUnpublishedEvent' object

extractStreamUnsubscribedEvent()

StreamUnsubscribedEvent privmx::endpoint::stream::Events::extractStreamUnsubscribedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as a 'StreamUnsubscribedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamUnsubscribedEvent' object

extractStreamUpdatedEvent()

StreamUpdatedEvent privmx::endpoint::stream::Events::extractStreamUpdatedEvent ( const core::EventHolder & eventHolder )

static

Gets Event held in the 'EventHolder' as an 'StreamUpdatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamUpdatedEvent' object

isStreamPublishedEvent()

bool privmx::endpoint::stream::Events::isStreamPublishedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'StreamPublishedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamPublishedEvent', else otherwise

isStreamRoomCreatedEvent()

bool privmx::endpoint::stream::Events::isStreamRoomCreatedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'StreamRoomCreatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamRoomCreatedEvent', else otherwise

isStreamRoomDeletedEvent()

bool privmx::endpoint::stream::Events::isStreamRoomDeletedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'StreamRoomDeletedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamRoomDeletedEvent', else otherwise

isStreamRoomJoinedEvent()

bool privmx::endpoint::stream::Events::isStreamRoomJoinedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is a 'StreamRoomJoinedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamRoomJoinedEvent', else otherwise

isStreamRoomLeftEvent()

bool privmx::endpoint::stream::Events::isStreamRoomLeftEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is a 'StreamRoomLeftEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamRoomLeftEvent', else otherwise

isStreamRoomUpdatedEvent()

bool privmx::endpoint::stream::Events::isStreamRoomUpdatedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'StreamRoomUpdatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamRoomUpdatedEvent', else otherwise

isStreamSubscribedEvent()

bool privmx::endpoint::stream::Events::isStreamSubscribedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is a 'StreamSubscribedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamSubscribedEvent', else otherwise

isStreamUnpublishedEvent()

bool privmx::endpoint::stream::Events::isStreamUnpublishedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'StreamUnpublishedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamUnpublishedEvent', else otherwise

isStreamUnsubscribedEvent()

bool privmx::endpoint::stream::Events::isStreamUnsubscribedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is a 'StreamUnsubscribedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamUnsubscribedEvent', else otherwise

isStreamUpdatedEvent()

bool privmx::endpoint::stream::Events::isStreamUpdatedEvent ( const core::EventHolder & eventHolder )

static

Checks whether event held in the 'EventHolder' is an 'StreamUpdatedEvent'

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamUpdatedEvent', else otherwise

---

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

• privmx/endpoint/stream/Events.hpp