DelegateMQ
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ThreadMsg Class Reference

A class to hold a platform-specific thread messsage that will be passed through the OS message queue.
More...

#include <ThreadMsg.h>

Public Member Functions

 ThreadMsg (int id, std::shared_ptr< dmq::DelegateMsg > data)
 
int GetId () const
 
std::shared_ptr< dmq::DelegateMsg > GetData ()
 
 ThreadMsg (int id, std::shared_ptr< dmq::DelegateMsg > data)
 
int GetId () const
 
std::shared_ptr< dmq::DelegateMsg > GetData () const
 
dmq::Priority GetPriority () const
 

Detailed Description

A class to hold a platform-specific thread messsage that will be passed through the OS message queue.

Constructor & Destructor Documentation

◆ ThreadMsg() [1/2]

ThreadMsg::ThreadMsg ( int id,
std::shared_ptr< dmq::DelegateMsg > data )
inline

Constructor

Parameters
[in]id- a unique identifier for the thread messsage
[in]data- a pointer to the messsage data to be typecast by the receiving task based on the id value.
Precondition
The data pointer argument must be created on the heap.
Postcondition
The destination thread will delete the heap allocated data once the callback is complete.

◆ ThreadMsg() [2/2]

ThreadMsg::ThreadMsg ( int id,
std::shared_ptr< dmq::DelegateMsg > data )
inline

Constructor

Parameters
[in]id- a unique identifier for the thread messsage
[in]data- a pointer to the messsage data to be typecast by the receiving task based on the id value.
Precondition
The data pointer argument must be created on the heap.
Postcondition
The destination thread will delete the heap allocated data once the callback is complete.

Member Function Documentation

◆ GetData() [1/2]

std::shared_ptr< dmq::DelegateMsg > ThreadMsg::GetData ( )
inline

◆ GetData() [2/2]

std::shared_ptr< dmq::DelegateMsg > ThreadMsg::GetData ( ) const
inline

◆ GetId() [1/2]

int ThreadMsg::GetId ( ) const
inline

◆ GetId() [2/2]

int ThreadMsg::GetId ( ) const
inline

◆ GetPriority()

dmq::Priority ThreadMsg::GetPriority ( ) const
inline
The documentation for this class was generated from the following files: