Mirrors/libwebsockets
1
0
Fork 0
mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-16 00:00:07 +01:00
Code Issues Releases Wiki Activity
libwebsockets/READMEs/mainpage.md
Andy Green d1f9f0ae2d libwebsockets.h: split out into a dir of sub-includes included by libwebsockets.h 
This has no effect on user code or backward compatibility.

It moves the in-tree public api header libwebsockets.h from ./lib
to ./include, and introduces a dir ./include/libwebsockets/

The single public api header is split out into 31 sub-headers
in ./include/libwebsockets.  ./include/libwebsockets.h contains
some core types and platform adaptation code, but the rest of it
is now 31 #include <libwebsockets/...>

At install time, /usr/[local/]include/libwebsockets.h is installed
as before, along now with the 31 sub-headers in ...include/libwebsockets/

There's no net effect on user code.

But the api header is now much easier to maintain and study, with 31
topic-based sub headers.
2018-09-11 18:27:59 +08:00

1,009 B
Raw Permalink Blame History

##Libwebsockets API introduction

Libwebsockets covers a lot of interesting features for people making embedded servers or clients

  • HTTP(S) serving and client operation
  • HTTP/2 support for serving and client operation
  • WS(S) serving and client operation
  • HTTP(S) apis for file transfer and upload
  • HTTP 1 + 2 POST form handling (including multipart / file upload)
  • cookie-based sessions
  • account management (including registration, email verification, lost pw etc)
  • strong SSL / TLS PFS support (A+ on SSLlabs test)
  • ssh server integration
  • serving gzipped files directly from inside zip files, without conversion
  • support for linux, bsd, windows etc... and very small nonlinux targets like ESP32

Please note you just need in include libwebsockets.h. It includes all the individual includes in /usr/include/libwebsockets/ itself.

You can browse by api category here

A collection of READMEs for build, coding, lwsws etc are here