Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::MESSAGING::ThreadMessage Class Reference

#include <ThreadMessage.h>

Public Member Functions

 ThreadMessage ()
 
 ThreadMessage (uint32_t messageId)
 
 ThreadMessage (uint32_t messageId, int64_t p3)
 
 ThreadMessage (uint32_t messageId, int p1, int p2, void *payload, int64_t p3=0)
 
 ThreadMessage (uint32_t messageId, int p1, int p2, void *payload, std::string param, std::vector< std::string > vecParams)
 
 ThreadMessage (const ThreadMessage &other)=default
 
 ThreadMessage (ThreadMessage &&other) noexcept
 
ThreadMessageoperator= (const ThreadMessage &other)
 
ThreadMessageoperator= (ThreadMessage &&other) noexcept
 
void SetResult (int res) const
 set the message return value, will only be returned when the message is sent using SendMsg
 

Public Attributes

uint32_t dwMessage
 
int param1
 
int param2
 
int64_t param3
 
voidlpVoid
 
std::string strParam
 
std::vector< std::string > params
 

Protected Attributes

std::shared_ptr< CEventwaitEvent
 
std::shared_ptr< intresult
 

Constructor & Destructor Documentation

◆ ThreadMessage() [1/7]

KODI::MESSAGING::ThreadMessage::ThreadMessage ( )
inline

◆ ThreadMessage() [2/7]

KODI::MESSAGING::ThreadMessage::ThreadMessage ( uint32_t messageId)
inlineexplicit

◆ ThreadMessage() [3/7]

KODI::MESSAGING::ThreadMessage::ThreadMessage ( uint32_t messageId,
int64_t p3 )
inline

◆ ThreadMessage() [4/7]

KODI::MESSAGING::ThreadMessage::ThreadMessage ( uint32_t messageId,
int p1,
int p2,
void * payload,
int64_t p3 = 0 )
inline

◆ ThreadMessage() [5/7]

KODI::MESSAGING::ThreadMessage::ThreadMessage ( uint32_t messageId,
int p1,
int p2,
void * payload,
std::string param,
std::vector< std::string > vecParams )
inline

◆ ThreadMessage() [6/7]

KODI::MESSAGING::ThreadMessage::ThreadMessage ( const ThreadMessage & other)
default

◆ ThreadMessage() [7/7]

KODI::MESSAGING::ThreadMessage::ThreadMessage ( ThreadMessage && other)
inlinenoexcept

Member Function Documentation

◆ operator=() [1/2]

ThreadMessage & KODI::MESSAGING::ThreadMessage::operator= ( const ThreadMessage & other)
inline

◆ operator=() [2/2]

ThreadMessage & KODI::MESSAGING::ThreadMessage::operator= ( ThreadMessage && other)
inlinenoexcept

◆ SetResult()

void KODI::MESSAGING::ThreadMessage::SetResult ( int res) const
inline

set the message return value, will only be returned when the message is sent using SendMsg

Parameters
[in]resthe return value or a result status code that is returned to the caller

Member Data Documentation

◆ dwMessage

uint32_t KODI::MESSAGING::ThreadMessage::dwMessage

◆ lpVoid

void* KODI::MESSAGING::ThreadMessage::lpVoid

◆ param1

int KODI::MESSAGING::ThreadMessage::param1

◆ param2

int KODI::MESSAGING::ThreadMessage::param2

◆ param3

int64_t KODI::MESSAGING::ThreadMessage::param3

◆ params

std::vector<std::string> KODI::MESSAGING::ThreadMessage::params

◆ result

std::shared_ptr<int> KODI::MESSAGING::ThreadMessage::result
protected

◆ strParam

std::string KODI::MESSAGING::ThreadMessage::strParam

◆ waitEvent

std::shared_ptr<CEvent> KODI::MESSAGING::ThreadMessage::waitEvent
protected

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