Basic client-side implementation of RFC7967: CoAP No-Response Option

This commit is contained in:
Michiel De Witte 2018-02-19 14:06:35 +01:00
parent 418143f9df
commit 1c18883b59
4 changed files with 34 additions and 5 deletions

View file

@ -165,6 +165,13 @@ class CoAP(object):
if not self._cb_ignore_write_exception(e, self): if not self._cb_ignore_write_exception(e, self):
raise raise
# if you're explicitly setting that you don't want a response, don't wait for it
# https://tools.ietf.org/html/rfc7967#section-2.1
for opt in message.options:
if opt.number == defines.OptionRegistry.NO_RESPONSE.number:
if opt.value == 26:
return
if self._receiver_thread is None or not self._receiver_thread.isAlive(): if self._receiver_thread is None or not self._receiver_thread.isAlive():
self._receiver_thread = threading.Thread(target=self.receive_datagram) self._receiver_thread = threading.Thread(target=self.receive_datagram)
self._receiver_thread.start() self._receiver_thread.start()

View file

@ -134,7 +134,7 @@ class HelperClient(object):
return self.send_request(request, callback, timeout) return self.send_request(request, callback, timeout)
def post(self, path, payload, callback=None, timeout=None, **kwargs): # pragma: no cover def post(self, path, payload, callback=None, timeout=None, no_response=False, **kwargs): # pragma: no cover
""" """
Perform a POST on a certain path. Perform a POST on a certain path.
@ -148,13 +148,17 @@ class HelperClient(object):
request.token = generate_random_token(2) request.token = generate_random_token(2)
request.payload = payload request.payload = payload
if no_response:
request.add_no_response()
request.type = defines.Types["NON"]
for k, v in kwargs.items(): for k, v in kwargs.items():
if hasattr(request, k): if hasattr(request, k):
setattr(request, k, v) setattr(request, k, v)
return self.send_request(request, callback, timeout) return self.send_request(request, callback, timeout, no_response=no_response)
def put(self, path, payload, callback=None, timeout=None, **kwargs): # pragma: no cover def put(self, path, payload, callback=None, timeout=None, no_response=False, **kwargs): # pragma: no cover
""" """
Perform a PUT on a certain path. Perform a PUT on a certain path.
@ -168,11 +172,15 @@ class HelperClient(object):
request.token = generate_random_token(2) request.token = generate_random_token(2)
request.payload = payload request.payload = payload
if no_response:
request.add_no_response()
request.type = defines.Types["NON"]
for k, v in kwargs.items(): for k, v in kwargs.items():
if hasattr(request, k): if hasattr(request, k):
setattr(request, k, v) setattr(request, k, v)
return self.send_request(request, callback, timeout) return self.send_request(request, callback, timeout, no_response=no_response)
def discover(self, callback=None, timeout=None, **kwargs): # pragma: no cover def discover(self, callback=None, timeout=None, **kwargs): # pragma: no cover
""" """
@ -190,7 +198,7 @@ class HelperClient(object):
return self.send_request(request, callback, timeout) return self.send_request(request, callback, timeout)
def send_request(self, request, callback=None, timeout=None): # pragma: no cover def send_request(self, request, callback=None, timeout=None, no_response=False): # pragma: no cover
""" """
Send a request to the remote server. Send a request to the remote server.
@ -204,6 +212,8 @@ class HelperClient(object):
thread.start() thread.start()
else: else:
self.protocol.send_message(request) self.protocol.send_message(request)
if no_response:
return
try: try:
response = self.queue.get(block=True, timeout=timeout) response = self.queue.get(block=True, timeout=timeout)
except Empty: except Empty:

View file

@ -127,6 +127,7 @@ class OptionRegistry(object):
PROXY_URI = OptionItem(35, "Proxy-Uri", STRING, False, None) PROXY_URI = OptionItem(35, "Proxy-Uri", STRING, False, None)
PROXY_SCHEME = OptionItem(39, "Proxy-Schema", STRING, False, None) PROXY_SCHEME = OptionItem(39, "Proxy-Schema", STRING, False, None)
SIZE1 = OptionItem(60, "Size1", INTEGER, False, None) SIZE1 = OptionItem(60, "Size1", INTEGER, False, None)
NO_RESPONSE = OptionItem(258, "No-Response", INTEGER, False, None)
RM_MESSAGE_SWITCHING = OptionItem(65524, "Routing", OPAQUE, False, None) RM_MESSAGE_SWITCHING = OptionItem(65524, "Routing", OPAQUE, False, None)
LIST = { LIST = {
@ -149,6 +150,7 @@ class OptionRegistry(object):
35: PROXY_URI, 35: PROXY_URI,
39: PROXY_SCHEME, 39: PROXY_SCHEME,
60: SIZE1, 60: SIZE1,
258: NO_RESPONSE,
65524: RM_MESSAGE_SWITCHING 65524: RM_MESSAGE_SWITCHING
} }

View file

@ -187,6 +187,16 @@ class Request(Message):
option.value = None option.value = None
self.add_option(option) self.add_option(option)
def add_no_response(self):
"""
Add the no-response option to the request
# https://tools.ietf.org/html/rfc7967#section-2.1
"""
option = Option()
option.number = defines.OptionRegistry.NO_RESPONSE.number
option.value = 26
self.add_option(option)
@if_none_match.deleter @if_none_match.deleter
def if_none_match(self): def if_none_match(self):
""" """