xref: /aosp_15_r20/external/libwebsockets/READMEs/mainpage.md (revision 1c60b9aca93fdbc9b5f19b2d2194c91294b22281)
1*1c60b9acSAndroid Build Coastguard Worker##Libwebsockets API introduction
2*1c60b9acSAndroid Build Coastguard Worker
3*1c60b9acSAndroid Build Coastguard WorkerLibwebsockets covers a lot of interesting features for people making embedded servers or clients
4*1c60b9acSAndroid Build Coastguard Worker
5*1c60b9acSAndroid Build Coastguard Worker - HTTP(S) serving and client operation
6*1c60b9acSAndroid Build Coastguard Worker - HTTP/2 support for serving and client operation
7*1c60b9acSAndroid Build Coastguard Worker - WS(S) serving and client operation
8*1c60b9acSAndroid Build Coastguard Worker - HTTP(S) apis for file transfer and upload
9*1c60b9acSAndroid Build Coastguard Worker - HTTP 1 + 2 POST form handling (including multipart / file upload)
10*1c60b9acSAndroid Build Coastguard Worker - cookie-based sessions
11*1c60b9acSAndroid Build Coastguard Worker - account management (including registration, email verification, lost pw etc)
12*1c60b9acSAndroid Build Coastguard Worker - strong SSL / TLS  PFS support (A+ on SSLlabs test)
13*1c60b9acSAndroid Build Coastguard Worker - ssh server integration
14*1c60b9acSAndroid Build Coastguard Worker - serving gzipped files directly from inside zip files, without conversion
15*1c60b9acSAndroid Build Coastguard Worker - support for linux, bsd, windows etc... and very small nonlinux targets like ESP32
16*1c60b9acSAndroid Build Coastguard Worker
17*1c60b9acSAndroid Build Coastguard WorkerPlease note you just need in include libwebsockets.h.  It includes all the individual
18*1c60b9acSAndroid Build Coastguard Workerincludes in /usr/include/libwebsockets/ itself.
19*1c60b9acSAndroid Build Coastguard Worker
20*1c60b9acSAndroid Build Coastguard WorkerBrowse by <a href="modules.html">API category (module)</a>
21*1c60b9acSAndroid Build Coastguard Worker
22*1c60b9acSAndroid Build Coastguard WorkerBrowse by <a href="files.html">file listing</a>
23*1c60b9acSAndroid Build Coastguard Worker
24*1c60b9acSAndroid Build Coastguard WorkerBrowse by <a href="annotated.html">data structures</a>
25*1c60b9acSAndroid Build Coastguard Worker
26*1c60b9acSAndroid Build Coastguard WorkerA collection of READMEs for build, coding, lwsws etc are <a href="pages.html">here</a>
27*1c60b9acSAndroid Build Coastguard Worker
28