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-5-models:$version") to your build.gradle dependencies

NPM

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

Usage

Serializing and deserializing a packet from a buffer

val connectionRequest = ConnectionRequest(clientId = "test", userName = "yolo")
val buffer = PlatformBuffer.allocate(connectionRequest.packetSize())
connectionRequest.serialize(buffer)
buffer.resetForRead()

val connectionRequestFromBuffer = ControlPacketV5Factory.from(buffer)
// or can be done without having to specify version number directly
val connectionRequestFromBuffer = connectionRequest.controlPacketFactory.from(buffer)
assertEquals(connectionRequest, connectionRequestFromBuffer)

Building Locally

• git clone [email protected]:DitchOoM/mqtt-5-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.