MQTT — API

Workerman\Mqtt\Client

function __construct($address, array $options = array())

function connect()

function subscribe($topic, array $options = array(), $callback = null, $properties = [])

function unsubscribe($topic, $callback = null, array $properties = [])

function publish($topic, $content, $options = array(), $callback = null, $properties = [])

function disconnect(int $code = ReasonCodeConst::NORMAL_DISCONNECTION, array $properties = [])

function auth(int $code = ReasonCodeConst::SUCCESS, array $properties = [])

function close()

function reconnect($after = 0)

function onConnectionConnect()

function onMqttReconnect()

function onConnectionMessage($connection, $data)

function onConnectionClose()

function onConnectionError($connection, $code)

function onConnectionBufferFull()

function checkConnectTimeout()

const STATE_INITIAL

const STATE_CONNECTING

const STATE_WAITCONACK

const STATE_ESTABLISHED

const STATE_DISCONNECT

const DEFAULT_CLIENT_ID_PREFIX

const MAX_TOPIC_LENGTH

Workerman\Mqtt\Consts\MQTTConst

src/Consts/MQTTConst.php

const MQTT_PROTOCOL_LEVEL_3_1

const MQTT_PROTOCOL_LEVEL_3_1_1

const MQTT_PROTOCOL_LEVEL_5_0

const MQISDP_PROTOCOL_NAME

const MQTT_PROTOCOL_NAME

const MQTT_QOS_0

const MQTT_QOS_1

const MQTT_QOS_2

const MQTT_RETAIN_0

const MQTT_RETAIN_1

const MQTT_RETAIN_2

const MQTT_DUP_0

const MQTT_DUP_1

const MQTT_SESSION_PRESENT_0

const MQTT_SESSION_PRESENT_1

const CMD_CONNECT

const CMD_CONNACK

const CMD_PUBLISH

const CMD_PUBACK

const CMD_PUBREC

const CMD_PUBREL

const CMD_PUBCOMP

const CMD_SUBSCRIBE

const CMD_SUBACK

const CMD_UNSUBSCRIBE

const CMD_UNSUBACK

const CMD_PINGREQ

const CMD_PINGRESP

const CMD_DISCONNECT

const CMD_AUTH

Workerman\Mqtt\Consts\PropertyConst

src/Consts/PropertyConst.php

const PAYLOAD_FORMAT_INDICATOR

const MESSAGE_EXPIRY_INTERVAL

const CONTENT_TYPE

const RESPONSE_TOPIC

const CORRELATION_DATA

const SUBSCRIPTION_IDENTIFIER

const SESSION_EXPIRY_INTERVAL

const ASSIGNED_CLIENT_IDENTIFIER

const SERVER_KEEP_ALIVE

const AUTHENTICATION_METHOD

const AUTHENTICATION_DATA

const REQUEST_PROBLEM_INFORMATION

const WILL_DELAY_INTERVAL

const REQUEST_RESPONSE_INFORMATION

const RESPONSE_INFORMATION

const SERVER_REFERENCE

const REASON_STRING

const RECEIVE_MAXIMUM

const TOPIC_ALIAS_MAXIMUM

const TOPIC_ALIAS

const MAXIMUM_QOS

const RETAIN_AVAILABLE

const USER_PROPERTY

const MAXIMUM_PACKET_SIZE

const WILDCARD_SUBSCRIPTION_AVAILABLE

const SUBSCRIPTION_IDENTIFIER_AVAILABLE

const SHARED_SUBSCRIPTION_AVAILABLE

Workerman\Mqtt\Consts\ReasonCodeConst

src/Consts/ReasonCodeConst.php

static function getReasonPhrases(bool $isQos = false): array

static function getReasonPhrase(int $value, bool $isQos = false): string

static function getReason(int $value): string

const SUCCESS

const NORMAL_DISCONNECTION

const GRANTED_QOS_0

const GRANTED_QOS_1

const GRANTED_QOS_2

const DISCONNECT_WITH_WILL_MESSAGE

const NO_MATCHING_SUBSCRIBERS

const NO_SUBSCRIPTION_EXISTED

const CONTINUE_AUTHENTICATION

const RE_AUTHENTICATE

const UNSPECIFIED_ERROR

const MALFORMED_PACKET

const PROTOCOL_ERROR

const IMPLEMENTATION_SPECIFIC_ERROR

const UNSUPPORTED_PROTOCOL_VERSION

const CLIENT_IDENTIFIER_NOT_VALID

const BAD_USER_NAME_OR_PASSWORD

const NOT_AUTHORIZED

const SERVER_UNAVAILABLE

const SERVER_BUSY

const BANNED

const SERVER_SHUTTING_DOWN

const BAD_AUTHENTICATION_METHOD

const KEEP_ALIVE_TIMEOUT

const SESSION_TAKEN_OVER

const TOPIC_FILTER_INVALID

const TOPIC_NAME_INVALID

