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	isStreamJoinedEvent (const core::EventHolder &eventHolder)
static StreamJoinedEvent	extractStreamJoinedEvent (const core::EventHolder &eventHolder)
static bool	isStreamUnpublishedEvent (const core::EventHolder &eventHolder)
static StreamUnpublishedEvent	extractStreamUnpublishedEvent (const core::EventHolder &eventHolder)
static bool	isStreamLeftEvent (const core::EventHolder &eventHolder)
static StreamLeftEvent	extractStreamLeftEvent (const core::EventHolder &eventHolder)
static bool	isStreamNewStreamsEvent (const core::EventHolder &eventHolder)
static StreamNewStreamsEvent	extractStreamNewStreamsEvent (const core::EventHolder &eventHolder)
static bool	isStreamsUpdatedEvent (const core::EventHolder &eventHolder)
static StreamsUpdatedEvent	extractStreamsUpdatedEvent (const core::EventHolder &eventHolder)

Detailed Description

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

Member Function Documentation

extractStreamJoinedEvent()

StreamJoinedEvent privmx::endpoint::stream::Events::extractStreamJoinedEvent ( const core::EventHolder & eventHolder )

static

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

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamJoinedEvent' object

extractStreamLeftEvent()

StreamLeftEvent privmx::endpoint::stream::Events::extractStreamLeftEvent ( const core::EventHolder & eventHolder )

static

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

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamLeftEvent' object

extractStreamNewStreamsEvent()

StreamNewStreamsEvent privmx::endpoint::stream::Events::extractStreamNewStreamsEvent ( const core::EventHolder & eventHolder )

static

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

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamNewStreamsEvent' object

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

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

extractStreamsUpdatedEvent()

StreamsUpdatedEvent privmx::endpoint::stream::Events::extractStreamsUpdatedEvent ( const core::EventHolder & eventHolder )

static

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

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

'StreamsUpdatedEvent' 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

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

isStreamJoinedEvent()

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

static

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

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamJoinedEvent', else otherwise

isStreamLeftEvent()

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

static

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

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamLeftEvent', else otherwise

isStreamNewStreamsEvent()

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

static

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

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamNewStreamsEvent', else otherwise

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

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

isStreamsUpdatedEvent()

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

static

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

Parameters

eventHolder

holder object that wraps the 'Event'

Returns

true for 'StreamsUpdatedEvent', 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

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