JAUS::ReportTimeout Class Reference

This message is used to report the timeout period of the service. More...

#include <reporttimeout.h>

Inheritance diagram for JAUS::ReportTimeout:

List of all members.

Public Member Functions
	ReportTimeout (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	ReportTimeout (const ReportTimeout &message)
	Copy constructor.
	~ReportTimeout ()
	Destructor.
void	SetTimeoutSeconds (const Byte seconds)
Byte	GetTimeoutSeconds () const
virtual bool	IsCommand () const
virtual int	WriteMessageBody (Packet &packet) const
	Writes message payload to the packet.
virtual int	ReadMessageBody (const Packet &packet)
	Reads message payload from the packet.
virtual Message *	Clone () const
virtual UInt	GetPresenceVector () const
virtual UInt	GetPresenceVectorSize () const
virtual UInt	GetPresenceVectorMask () const
virtual UShort	GetMessageCodeOfResponse () const
virtual std::string	GetMessageName () const
virtual void	ClearMessageBody ()
	Clears message payload data.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize=1437) const
virtual int	RunTestCase () const
	Runs a test case to validate the message class.
ReportTimeout &	operator= (const ReportTimeout &message)
	Sets equal to.
Protected Attributes
Byte	mTimeoutSeconds
	Timeout value in seconds, clients must re-request control to prevent being rejected. 0 indicates disabled.

---

Detailed Description

This message is used to report the timeout period of the service.

Definition at line 54 of file reporttimeout.h.

---

Constructor & Destructor Documentation

ReportTimeout::ReportTimeout	(	const Address &	dest = Address(),
		const Address &	src = Address()
	)

Constructor, initializes default values.

Parameters:

[in]	src	Source ID of message sender.
[in]	dest	Destination ID of message.

Definition at line 53 of file reporttimeout.cpp.

ReportTimeout::ReportTimeout

(

const ReportTimeout &

message )

Copy constructor.

Definition at line 64 of file reporttimeout.cpp.

ReportTimeout::~ReportTimeout

(

)

Destructor.

Definition at line 75 of file reporttimeout.cpp.

---

Member Function Documentation

void ReportTimeout::ClearMessageBody

(

)

[virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 129 of file reporttimeout.cpp.

virtual Message* JAUS::ReportTimeout::Clone

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 65 of file reporttimeout.h.

virtual UShort JAUS::ReportTimeout::GetMessageCodeOfResponse

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 69 of file reporttimeout.h.

virtual std::string JAUS::ReportTimeout::GetMessageName

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 70 of file reporttimeout.h.

virtual UInt JAUS::ReportTimeout::GetPresenceVector

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 66 of file reporttimeout.h.

virtual UInt JAUS::ReportTimeout::GetPresenceVectorMask

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 68 of file reporttimeout.h.

virtual UInt JAUS::ReportTimeout::GetPresenceVectorSize

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 67 of file reporttimeout.h.

Byte JAUS::ReportTimeout::GetTimeoutSeconds

(

)

const [inline]

Definition at line 61 of file reporttimeout.h.

virtual bool JAUS::ReportTimeout::IsCommand

(

)

const [inline, virtual]

Implements JAUS::Message.

Definition at line 62 of file reporttimeout.h.

virtual bool JAUS::ReportTimeout::IsLargeDataSet

(

const unsigned int

maxPayloadSize = 1437 )

const [inline, virtual]

Implements JAUS::Message.

Definition at line 72 of file reporttimeout.h.

ReportTimeout & ReportTimeout::operator=

(

const ReportTimeout &

message )

Sets equal to.

Definition at line 166 of file reporttimeout.cpp.

int ReportTimeout::ReadMessageBody

(

const Packet &

packet )

[virtual]

Reads message payload from the packet.

Message contents are read from the packet following the JAUS standard.

Parameters:

[in]

packet

Packet containing message payload data to read.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 113 of file reporttimeout.cpp.

int ReportTimeout::RunTestCase

(

)

const [virtual]

Runs a test case to validate the message class.

Returns:

1 on success, otherwise 0.

Reimplemented from JAUS::Message.

Definition at line 142 of file reporttimeout.cpp.

void JAUS::ReportTimeout::SetTimeoutSeconds

(

const Byte

seconds )

[inline]

Definition at line 60 of file reporttimeout.h.

int ReportTimeout::WriteMessageBody

(

Packet &

packet )

const [virtual]

Writes message payload to the packet.

Message contents are written to the packet following the JAUS standard.

Parameters:

[out]

packet

Packet to write payload to.

Returns:

-1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 91 of file reporttimeout.cpp.

---

Member Data Documentation

Byte JAUS::ReportTimeout::mTimeoutSeconds [protected]

Timeout value in seconds, clients must re-request control to prevent being rejected. 0 indicates disabled.

Definition at line 76 of file reporttimeout.h.

---

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

• jaus++/2.0/include/jaus/core/control/reporttimeout.h
• jaus++/2.0/src/jaus/core/control/reporttimeout.cpp