An event message that is to be sent to a thread. More...

#include <etevent.h>

Inheritance diagram for EThreadMessage:

Public Member Functions
	EThreadMessage ()
	Default class constructor. More...

	EThreadMessage (UInt msgid)
	Class constructor. More...

	EThreadMessage (UInt msgid, EThreadEventMessageData &data)
	Class constructor. More...

	EThreadMessage (UInt msgid, pVoid v)
	Class constructor. More...

	EThreadMessage (UInt msgid, LongLong v)
	Class constructor. More...

	EThreadMessage (UInt msgid, ULongLong v)
	Class constructor. More...

	EThreadMessage (UInt msgid, Long v1, Long v2=0)
	Class constructor. More...

	EThreadMessage (UInt msgid, ULong v1, ULong v2=0)
	Class constructor. More...

	EThreadMessage (UInt msgid, Short v1, Short v2=0, Short v3=0, Short v4=0)
	Class constructor. More...

	EThreadMessage (UInt msgid, UShort v1, UShort v2=0, UShort v3=0, UShort v4=0)
	Class constructor. More...

	EThreadMessage (UInt msgid, Char v1, Char v2=0, Char v3=0, Char v4=0, Char v5=0, Char v6=0, Char v7=0, Char v8=0)
	Class constructor. More...

	EThreadMessage (UInt msgid, UChar v1, UChar v2=0, UChar v3=0, UChar v4=0, UChar v5=0, UChar v6=0, UChar v7=0, UChar v8=0)
	Class constructor. More...

	EThreadMessage ()
	Default constructor. More...

	EThreadMessage (UInt msgid)
	Class constructor. More...

	EThreadMessage (UInt msgid, Dword lowPart, Long highPart)
	Class constructor. More...

	EThreadMessage (UInt msgid, pVoid voidPtr)
	Class constructor. More...

	EThreadMessage (UInt msgid, LongLong quadPart)
	Class constructor. More...

	EThreadMessage (const EThreadMessage &msg)
	Copy constructor. More...

	~EThreadMessage ()
	Class destructor. More...

EThreadMessage &	operator= (const EThreadMessage &val)
	Assignment operator. More...

Void	set (UInt msgid)
	Assigns values to this message object. More...

Void	set (UInt msgid, Dword lowPart, Long highPart)
	Assigns values to this message object. More...

Void	set (UInt msgid, pVoid voidPtr)
	Assigns values to this message object. More...

Void	set (UInt msgid, LongLong quadPart)
	Assigns values to this message object. More...

ETimer &	getTimer ()
	Retrieves the ETimer object associated with this event. More...

UInt &	getMsgId ()
	Retrieves the message ID associated with this message. More...

Dword &	getLowPart ()
	Retrieves the unsigned 32-bit value associated with this message. More...

Long &	getHighPart ()
	Retrieves the signed 32-bit value associated with this message. More...

LongLong &	getQuadPart ()
	Retrieves the signed 64-bit value associated with this message. More...

pVoid &	getVoidPtr ()
	Retrieves the void pointer value associated with this message. More...

Public Member Functions inherited from EThreadEventMessageBase< T >
	EThreadEventMessageBase ()
	Default constructor. More...

	EThreadEventMessageBase (const T &data)
	Copy constructor. More...

virtual	~EThreadEventMessageBase ()
	Class destructor. More...

T &	operator= (const T &data)
	Assignment operator. More...

T &	data ()
	Retrieves the data portion of the message. More...

UInt	getMessageId ()
	Retrieves the event message ID associated with this event message. More...

EThreadEventMessageBase &	setMessageId (UInt msgid)
	Sets the event message ID for this event message. More...

pVoid	getVoidPtr ()
	Retrieves the void pointer from the data portion of this event message. More...

Void	setVoidPtr (pVoid p)
	Sets the void pointer for this event message. More...

ETimer &	getTimer ()
	Retrieves the timer associated with this event message. More...

Public Member Functions inherited from _EThreadEventMessageBase
virtual	~_EThreadEventMessageBase ()
	Virtual class destructor. More...

Friends
class	EThreadQueueBase

Detailed Description

An event message that is to be sent to a thread.

Represents an event message to be sent to a thread.

This thread message contains a union that interprets 8 bytes in various ways.

Constructor & Destructor Documentation

