RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

gcoap/fileserver: update documentation

Browse Source
This commit is contained in:
Fabian Hüßler 2022-05-20 23:49:10 +02:00
parent 688acff5bc
commit 2327bef57f
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
sys/include/net/gcoap/fileserver.h
View File

@ -16,13 +16,18 @@
* This maps files in the local file system onto a resources in CoAP. In that,
* it is what is called a static web server in the unconstrained web.
*
* As usual, GET operations are used to read files<!-- WRITESUPPORT, and PUT writes to files.
* As usual, GET operations are used to read files and PUT writes to files.
* In the current implementation, PUTs are expressed as random-access, meaning
* that files are not updated atomically -->.
* that files are not updated atomically, although files are created atomically.
* The Content-Format option is not checked in the current implementation.
* Conditional file modification and deletion is supported using the If-Match
* option. The If-Match option carries a previously received Etag or in case of
* zero length, requires a request to be processed only if the resource exists.
* In opposite, the If-None-Match option requires a request to be processed,
* only if the resource does not yet exist, and is most useful for file creation.
*
* Directories are expressed to URIs with trailing slashes<!-- WRITESUPPORT, and are always
* created implicitly when files are PUT under them; they can be DELETEd when
* empty -->.
* Directories are expressed to URIs with trailing slashes and can be DELETEd
* when empty.
*
* @note The file server uses ETag for cache validation. The ETags are built
* from the file system stat values. As clients rely on the ETag to differ when
@ -55,8 +60,8 @@
* The path argument specifies under which path the folder is served via CoAP while
* the context argument contains the path on the local filesystem that will be served.
*
* The allowed methods dictate whether it's read-only (``COAP_GET``) or (in the
* future<!-- WRITESUPPORT -->) read-write (``COAP_GET | COAP_PUT | COAP_DELETE``).
* The allowed methods dictate whether it's read-only (``COAP_GET``) or
* read-write (``COAP_GET | COAP_PUT | COAP_DELETE``).
*
* @{
*