io.emqx.exproto

Class AbstractExProtoHandler

java.lang.Object

io.emqx.exproto.ExProto

io.emqx.exproto.AbstractExProtoHandler

public abstract class AbstractExProtoHandler
extends ExProto

EMQ X ExProto java SDK;

Connection java project to EMQ X Broker. Note 1: Not use "System.in.*" or "System.out.*" They are used to communicate with EMQ X. Note 2: Invoke "ExProtoSDK.loadExProtoHandler(AbstractExProtoHandler handler)" or "AbstractExProtoHandler.loadExProtoHandler(AbstractExProtoHandler handler)"

load your AbstractExProtoHandler in the "Nonparametric construction method".

Constructor Summary

Constructors

Constructor and Description
AbstractExProtoHandler()

Method Summary

Modifier and Type	Method and Description
abstract void	onConnectionDeliver(Connection connection, Message[] messagesArr) A connection received a serial of messages from subscribed topic.
abstract void	onConnectionEstablished(Connection connection, ConnectionInfo connectionInfo) A connection established.
abstract void	onConnectionReceived(Connection connection, byte[] data) A connection received bytes.
abstract void	onConnectionTerminated(Connection connection, String reason) A connection terminated.
static void	publish(Connection connection, Message message) The connection Publish a Message to EMQ X
static void	register(Connection connection, ClientInfo clientInfo) Register the connection as a Client of EMQ X.
static void	send(Connection connection, byte[] data) Send a stream of bytes to the connection.
static void	subscribe(Connection connection, String topic, int qos) The connection Subscribe a Topic to EMQ X
static void	terminate(Connection connection) Terminate the connection process and TCP/UDP socket.
static void	unsubscribe(Connection connection, String topic) The Connection UnSubscribe a Topic to EMQ X

Methods inherited from class io.emqx.exproto.ExProto

deliver, init, loadExProtoHandler, received, terminated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractExProtoHandler

public AbstractExProtoHandler()

Method Detail

onConnectionEstablished

public abstract void onConnectionEstablished(Connection connection,
                                             ConnectionInfo connectionInfo)

A connection established.

This function will be scheduled after a TCP connection established to EMQ X or receive a new UDP socket.

Parameters:

connection - The Connection instance

connectionInfo - The Connection information

onConnectionReceived

public abstract void onConnectionReceived(Connection connection,
                                          byte[] data)

A connection received bytes.

This callback will be scheduled when a connection received bytes from TCP/UDP socket.

Parameters:

connection - The Connection instance

data - The bytes array

onConnectionTerminated

public abstract void onConnectionTerminated(Connection connection,
                                            String reason)

A connection terminated.

This function will be scheduled after a connection terminated.

It indicates that the EMQ X process that maintains the TCP/UDP socket has been closed. E.g: a TCP connection is closed, or a UDP socket has exceeded maintenance hours.

Parameters:

connection - The Connection instance

reason - The Connection terminated reason

onConnectionDeliver

public abstract void onConnectionDeliver(Connection connection,
                                         Message[] messagesArr)

A connection received a serial of messages from subscribed topic.

This function will be scheduled when a connection received a Message from EMQ X

When a connection is subscribed to a topic and a message arrives on that topic, EMQ X will deliver the message to that connection. At that time, this function is triggered.

Parameters:

connection - The Connection instance

messagesArr - The message array

send

public static void send(Connection connection,
                        byte[] data)
                 throws Exception

Send a stream of bytes to the connection.

These bytes are delivered directly to the associated TCP/UDP socket.

Parameters:

connection - The Connection instance

data - The bytes

Throws:

Exception

terminate

public static void terminate(Connection connection)
                      throws Exception

Terminate the connection process and TCP/UDP socket.

Parameters:

connection - The Connection instance

Throws:

Exception

register

public static void register(Connection connection,
                            ClientInfo clientInfo)
                     throws Exception

Register the connection as a Client of EMQ X.

This `clientInfo` contains the necessary field information to be an EMQ X client.

This method should normally be invoked after confirming that a connection is allowed to access the EMQ X system. For example: after the connection packet has been parsed and authenticated successfully.

Parameters:

connection - Then Connection instance

clientInfo - The Client information

Throws:

Exception

publish

public static void publish(Connection connection,
                           Message message)
                    throws Exception

The connection Publish a Message to EMQ X

Parameters:

connection - The Connection instance

message - The Message

Throws:

Exception

subscribe

public static void subscribe(Connection connection,
                             String topic,
                             int qos)
                      throws Exception

The connection Subscribe a Topic to EMQ X

Parameters:

connection - The Connection instance

topic - The Topic name.

qos - The subscribed QoS level, available value: 0, 1, 2.

Throws:

Exception

unsubscribe

public static void unsubscribe(Connection connection,
                               String topic)
                        throws Exception

The Connection UnSubscribe a Topic to EMQ X

Parameters:

connection - The Connection instance

topic - The Topic name.

Throws:

Exception