MQTT 4 Models

A kotlin multiplatform library which defines all the MQTT 4 models defined in the MQTT spec.


Report Bug · Request Feature

Table of Contents

1. About The Project
   • Runtime Dependencies
   • Supported Platforms
2. Installation
3. Usage
   • Serializing and deserializing a packet from a buffer
4. Building Locally
5. Getting Started
6. Roadmap
7. Contributing
8. License

About The Project

Runtime Dependencies

• Buffer
• MQTT Base Models

Supported Platforms

Platform	🛠Builds🛠 + 🔬Tests🔬	Deployed Artifact	Non Kotlin Sample
JVM 1.8	🚀	maven central 🔮	WIP
Node.js	🚀	npm 🔮	WIP
Browser (Chrome)	🚀	npm 🔮	WIP
Android	🚀	maven central 🔮	WIP
iOS	🚀	WIP cocoapods 🔮	WIP
WatchOS	🚀	WIP cocoapods 🔮	WIP
TvOS	🚀	WIP cocoapods 🔮	WIP
MacOS	🚀	WIP cocoapods 🔮	WIP
Linux X64	🚀	WIP apt/yum 🔮	WIP
Windows X64	🚀	WIP chocolatey 🔮	WIP

Installation

Gradle

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

NPM

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

Usage

Serializing and deserializing a packet from a buffer

1val connectionRequest = ConnectionRequest(clientId = "test", userName = "yolo")
2val buffer = PlatformBuffer.allocate(connectionRequest.packetSize())
3connectionRequest.serialize(buffer)
4buffer.resetForRead()
5
6val connectionRequestFromBuffer = ControlPacketV4Factory.from(buffer)
7// or can be done without having to specify version number directly
8val connectionRequestFromBuffer = connectionRequest.controlPacketFactory.from(buffer)
9assertEquals(connectionRequest, connectionRequestFromBuffer)

Building Locally

• git clone git@github.com:DitchOoM/mqtt-4-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.