Documentation ¶
Overview ¶
SurgeMQ is a high performance MQTT broker and client library that aims to be fully compliant with MQTT 3.1 and 3.1.1 specs.
The primary package that's of interest is package service. It provides the MQTT Server and Client services in a library form.
MQTT is a Client Server publish/subscribe messaging transport protocol. It is light weight, open, simple, and designed so as to be easy to implement. These characteristics make it ideal for use in many situations, including constrained environments such as for communication in Machine to Machine (M2M) and Internet of Things (IoT) contexts where a small code footprint is required and/or network bandwidth is at a premium. The protocol runs over TCP/IP, or over other network protocols that provide ordered, lossless, bi-directional connections. Its features include: - Use of the publish/subscribe message pattern which provides one-to-many message distribution and decoupling of applications. - A messaging transport that is agnostic to the content of the payload. - Three qualities of service for message delivery: - "At most once", where messages are delivered according to the best efforts of the operating environment. Message loss can occur. This level could be used, for example, with ambient sensor data where it does not matter if an individual reading is lost as the next one will be published soon after. - "At least once", where messages are assured to arrive but duplicates can occur. - "Exactly once", where message are assured to arrive exactly once. This level could be used, for example, with billing systems where duplicate or lost messages could lead to incorrect charges being applied. - A small transport overhead and protocol exchanges minimized to reduce network traffic. - A mechanism to notify interested parties when an abnormal disconnection occurs.
Current performance benchmark of SurgeMQ, running all publishers, subscribers and broker on a single 4-core (2.8Ghz i7) MacBook Pro, is able to achieve:
- over 400,000 MPS in a 1:1 single publisher and single producer configuration
- over 450,000 MPS in a 20:1 fan-in configuration
- over 750,000 MPS in a 1:20 fan-out configuration
- over 700,000 MPS in a full mesh configuration with 20 clients
In addition, SurgeMQ has been tested with the following client libraries and it _seems_ to work:
- libmosquitto 1.3.5 (C)
- Tested with the bundled test programs msgsps_pub and msgsps_sub
- Paho MQTT Conformance/Interoperability Testing Suite (Python)
- Tested with all 10 test cases, 3 did not pass. They are 1) offline_message_queueing_test which is not supported by SurgeMQ, 2) redelivery_on_reconnect_test which is not yet implemented by SurgeMQ, 3) run_subscribe_failure_test which is not a valid test.
- Paho Go Client Library (Go)
- Tested with one of the tests in the library, in fact, that tests is now part of the tests for SurgeMQ
- Paho C Client library (C)
- Tested with most of the test cases and failed the same ones as the conformance test because the features are not yet implemented.
- Actually I think there's a bug in the test suite as it calls the PUBLISH handler function for non-PUBLISH messages.
A quick example of how to use SurgeMQ:
func main() { // Create a new server svr := &service.Server{ KeepAlive: 300, // seconds ConnectTimeout: 2, // seconds SessionsProvider: "mem", // keeps sessions in memory Authenticator: "mockSuccess", // always succeed TopicsProvider: "mem", // keeps topic subscriptions in memory } // Listen and serve connections at localhost:1883 err := svr.ListenAndServe("tcp://:1883") fmt.Printf("%v", err) }
Directories ¶
Path | Synopsis |
---|---|
examples
|
|
pingmq
pingmq is developed to demonstrate the different use cases one can use SurgeMQ.
|
pingmq is developed to demonstrate the different use cases one can use SurgeMQ. |
Package service provides the MQTT Server and Client services in a library form.
|
Package service provides the MQTT Server and Client services in a library form. |
Package topics deals with MQTT topic names, topic filters and subscriptions.
|
Package topics deals with MQTT topic names, topic filters and subscriptions. |
Click to show internal directories.
Click to hide internal directories.