Events
namespace: privmx::endpoint::core
Events provides the helpers methods for module's events management.
Static Methods
isLibBreakEvent
Checks whether event held in the EventHolder is an LibBreakEvent
static bool isLibBreakEvent(
const EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const EventHolder & | holder object that wraps the Event |
| Type | Description |
|---|---|
bool | true for LibBreakEvent else otherwise |
extractLibBreakEvent
Gets Event held in the EventHolder as an LibBreakEvent
static LibBreakEvent extractLibBreakEvent(
const EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const EventHolder & | holder object that wraps the Event |
| Type | Description |
|---|---|
LibBreakEvent | LibBreakEvent object |
isLibPlatformDisconnectedEvent
Checks whether event held in the EventHolder is an LibPlatformDisconnectedEvent
static bool isLibPlatformDisconnectedEvent(
const EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const EventHolder & | holder object that wraps the Event |
| Type | Description |
|---|---|
bool | true for LibPlatformDisconnectedEvent else otherwise |
extractLibPlatformDisconnectedEvent
Gets Event held in the EventHolder as an LibPlatformDisconnectedEvent
static LibPlatformDisconnectedEvent extractLibPlatformDisconnectedEvent(
const EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const EventHolder & | holder object that wraps the Event |
| Type | Description |
|---|---|
LibPlatformDisconnectedEvent | LibPlatformDisconnectedEvent object |
isLibConnectedEvent
Checks whether event held in the EventHolder is an LibConnectedEvent
static bool isLibConnectedEvent(
const EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const EventHolder & | holder object that wraps the Event |
| Type | Description |
|---|---|
bool | true for LibConnectedEvent else otherwise |
extractLibConnectedEvent
Gets Event held in the EventHolder as an LibConnectedEvent
static LibConnectedEvent extractLibConnectedEvent(
const EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const EventHolder & | holder object that wraps the Event |
| Type | Description |
|---|---|
LibConnectedEvent | LibConnectedEvent object |
isLibDisconnectedEvent
Checks whether event held in the EventHolder is an LibDisconnectedEvent
static bool isLibDisconnectedEvent(
const EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const EventHolder & | holder object that wraps the Event |
| Type | Description |
|---|---|
bool | true for LibDisconnectedEvent else otherwise |
extractLibDisconnectedEvent
Gets Event held in the EventHolder as an LibDisconnectedEvent
static LibDisconnectedEvent extractLibDisconnectedEvent(
const EventHolder &eventHolder
)
| Name | Type | Description |
|---|---|---|
| eventHolder | const EventHolder & | holder object that wraps the Event |
| Type | Description |
|---|---|
LibDisconnectedEvent | LibDisconnectedEvent object |