const PACKET_IDENTIFIER_IN_USE

const PACKET_IDENTIFIER_NOT_FOUND

const RECEIVE_MAXIMUM_EXCEEDED

const TOPIC_ALIAS_INVALID

const PACKET_TOO_LARGE

const MESSAGE_RATE_TOO_HIGH

const QUOTA_EXCEEDED

const ADMINISTRATIVE_ACTION

const PAYLOAD_FORMAT_INVALID

const RETAIN_NOT_SUPPORTED

const QOS_NOT_SUPPORTED

const USE_ANOTHER_SERVER

const SERVER_MOVED

const SHARED_SUBSCRIPTIONS_NOT_SUPPORTED

const CONNECTION_RATE_EXCEEDED

const MAXIMUM_CONNECT_TIME

const SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED

const WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED

Workerman\Mqtt\Handle\DecodeTrait

src/Handle/DecodeTrait.php

static function getCmd(string $buffer)

static function readString(string &$buffer)

static function shortInt(string &$buffer)

static function longInt(string &$buffer)

static function byte(string &$buffer)

static function varInt(string &$remaining, &$len)

static function getBodyLength(string $buffer, &$head_bytes)

static function getBody(string $buffer)

static function getLevel(string $data)

Workerman\Mqtt\Handle\DecodeV5

src/Handle/DecodeV5.php

static function connect(string $body): array

static function connAck(string $body): array

static function publish(int $dup, int $qos, int $retain, string $body): array

static function subscribe(string $body): array

static function subAck(string $body): array

static function unSubscribe(string $body): array

static function unSubAck(string $body): array

static function disconnect(string $body): array

static function getReasonCode(int $cmd, string $body): array

static function auth(string $data): array

Workerman\Mqtt\Handle\EncodeTrait

src/Handle/EncodeTrait.php

static function packString(string $str): string

static function stringPair(string $key, string $value): string

static function longInt(int $int): string

static function shortInt(int $int): string

static function varInt(int $int): string

static function packHead(int $cmd, int $body_length, int $dup = 0, int $qos = 0, int $retain = 0): string

Workerman\Mqtt\Handle\EncodeV5

src/Handle/EncodeV5.php

static function connect(array $data): string

static function connAck(array $data): string

static function publish(array $data): string

static function genReasonPhrase(array $data): string

static function subscribe(array $data): string

static function subAck(array $data): string

static function unSubscribe(array $data): string

static function unSubAck(array $data): string

static function disconnect(array $data): string

static function auth(array $data): string

Workerman\Mqtt\Handle\Property\PackProperty

src/Handle/Property/PackProperty.php

static function connect(array $data): string

static function willProperties(array $data): string

static function connAck(array $data): string

static function publish(array $data): string

static function pubAndSub(array $data): string

static function subscribe(array $data): string

static function unSubscribe(array $data): string

static function disConnect(array $data): string

static function auth(array $data): string

Workerman\Mqtt\Handle\Property\UnPackProperty

src/Handle/Property/UnPackProperty.php

static function connect(int $length, string &$body): array

static function willProperties(int $length, string &$body): array

static function connAck(int $length, string &$body): array

static function publish(int $length, string &$body): array

static function pubAndSub(int $length, string &$body): array

static function subscribe(int $length, string &$body): array

static function unSubscribe(int $length, string &$body): array

static function disConnect(int $length, string &$body): array

static function auth(int $length, string &$body): array

Workerman\Mqtt\Protocols\Mqtt

src/Protocols/Mqtt.php

static function input($buffer)

static function encode($data)

static function decode($buffer)

static function packString($str)

static function getCmd($buffer)

static function getBodyLength($buffer, &$head_bytes)

static function getBody($buffer)

static function readString(&$buffer)

static function readShortInt(&$buffer)

static function packHead($cmd, $body_length, $dup = 0, $qos = 0, $retain = 0)

const CMD_CONNECT

const CMD_CONNACK

const CMD_PUBLISH

const CMD_PUBACK

const CMD_PUBREC

const CMD_PUBREL

const CMD_PUBCOMP

const CMD_SUBSCRIBE

const CMD_SUBACK

const CMD_UNSUBSCRIBE

const CMD_UNSUBACK

const CMD_PINGREQ

const CMD_PINGRESP

const CMD_DISCONNECT

Workerman\Mqtt\Protocols\Mqtt5

src/Protocols/Mqtt5.php

static function input(string $buffer)

static function encode(array $data)

static function decode(string $buffer)

Workerman\Mqtt\Tools\Common

src/Tools/Common.php

static function printf(string $data)

static function __callStatic($method, $arguments)

Workerman\Mqtt\Tools\Debug

src/Tools/Debug.php

function __construct(string $encode = '')

function setEncode(string $encode): self

function getEncode(): string

function hexDump(): string

function hexDumpAscii(): string

function ascii(): string

function printableText(): string

function hexStream(): string