@ditchoom/mqtt-base-models v1.0.37

About The Project

Runtime Dependencies

• Buffer

Supported Platforms

Installation

Gradle

• Add implementation("com.ditchoom:mqtt-base-models:$version") to your build.gradle dependencies

NPM

• execute npm i @ditchoom/mqtt-base-models

Usage

Control Packet

A ControlPacket defines a message that can be serialized and deserialized over MQTT. More info can be found here

Serializing a Control Packet

ControlPacket.serialize provides a default way to serialize any control packet without knowing specific implementation details. This is useful when writing a generic client that doesn't care how the particular implementation serializes data

Deserializing a Control Packet

ControlPacketFactory provides a mechanism to provide an interface to allocate specific types of control packets regardless of the MQTT version. This allows for an easier upgrade path from MQTT 4 to 5.

Building Locally

• git clone git@github.com:DitchOoM/mqtt-base-models.git
• Open cloned directory with Intellij IDEA.
  • Be sure to open with gradle

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.