mirror/mongoose
1
0
Fork 0
mirror of https://github.com/cesanta/mongoose.git synced 2024-11-28 05:39:00 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
4974303e6b
mongoose/examples
History
Sergio R. Caprile 4974303e6b Make example as README says
2023-02-10 20:06:25 -03:00
..
arduino/w5500 Move mip/ -> src/tcpip/, rename mip_ -> mg_tcpip_ 2023-02-07 21:35:37 +00:00
captive-dns-server Use int debug level 2022-08-01 11:19:32 +01:00
device-dashboard Update screenshot 2023-02-09 22:47:48 +00:00
embedded-filesystem Test WS frames that are larger than 64k 2022-08-13 11:16:13 +01:00
esp32 Add TLS to pico-w5500 baremetal example 2023-01-30 21:30:10 +00:00
esp8266/http-client-server make clean: invoke docker only when there is something to clean 2023-01-21 07:44:50 +00:00
file-upload-html-form Use int debug level 2022-08-01 11:19:32 +01:00
file-upload-multiple-posts Use int debug level 2022-08-01 11:19:32 +01:00
file-upload-single-post Correct the description 2023-01-27 22:45:35 +00:00
http-client Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
http-proxy-client Added openSSL support 2022-06-20 15:27:46 -03:00
http-restful-server do not use %I 2023-01-30 17:13:38 -03:00
http-reverse-proxy Use int debug level 2022-08-01 11:19:32 +01:00
http-server Adopt Makefile for Windows. Update examples readme section 2023-02-04 14:15:53 +00:00
http-streaming-client Use int debug level 2022-08-01 11:19:32 +01:00
huge-response mg_*rprintf -> mg_*xprintf 2022-08-13 20:34:20 +01:00
infineon/infineon-xmc4700_4800-lwip-rtx-rtos Add RTX-RTOS support 2022-02-23 19:56:37 +02:00
json-rpc-over-websocket Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
live-log Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
mip-pcap Move mip/ -> src/tcpip/, rename mip_ -> mg_tcpip_ 2023-02-07 21:35:37 +00:00
mip-tap Move mip/ -> src/tcpip/, rename mip_ -> mg_tcpip_ 2023-02-07 21:35:37 +00:00
mqtt-client fixed TLS build comment 2022-06-28 10:49:45 -03:00
mqtt-client-aws-iot Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
mqtt-over-ws-client Use int debug level 2022-08-01 11:19:32 +01:00
mqtt-server Fix MQTT server example 2022-12-20 16:06:46 -03:00
multi-threaded Show how to send data to a worker thread 2022-08-25 17:00:47 -03:00
nxp Add more NXP examples and move them to nxp folder 2021-10-22 14:04:15 +03:00
rp2040 Add mass-storage disk with an index file 2023-02-08 12:38:11 -03:00
smtp-client Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
sntp-time-sync Use int debug level 2022-08-01 11:19:32 +01:00
socks5-server Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
stm32 Make example as README says 2023-02-10 20:06:25 -03:00
tcp Added TLS support 2022-08-08 15:42:35 -03:00
ti Move mip/ -> src/tcpip/, rename mip_ -> mg_tcpip_ 2023-02-07 21:35:37 +00:00
timers Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
uart-bridge Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
udp-ssdp-search Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
video-stream Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
websocket-client Use int debug level 2022-08-01 11:19:32 +01:00
websocket-server Update comment for the path of rest API 2022-12-13 15:33:51 +01:00
webui-login Fix SameSite cookie value 2022-08-26 10:22:31 -03:00
webui-plain Update examples to use mg_http_reply 2022-08-13 14:52:10 +01:00
webui-preact back to symbolic link 2022-08-15 18:42:20 -03:00
webui-push-rest Change argument of %M handler to mg_pfn_t as in huge_response 2022-08-15 16:04:17 -03:00
webui-push-ws Rename struct mg_connection::label -> data. Make its size configurable 2023-01-10 08:19:49 +00:00
webui-rest Use int debug level 2022-08-01 11:19:32 +01:00
zephyr Remove dups in Zephyr dirs 2023-01-31 14:51:48 -03:00
README.md Add readme rule 2023-02-09 20:04:59 +00:00

README.md

Mongooose Network Library Examples

In order to build and run any of the existing examples, please follow: https://mongoose.ws/documentation/#how-to-build-and-run-examples

Contributing

Rules for creating a new example:

  • Makefile golden reference for desktop/server example: http-server
  • Makefile golden reference for the embedded example: stm32/nucleo-f746zg-baremetal
  • An example must build on Windows, Mac and Ubuntu Linux systems
  • Assume that user installed tools according to https://mongoose.ws/tutorials/tools/
  • Makefile must not include any other make files
  • Use CFLAGS for compilation options
  • Add CFLAGS_EXTRA to the end of CFLAGS, to allow user to specify extra options, for example: 
    make CFLAGS_EXTRA="-pedantic -O2"
  • If external repository is required, download it on demand using git shallow clone. See embedded example golden reference
  • Keep Makefile as short as possible, but verbose to understand it easily
  • Symlink files when required, like mongoose.c, ca.pem, etc. Make no copies
  • Example's README.md should contain only the title and the link to mongoose.ws tutorial page