Represents an MQTT endpoint for point-to-point communication with the remote MQTT client
| package |
Default |
|---|
__construct()
accept( $arg0 = null) : $this
accept()
Sends the CONNACK message to the remote MQTT client with "connection accepted" return code. See @see \io\vertx\jphp\mqtt\MqttEndpoint::reject for refusing connection
param $sessionPresent [boolean] if a previous session is present accept($sessionPresent)
boolean
$this
auth() : \io\vertx\jphp\mqtt\MqttAuth
\io\vertx\jphp\mqtt\MqttAuththe Authentication information as provided by the remote MQTT client
autoKeepAlive( $arg0) : $this
boolean
$thisa reference to this, so the API can be used fluently
clientIdentifier() : string
stringthe client identifier as provided by the remote MQTT client
close() : void
closeHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
disconnectHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
exceptionHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
isAutoKeepAlive() : boolean
booleanthe auto keep alive status (sending ping response)
isCleanSession() : boolean
booleantrue when clean session is requested by the remote MQTT client
isConnected() : boolean
booleanif the connection between remote client and local endpoint is established/open
isPublishAutoAck() : boolean
booleanauto acknowledge status for publishing (in/out)
isSsl() : boolean
booleantrue if this {@link io.vertx.mqtt.MqttEndpoint} is encrypted via SSL/TLS.
isSubscriptionAutoAck() : boolean
booleantrue when auto acknowledge status for subscription/unsubscription requests
keepAliveTimeSeconds() : integer
integerthe keep alive timeout (in seconds) specified by the remote MQTT client
lastMessageId() : integer
integerthe message identifier used for last published message
localAddress() : \io\vertx\jphp\core\net\SocketAddress
pingHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
pong() : $this
$thisa reference to this, so the API can be used fluently
protocolName() : string
stringthe protocol name provided by the remote MQTT client
protocolVersion() : integer
integerthe protocol version required by the remote MQTT client
publish( $arg0, $arg1, $arg2, $arg3, $arg4, $arg5 = null) : $this
param $topic [string] topic on which the message is published param $payload [Buffer] message payload param $qosLevel [string] quality of service level param $isDup [boolean] if the message is a duplicate param $isRetain [boolean] if the message needs to be retained publish($topic, $payload, $qosLevel, $isDup, $isRetain)
Sends the PUBLISH message to the remote MQTT server
param $topic [string] topic on which the message is published param $payload [Buffer] message payload param $qosLevel [string] QoS level param $isDup [boolean] if the message is a duplicate param $isRetain [boolean] if the message needs to be retained param $publishSentHandler [callable] handler called after PUBLISH packet sent with a packetId publish($topic, $payload, $qosLevel, $isDup, $isRetain, $publishSentHandler)
string
Buffer
string
boolean
boolean
callable
$thisa reference to this, so the API can be used fluently
publishAcknowledge( $arg0) : $this
integer
$thisa reference to this, so the API can be used fluently
publishAcknowledgeHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
publishAutoAck( $arg0) : $this
boolean
$thisa reference to this, so the API can be used fluently
publishComplete( $arg0) : $this
integer
$thisa reference to this, so the API can be used fluently
publishCompletionHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
publishHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
publishReceived( $arg0) : $this
integer
$thisa reference to this, so the API can be used fluently
publishReceivedHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
publishRelease( $arg0) : $this
integer
$thisa reference to this, so the API can be used fluently
publishReleaseHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
reject( $arg0) : $this
string
$thisa reference to this, so the API can be used fluently
remoteAddress() : \io\vertx\jphp\core\net\SocketAddress
setClientIdentifier( $arg0) : $this
string
$thisa reference to this, so the API can be used fluently
subscribeAcknowledge( $arg0, $arg1) : $this
integer
array
$thisa reference to this, so the API can be used fluently
subscribeHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
subscriptionAutoAck( $arg0) : void
boolean
unsubscribeAcknowledge( $arg0) : $this
integer
$thisa reference to this, so the API can be used fluently
unsubscribeHandler( $arg0) : $this
callable
$thisa reference to this, so the API can be used fluently
will() : \io\vertx\jphp\mqtt\MqttWill