Message
in package
Describes an action which is supposed to be performed after receiving a message.
Objects of this type are used by the MessageProcessor to instruct the MqttClient about required steps to take.
Table of Contents
- $acknowledgedQualityOfServices : array<string|int, mixed>
- $content : string|null
- $messageId : int|null
- $qualityOfService : int
- $topic : string|null
- $type : MessageType
- __construct() : mixed
- Message constructor.
- getAcknowledgedQualityOfServices() : array<string|int, int>
- getContent() : string|null
- getMessageId() : int|null
- getQualityOfService() : int
- getTopic() : string|null
- getType() : MessageType
- setAcknowledgedQualityOfServices() : Message
- setContent() : Message
- setMessageId() : Message
- setTopic() : Message
Properties
$acknowledgedQualityOfServices
private
array<string|int, mixed>
$acknowledgedQualityOfServices
= []
$content
private
string|null
$content
= null
$messageId
private
int|null
$messageId
= null
$qualityOfService
private
int
$qualityOfService
$topic
private
string|null
$topic
= null
$type
private
MessageType
$type
Methods
__construct()
Message constructor.
public
__construct(MessageType $type, int $qualityOfService) : mixed
Parameters
- $type : MessageType
- $qualityOfService : int
Return values
mixed —getAcknowledgedQualityOfServices()
public
getAcknowledgedQualityOfServices() : array<string|int, int>
Return values
array<string|int, int> —getContent()
public
getContent() : string|null
Return values
string|null —getMessageId()
public
getMessageId() : int|null
Return values
int|null —getQualityOfService()
public
getQualityOfService() : int
Return values
int —getTopic()
public
getTopic() : string|null
Return values
string|null —getType()
public
getType() : MessageType
Return values
MessageType —setAcknowledgedQualityOfServices()
public
setAcknowledgedQualityOfServices(array<string|int, int> $acknowledgedQualityOfServices) : Message
Parameters
- $acknowledgedQualityOfServices : array<string|int, int>
Return values
Message —setContent()
public
setContent(string|null $content) : Message
Parameters
- $content : string|null
Return values
Message —setMessageId()
public
setMessageId(int|null $messageId) : Message
Parameters
- $messageId : int|null
Return values
Message —setTopic()
public
setTopic(string|null $topic) : Message
Parameters
- $topic : string|null