◆ EThreadMessage() [1/18]

EThreadMessage::EThreadMessage ( )

inline

Default class constructor.

◆ EThreadMessage() [2/18]

EThreadMessage::EThreadMessage ( UInt msgid )

inline

Class constructor.

Parameters

msgid the event message id.

◆ EThreadMessage() [3/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		EThreadEventMessageData &	data
	)

inline

Class constructor.

Parameters

msgid	the event message id.
data	a data object to include in the message (contains the union definition).

◆ EThreadMessage() [4/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		pVoid	v
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v	a void pointer to include in the event message.

◆ EThreadMessage() [5/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		LongLong	v
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v	a 64-bit signed integer to include in the event message.

◆ EThreadMessage() [6/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		ULongLong	v
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v	a 64-bit unsigned integer to include in the event message.

◆ EThreadMessage() [7/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		Long	v1,
		Long	v2 = `0`
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v1	the first 32-bit signed integer to include in the event message.
v2	the second 32-bit signed integer to include in the event message.

◆ EThreadMessage() [8/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		ULong	v1,
		ULong	v2 = `0`
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v1	the first 32-bit unsigned integer to include in the event message.
v2	the second 32-bit unsigned integer to include in the event message.

◆ EThreadMessage() [9/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		Short	v1,
		Short	v2 = `0`,
		Short	v3 = `0`,
		Short	v4 = `0`
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v1	the first 16-bit signed integer to include in the event message.
v2	the second 16-bit signed integer to include in the event message.
v3	the third 16-bit signed integer to include in the event message.
v4	the fourth 16-bit signed integer to include in the event message.

◆ EThreadMessage() [10/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		UShort	v1,
		UShort	v2 = `0`,
		UShort	v3 = `0`,
		UShort	v4 = `0`
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v1	the first 16-bit unsigned integer to include in the event message.
v2	the second 16-bit unsigned integer to include in the event message.
v3	the third 16-bit unsigned integer to include in the event message.
v4	the fourth 16-bit unsigned integer to include in the event message.

◆ EThreadMessage() [11/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		Char	v1,
		Char	v2 = `0`,
		Char	v3 = `0`,
		Char	v4 = `0`,
		Char	v5 = `0`,
		Char	v6 = `0`,
		Char	v7 = `0`,
		Char	v8 = `0`
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v1	the first 8-bit signed integer to include in the event message.
v2	the second 8-bit signed integer to include in the event message.
v3	the third 8-bit signed integer to include in the event message.
v4	the fourth 8-bit signed integer to include in the event message.
v5	the fifth 8-bit signed integer to include in the event message.
v6	the sixth 8-bit signed integer to include in the event message.
v7	the seventh 8-bit signed integer to include in the event message.
v8	the eighth 8-bit signed integer to include in the event message.

◆ EThreadMessage() [12/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		UChar	v1,
		UChar	v2 = `0`,
		UChar	v3 = `0`,
		UChar	v4 = `0`,
		UChar	v5 = `0`,
		UChar	v6 = `0`,
		UChar	v7 = `0`,
		UChar	v8 = `0`
	)

inline

Class constructor.

Parameters

msgid	the event message id.
v1	the first 8-bit unsigned integer to include in the event message.
v2	the second 8-bit unsigned integer to include in the event message.
v3	the third 8-bit unsigned integer to include in the event message.
v4	the fourth 8-bit unsigned integer to include in the event message.
v5	the fifth 8-bit unsigned integer to include in the event message.
v6	the sixth 8-bit unsigned integer to include in the event message.
v7	the seventh 8-bit unsigned integer to include in the event message.
v8	the eighth 8-bit unsigned integer to include in the event message.

◆ EThreadMessage() [13/18]

EThreadMessage::EThreadMessage ( )

inline

Default constructor.

◆ EThreadMessage() [14/18]

EThreadMessage::EThreadMessage ( UInt msgid )

inline

Class constructor.

Parameters

msgid the event/message ID.

◆ EThreadMessage() [15/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		Dword	lowPart,
		Long	highPart
	)

inline

Class constructor.

Parameters

msgid	the event/message ID.
lowPart	an unsigned 32-bit value to be included with the message.
highPart	a signed 32-bit value to be included with the message.

◆ EThreadMessage() [16/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		pVoid	voidPtr
	)

inline

Class constructor.

Parameters

msgid	the event/message ID.
voidPtr	a void pointer to be included with the message.

◆ EThreadMessage() [17/18]

EThreadMessage::EThreadMessage	(	UInt	msgid,
		LongLong	quadPart
	)

inline

Class constructor.

Parameters

msgid	the event/message ID.
quadPart	a signed 64-bit value to be included with the message.

◆ EThreadMessage() [18/18]

EThreadMessage::EThreadMessage ( const EThreadMessage & msg )

inline

Copy constructor.

Parameters

msg	the EThreadMessage to copy.

◆ ~EThreadMessage()

EThreadMessage::~EThreadMessage ( )

inline

Class destructor.

Member Function Documentation

◆ getHighPart()

Long& EThreadMessage::getHighPart ( )

inline

Retrieves the signed 32-bit value associated with this message.

Returns: the signed 32-bit value associated with this message.

◆ getLowPart()

Dword& EThreadMessage::getLowPart ( )

inline

Retrieves the unsigned 32-bit value associated with this message.

Returns: the unsigned 32-bit value associated with this message.

◆ getMsgId()

UInt& EThreadMessage::getMsgId ( )

inline

Retrieves the message ID associated with this message.

Returns: the message ID associated with this message.

◆ getQuadPart()

LongLong& EThreadMessage::getQuadPart ( )

inline

Retrieves the signed 64-bit value associated with this message.

Returns: the signed 64-bit value associated with this message.

◆ getTimer()

ETimer& EThreadMessage::getTimer ( )

inline

Retrieves the ETimer object associated with this event.

Returns: the ETimer object associated with this event.

◆ getVoidPtr()

pVoid& EThreadMessage::getVoidPtr ( )

inline

Retrieves the void pointer value associated with this message.

Returns: the signed void pointer value associated with this message.

◆ operator=()

EThreadMessage& EThreadMessage::operator= ( const EThreadMessage & val )

inline

Assignment operator.

Parameters

val	the value to copy.

Returns: a reference to this object.

◆ set() [1/4]

Void EThreadMessage::set ( UInt msgid )

inline

Assigns values to this message object.

Parameters

msgid the message ID.

◆ set() [2/4]

Void EThreadMessage::set	(	UInt	msgid,
		Dword	lowPart,
		Long	highPart
	)

inline

Assigns values to this message object.

Parameters

msgid	the message ID.
lowPart	an unsigned 32-bit value to be included with the message.
highPart	a signed 32-bit value to be included with the message.

◆ set() [3/4]

Void EThreadMessage::set	(	UInt	msgid,
		LongLong	quadPart
	)

inline

Assigns values to this message object.

Parameters

msgid	the message ID.
quadPart	a signed 64-bit value to be included with the message.

◆ set() [4/4]

Void EThreadMessage::set	(	UInt	msgid,
		pVoid	voidPtr
	)

inline

Assigns values to this message object.

Parameters

msgid	the message ID.
voidPtr	a void pointer to be included with the message.

Friends And Related Function Documentation

◆ EThreadQueueBase

friend class EThreadQueueBase

friend

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

/home/vagrant/share/code/epctools/include/epc/etevent.h
/home/vagrant/share/code/epctools/include/epc/etq.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ EThreadMessage() [1/18]

◆ EThreadMessage() [2/18]

◆ EThreadMessage() [3/18]

◆ EThreadMessage() [4/18]

◆ EThreadMessage() [5/18]

◆ EThreadMessage() [6/18]

◆ EThreadMessage() [7/18]

◆ EThreadMessage() [8/18]

◆ EThreadMessage() [9/18]

◆ EThreadMessage() [10/18]

◆ EThreadMessage() [11/18]

◆ EThreadMessage() [12/18]

◆ EThreadMessage() [13/18]

◆ EThreadMessage() [14/18]

◆ EThreadMessage() [15/18]

◆ EThreadMessage() [16/18]

◆ EThreadMessage() [17/18]

◆ EThreadMessage() [18/18]

◆ ~EThreadMessage()

Member Function Documentation

◆ getHighPart()

◆ getLowPart()

◆ getMsgId()

◆ getQuadPart()

◆ getTimer()

◆ getVoidPtr()

◆ operator=()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

Friends And Related Function Documentation

◆ EThreadQueueBase