About Courier
Courier is a kotlin library for creating long running connections using MQTT protocol.
Long running connection is a persistent connection established between client & server for instant bi-directional communication. A long running connection is maintained for maximum possible duration with the help of keep alive packets. This helps in saving battery and data on mobile devices.
MQTT is an extremely lightweight protocol which works on publish/subscribe messaging model. It is designed for connections with remote locations where a "small code footprint" is required or the network bandwidth is limited.
The protocol usually runs over TCP/IP; however, any network protocol that provides ordered, lossless, bi-directional connections can support MQTT.
MQTT has 3 built-in QoS levels for Reliable Message Delivery:
-
QoS 0(At most once) - the message is sent only once and the client and broker take no additional steps to acknowledge delivery (fire and forget).
-
QoS 1(At least once) - the message is re-tried by the sender multiple times until acknowledgement is received (acknowledged delivery).
-
QoS 2(Exactly once) - the sender and receiver engage in a two-level handshake to ensure only one copy of the message is received (assured delivery).
Features
-
Clean API
-
Adaptive Keep Alive
-
Message & Stream Adapters
-
Subscription Store
-
Automatic Reconnect & Resubscribe
-
Database Persistence
-
Backpressure handling
-
Alarm, Timer & WorkManager Ping Sender
-
MQTT Chuck
More details about features in Courier library can be found here
Getting Started
Sample App
A demo application is added here which makes Courier connection with a HiveMQ public broker.
Download
All artifacts of Courier library are available via Maven Central.
repositories {
mavenCentral()
}
dependencies {
implementation "com.gojek.courier:courier:x.y.z"
implementation "com.gojek.courier:courier-message-adapter-gson:x.y.z"
implementation "com.gojek.courier:courier-stream-adapter-rxjava2:x.y.z"
}
Usage
Declare a service interface for actions like Send, Receive, Subscribe, Unsubscribe:
interface MessageService {
@Receive(topic = "topic/{id}/receive")
fun receive(@Path("id") identifier: String): Observable<Message>
@Send(topic = "topic/{id}/send", qos = QoS.TWO)
fun send(@Path("id") identifier: String, @Data message: Message)
@Subscribe(topic = "topic/{id}/receive", qos = QoS.ONE)
fun subscribe(@Path("id") identifier: String): Observable<Message>
@Unsubscribe(topics = ["topic/{id}/receive"])
fun unsubscribe(@Path("id") identifier: String)
}
Use Courier to create an implementation:
val mqttClient = MqttClientFactory.create(
context = context,
mqttConfiguration = MqttV3Configuration(
authenticator = authenticator
)
)
val courierConfiguration = Courier.Configuration(
client = mqttClient,
streamAdapterFactories = listOf(RxJava2StreamAdapterFactory()),
messageAdapterFactories = listOf(GsonMessageAdapter.Factory())
)
val courier = Courier(courierConfiguration)
val messageService = courier.create<MessageService>()
Subscribe/Unsubscribe using Service Interface
messageService.subscribe("user-id").subscribe { message ->
print(message)
}
messageService.unsubscribe("user-id")
Send/Receive using Service Interface
messageService.send("user-id", message)
messageService.receive("user-id") { message ->
print(message)
}
Connect using MqttClient
val connectOptions = MqttConnectOptions(
serverUris = listOf(ServerUri(SERVER_URI, SERVER_PORT)),
clientId = clientId,
username = username,
keepAlive = KeepAlive(
timeSeconds = keepAliveSeconds
),
isCleanSession = cleanSessionFlag,
password = password
)
mqttClient.connect(connectOptions)
Disconnect using MqttClient
mqttClient.disconnect()
Non-standard Connection options
UserProperties in MqttConnectionOptions
This option allows you to send user-properties in CONNECT packet for MQTT v3.1.1.
val connectOptions = MqttConnectOptions(
serverUris = listOf(ServerUri(SERVER_URI, SERVER_PORT)),
clientId = clientId,
...
userPropertiesMap = mapOf(
"key1" to "value1",
"key2" to "value2"
)
)
mqttClient.connect(connectOptions)
Contribution Guidelines
Read our contribution guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Courier Android library.
License
All Courier modules except Paho are MIT Licensed. Paho is Eclipse Licensed.
0 Jan 21, 2022
12 Dec 1, 2022
18 Dec 16, 2022
1 Nov 8, 2021
25 Jul 20, 2021
10.7k Jan 9, 2023
514 Jan 8, 2023
0 Dec 16, 2021
3 Aug 10, 2022
2 Apr 6, 2022
25 Dec 27, 2022
23 Dec 27, 2022
98 Jan 3, 2023
4 Oct 2, 2022
2 May 6, 2022
27 Jan 1, 2023
174 Dec 22, 2022
58 Nov 1, 2022
3 Feb 2, 2022