https://github.com/nzsmartie/coap.net

Constrained Applciaiton Protocol (CoAP) [RFC7252] for .Net Standard
https://github.com/nzsmartie/coap.net

coap net netstandard rfc7252

Last synced: 8 days ago
JSON representation

Constrained Applciaiton Protocol (CoAP) [RFC7252] for .Net Standard

• Host: GitHub
• URL: https://github.com/nzsmartie/coap.net
• Owner: NZSmartie
• License: apache-2.0
• Created: 2017-02-12T07:51:18.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-16T07:30:58.000Z (about 1 year ago)
• Last Synced: 2024-10-12T09:23:24.303Z (24 days ago)
• Topics: coap, net, netstandard, rfc7252
• Language: C#
• Homepage: https://nzsmartie.co.nz/CoAP.Net/
• Size: 1.01 MB
• Stars: 34
• Watchers: 9
• Forks: 11
• Open Issues: 12
• Metadata Files:
  • Readme: Readme.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CoAP.Net [![Build status](https://img.shields.io/appveyor/ci/NZSmartie/coap-net-iu0to.svg?logo=appveyor)](https://ci.appveyor.com/project/NZSmartie/coap-net-iu0to) [![Tests Status](https://img.shields.io/appveyor/tests/NZSmartie/coap-net-iu0to.svg?logo=appveyor)](https://ci.appveyor.com/project/NZSmartie/coap-net-iu0to/build/tests) [![Coverage Status](https://coveralls.io/repos/github/NZSmartie/CoAP.Net/badge.svg?branch=master)](https://coveralls.io/github/NZSmartie/CoAP.Net?branch=master) [![NuGet](https://img.shields.io/nuget/v/NZSmartie.CoAPNet.svg)](https://www.nuget.org/packages/NZSmartie.CoAPNet/) [![MyGet Pre Release](https://img.shields.io/myget/coapnet/vpre/NZSmartie.CoapNet.svg?label=myget)](https://www.myget.org/feed/Packages/coapnet) [![license](https://img.shields.io/github/license/NZSmartie/CoAP.Net.svg)](https://github.com/NZSmartie/CoAP.Net/blob/master/LICENSE) 

## About

This library is a transport agnostic implementation of the Constraint Application Protocol (CoAP - RFC 7252) for .Net Standard.

Since CoAP is designed for unreliable transport layers. (6LoWPAN, UDP, etc...) it made sense to not worry about the transport implementaions and allow the applicatrion to provide their own.

If you're after a UDP transport example, see [CoAPNet.Udp](CoAPNet.Udp/)

## Changelog

All relevant changes are logged in [Changelog.md](Changelog.md)

## Status

 - Full support for [RFC 7959 - Block-Wise Transfers in the Constrained Application Protocol (CoAP)](https://tools.ietf.org/html/rfc7959)

 - Support for Sending and Receiving Confirmable (CON) and Non-Confirmable (NON) messagees.

   - Retransmit confirmable messages, throwing an exception on failure

   - Rejects malform messages with appropiate error code.

   - Ignores repeated messages within a set `TimeSpan`

 - Support for Sending and receiving multicast messages. 

 - `CoapServer` - Simple server for binding to local transports and processing requests 

   - `CoapHandler` - Template request handler to be used by CoapServer

     - `CoapResourceHandler` - Example handler that specificaly serves `CoapResource`s

### Todo

 - Create unit tests to cover as much of RFC7252 as possible.

 - Create more examples

 - Support DTLS over UDP

 - Resolve host names using mDNS or DNS

 - Await message response for non-confirmable (NON) messages

 - Support for [RFC 7641 - Observing Resources in the Constrained Application Protocol (CoAP)](https://tools.ietf.org/html/rfc7641)

 - Support for [RFC 7390 - Group Communication for the Constrained Application Protocol (CoAP)](https://tools.ietf.org/html/rfc7390)

## Stats

[![Build History](https://buildstats.info/appveyor/chart/NZSmartie/coap-net-iu0to?branch=master)](https://ci.appveyor.com/project/NZSmartie/coap-net-iu0to/history)

## Examples

### [SimpleServer](samples/SimpleServer/Program.cs)

Starts a CoAP server listening on all network interfaces and listens for multicast requests.

### [SimpleClient](samples/SimpleClient/Program.cs)

Sends a GET `/hello` request to localhost and prints the response resource.

> Note: Run SimpleServer and then run SimpleClient to see both in action

### [Multicast Discovery](samples/Multicast/Program.cs)

Will send a multicast GET `/.well-known/core` request every minute and prints responses received.