Added MQTTv5 UTransport methods #1
Conversation
matthewd0123
commented
Mar 19, 2024
matthewd0123
commented
- Added UTransport (send, registerlistener, unregisterlistener) methods
- Added pub/sub examples for testing.
- Updated README with information on installation and use.
- Added necessary legal/contributing documents
- Added publish workflow
* Added UTransport (send, registerlistener, unregisterlistener) methods * Added pub/sub examples for testing. * Updated README with information on installation and use. * Added necessary legal/contributing documents * Added publish workflow
| --- | ||
|
|
||
| === Using UTransport APIs | ||
|
|
There was a problem hiding this comment.
In this scenario you have this listed as mqtt5_subscriber. Would an mqtt5_subscriber be initialized the same way as it is done in Creating a Instance of MQTT5UTransport?
All Properties in UAttributes will be mapped to MQTT Publish Properties. As Such, I have added this into the UTransport. nb: I am using the in-built Base64ProtobufSerializer() methods to serialize and deserialize the UUIDs (id and reqid). This implementation may change.
* Testing Send and RegisterListener using paho.mqtt FakeBroker and Pytest * Support all userproperties mapping to UAttributes
|
|
||
| return UStatus(code=UCode.OK, message="OK") | ||
|
|
||
| def register_listener(self, topic: UUri, listener: UListener) -> UStatus: |
There was a problem hiding this comment.
I believe that there is a PR currently out for 1.5.8 that updates the register_listener, unregister_listener and receive functions to use a source_filter and a sink_filter. @sophokles73 and @stevenhartley, is this correct that the uTransport spec change is expected to get in for 1.5.8?
There was a problem hiding this comment.
yes, the corresponding PR is eclipse-uprotocol/up-spec#134 which will go into 1.5.8
| @@ -0,0 +1,100 @@ | |||
| # Copyright (C) 2021 | |||
There was a problem hiding this comment.
This file and some other files in test have this license. Is this the correct license?
There was a problem hiding this comment.
No, it refers to the EPL but uProtocol uses the Apache Software License 2.0. It should be
# SPDX-FileCopyrightText: 2021 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
There was a problem hiding this comment.
@devkelley @sophokles73 for some of the files in tests folder, I have brought in test code from the paho.mqtt.python project, which is an eclipse project (https://github.com/eclipse/paho.mqtt.python/tree/master/tests). I have used the licensing that they used in some of their files. Can one of you let me know if there is a different way to reference that I'm using their code, or if it's even allowed to take code from other eclipse projects?
There was a problem hiding this comment.
Hmm, that is a good question. I am sure it depends partly on the EPL-2.0 license and what that stipulates. This FAQ seems to imply that it is okay to include as long as you include where you got the code from and the license (https://www.eclipse.org/legal/epl-2.0/faq.php). That being said it would probably be good to verify with someone from eclipse foundation
* Update MQTT Client and examples to 1.5.8 * Format to align with ruff standards * Add linter to workflow
