Events | PrivMX Docs

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

Static Methods

isLibBreakEvent

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

Params

eventHolder

const EventHolder &

holder object that wraps the 'Event'

static bool isLibBreakEvent(
const EventHolder &eventHolder
)

Returns

bool · true for 'LibBreakEvent', else otherwise

extractLibBreakEvent

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

Params

eventHolder

const EventHolder &

holder object that wraps the 'Event'

static LibBreakEvent extractLibBreakEvent(
const EventHolder &eventHolder
)

Returns

LibBreakEvent · 'LibBreakEvent' object

isLibPlatformDisconnectedEvent

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

Params

eventHolder

const EventHolder &

holder object that wraps the 'Event'

static bool isLibPlatformDisconnectedEvent(
const EventHolder &eventHolder
)

Returns

bool · true for 'LibPlatformDisconnectedEvent', else otherwise

extractLibPlatformDisconnectedEvent

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

Params

eventHolder

const EventHolder &

holder object that wraps the 'Event'

static LibPlatformDisconnectedEvent extractLibPlatformDisconnectedEvent(
const EventHolder &eventHolder
)

Returns

LibPlatformDisconnectedEvent · 'LibPlatformDisconnectedEvent' object

isLibConnectedEvent

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

Params

eventHolder

const EventHolder &

holder object that wraps the 'Event'

static bool isLibConnectedEvent(
const EventHolder &eventHolder
)

Returns

bool · true for 'LibConnectedEvent', else otherwise

extractLibConnectedEvent

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

Params

eventHolder

const EventHolder &

holder object that wraps the 'Event'

static LibConnectedEvent extractLibConnectedEvent(
const EventHolder &eventHolder
)

Returns

LibConnectedEvent · 'LibConnectedEvent' object

isLibDisconnectedEvent

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

Params

eventHolder

const EventHolder &

holder object that wraps the 'Event'

static bool isLibDisconnectedEvent(
const EventHolder &eventHolder
)

Returns

bool · true for 'LibDisconnectedEvent', else otherwise

extractLibDisconnectedEvent

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

Params

eventHolder

const EventHolder &

holder object that wraps the 'Event'

static LibDisconnectedEvent extractLibDisconnectedEvent(
const EventHolder &eventHolder
)

Returns

LibDisconnectedEvent · 'LibDisconnectedEvent' object