1
0
Fork 0
mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-16 00:00:07 +01:00
libwebsockets/doc/html/navtreedata.js

143 lines
8.9 KiB
JavaScript
Raw Normal View History

var NAVTREE =
[
[ "libwebsockets", "index.html", [
[ "Libwebsockets API introduction", "index.html", null ],
2016-11-14 18:12:31 +08:00
[ "Notes about building lws", "md_README_8build.html", [
[ "Introduction to CMake", "md_README_8build.html#cm", null ],
[ "Building the library and test apps", "md_README_8build.html#build1", null ],
[ "Building on Unix:", "md_README_8build.html#bu", null ],
[ "Quirk of cmake", "md_README_8build.html#cmq", null ],
[ "Building on Windows (Visual Studio)", "md_README_8build.html#cmw", null ],
[ "Building on Windows (MinGW)", "md_README_8build.html#cmwmgw", null ],
[ "Building on mbed3", "md_README_8build.html#mbed3", null ],
[ "Setting compile options", "md_README_8build.html#cmco", [
[ "Command line", "md_README_8build.html#cmcocl", null ],
[ "Unix GUI", "md_README_8build.html#cmcoug", null ],
[ "Windows GUI", "md_README_8build.html#cmcowg", null ]
2016-07-13 08:14:57 +08:00
] ],
2016-11-14 18:12:31 +08:00
[ "wolfSSL/CyaSSL replacement for OpenSSL", "md_README_8build.html#wolf", null ],
[ "Compiling libwebsockets with wolfSSL", "md_README_8build.html#wolf1", null ],
[ "Compiling libwebsockets with CyaSSL", "md_README_8build.html#cya", null ],
[ "Building plugins outside of lws itself", "md_README_8build.html#extplugins", null ],
[ "Reproducing HTTP2.0 tests", "md_README_8build.html#http2rp", null ],
[ "Cross compiling", "md_README_8build.html#cross", null ],
[ "Memory efficiency", "md_README_8build.html#mem", null ]
2016-07-13 08:14:57 +08:00
] ],
2016-11-14 18:12:31 +08:00
[ "Debugging problems", "md_README_8problems.html", null ],
[ "Notes about lwsws", "md_README_8lwsws.html", [
[ "Libwebsockets Web Server", "md_README_8lwsws.html#lwsws", null ],
[ "Build", "md_README_8lwsws.html#lwswsb", null ],
[ "Lwsws Configuration", "md_README_8lwsws.html#lwswsc", null ],
[ "Other Global Options", "md_README_8lwsws.html#lwsogo", null ],
[ "Lwsws Vhosts", "md_README_8lwsws.html#lwswsv", null ],
[ "Lwsws Vhost name and port sharing", "md_README_8lwsws.html#lwswsvn", null ],
[ "Lwsws Protocols", "md_README_8lwsws.html#lwswspr", null ],
[ "Lwsws Other vhost options", "md_README_8lwsws.html#lwswsovo", null ],
[ "Lwsws Mounts", "md_README_8lwsws.html#lwswsm", null ],
[ "Lwsws Other mount options", "md_README_8lwsws.html#lwswsomo", null ],
[ "Lwsws Plugins", "md_README_8lwsws.html#lwswspl", null ],
[ "Additional plugin search paths", "md_README_8lwsws.html#lwswsplaplp", null ],
[ "lws-server-status plugin", "md_README_8lwsws.html#lwswsssp", null ],
[ "Lwsws Integration with Systemd", "md_README_8lwsws.html#lwswssysd", null ],
[ "Lwsws Integration with logrotate", "md_README_8lwsws.html#lwswslr", null ]
2016-07-13 08:14:57 +08:00
] ],
2016-11-14 18:12:31 +08:00
[ "Notes about coding with lws", "md_README_8coding.html", [
[ "Daemonization", "md_README_8coding.html#dae", null ],
[ "Maximum number of connections", "md_README_8coding.html#conns", null ],
[ "Libwebsockets is singlethreaded", "md_README_8coding.html#evtloop", null ],
[ "Only send data when socket writeable", "md_README_8coding.html#writeable", null ],
[ "Do not rely on only your own WRITEABLE requests appearing", "md_README_8coding.html#otherwr", null ],
[ "Closing connections from the user side", "md_README_8coding.html#closing", null ],
[ "Fragmented messages", "md_README_8coding.html#frags", null ],
[ "Debug Logging", "md_README_8coding.html#debuglog", null ],
[ "External Polling Loop support", "md_README_8coding.html#extpoll", null ],
[ "Using with in c++ apps", "md_README_8coding.html#cpp", null ],
[ "Availability of header information", "md_README_8coding.html#headerinfo", null ],
[ "TCP Keepalive", "md_README_8coding.html#ka", null ],
[ "Optimizing SSL connections", "md_README_8coding.html#sslopt", null ],
[ "Async nature of client connections", "md_README_8coding.html#clientasync", null ],
[ "Lws platform-independent file access apis", "md_README_8coding.html#fileapi", null ],
[ "ECDH Support", "md_README_8coding.html#ecdh", null ],
[ "SMP / Multithreaded service", "md_README_8coding.html#smp", null ],
[ "Libev / Libuv support", "md_README_8coding.html#libevuv", null ],
[ "Extension option control from user code", "md_README_8coding.html#extopts", null ],
[ "Client connections as HTTP[S] rather than WS[S]", "md_README_8coding.html#httpsclient", null ],
[ "Using lws vhosts", "md_README_8coding.html#vhosts", null ],
[ "How lws matches hostname or SNI to a vhost", "md_README_8coding.html#sni", null ],
[ "Using lws mounts on a vhost", "md_README_8coding.html#mounts", null ],
[ "Operation of LWSMPRO_CALLBACK mounts", "md_README_8coding.html#mountcallback", null ],
[ "Dimming webpage when connection lost", "md_README_8coding.html#dim", null ]
2016-07-13 08:14:57 +08:00
] ],
2016-11-14 18:12:31 +08:00
[ "Notes about generic-sessions Plugin", "md_README_8generic-sessions.html", [
[ "Enabling lwsgs for build", "md_README_8generic-sessions.html#gseb", null ],
[ "lwsgs Introduction", "md_README_8generic-sessions.html#gsi", null ],
[ "Lwsgs Integration to HTML", "md_README_8generic-sessions.html#gsin", null ],
[ "Lwsgs Overall Flow@", "md_README_8generic-sessions.html#gsof", null ],
[ "Lwsgs Configuration", "md_README_8generic-sessions.html#gsconf", null ],
[ "Lwsgs Password Confounder", "md_README_8generic-sessions.html#gspwc", null ],
[ "Lwsgs Preparing the db directory", "md_README_8generic-sessions.html#gsprep", null ],
[ "Lwsgs Email configuration", "md_README_8generic-sessions.html#gsrmail", null ],
[ "Lwsgs Integration with another protocol", "md_README_8generic-sessions.html#gsap", null ]
2016-07-13 08:14:57 +08:00
] ],
2016-11-14 18:12:31 +08:00
[ "Notes about generic-table", "md_README_8generic-table.html", [
[ "What is generic-table?", "md_README_8generic-table.html#gtint", null ],
[ "Enabling for build", "md_README_8generic-table.html#gteb", null ],
[ "Integrating with your html", "md_README_8generic-table.html#gtinth", null ],
[ "Lwsgt constructor", "md_README_8generic-table.html#gtc", null ],
[ "Lwsgt click handling function", "md_README_8generic-table.html#gtclick", null ],
[ "Generic-table JSON", "md_README_8generic-table.html#gtgj", null ],
[ "Setting up protocol-lws-table-dirlisting", "md_README_8generic-table.html#gtdirl", null ]
2016-06-26 06:29:20 +08:00
] ],
2016-11-14 18:12:31 +08:00
[ "Overview of lws test apps", "md_README_8test-apps.html", [
[ "Testing server with a browser", "md_README_8test-apps.html#tsb", null ],
[ "Running test server as a Daemon", "md_README_8test-apps.html#tsd", null ],
[ "Using SSL on the server side", "md_README_8test-apps.html#sssl", null ],
[ "Testing websocket client support", "md_README_8test-apps.html#wscl", null ],
[ "Choosing between test server variations", "md_README_8test-apps.html#choosingts", null ],
[ "Testing simple echo", "md_README_8test-apps.html#echo", null ],
[ "Testing SSL on the client side", "md_README_8test-apps.html#tassl", null ],
[ "Using the websocket ping utility", "md_README_8test-apps.html#taping", null ],
[ "fraggle Fraggle test app", "md_README_8test-apps.html#ta", null ],
[ "proxy support", "md_README_8test-apps.html#taproxy", null ],
[ "debug logging", "md_README_8test-apps.html#talog", null ],
[ "Websocket version supported", "md_README_8test-apps.html#ws13", null ],
[ "Latency Tracking", "md_README_8test-apps.html#latency", null ],
[ "Autobahn Test Suite", "md_README_8test-apps.html#autobahn", null ],
[ "Autobahn Test Notes", "md_README_8test-apps.html#autobahnnotes", null ]
2016-07-13 08:14:57 +08:00
] ],
[ "Deprecated List", "deprecated.html", null ],
[ "Modules", "modules.html", "modules" ],
[ "Data Structures", "annotated.html", [
[ "Data Structures", "annotated.html", "annotated_dup" ],
[ "Data Structure Index", "classes.html", null ],
[ "Class Hierarchy", "hierarchy.html", "hierarchy" ],
[ "Data Fields", "functions.html", [
[ "All", "functions.html", null ],
[ "Functions", "functions_func.html", null ],
[ "Variables", "functions_vars.html", null ]
] ]
] ],
[ "Files", null, [
[ "File List", "files.html", "files" ],
[ "Globals", "globals.html", [
[ "All", "globals.html", "globals_dup" ],
[ "Functions", "globals_func.html", null ],
[ "Typedefs", "globals_type.html", null ],
[ "Enumerations", "globals_enum.html", null ],
[ "Enumerator", "globals_eval.html", null ]
] ]
] ]
] ]
];
var NAVTREEINDEX =
[
"annotated.html",
2016-11-14 18:12:31 +08:00
"group__context-and-vhost.html#gga41c2d763f78cc248df3b9f8645dbd2a5a87a824b2e812f4c3e7f2c4a1ea4f8abd",
RFC7233 HTTP Ranges support for server This adds a serverside implementation of RFC7233 HTTP ranges. - LWS_WITH_RANGES is on by default at cmake - Accept-Ranges: bytes is added if LWS_WITH_RANGES is enabled - Both single ranges and multipart (2+) ranges are supported Test with curl like this Single $ $ curl -s -r 64-95 http://localhost:7681/libwebsockets.org-logo.png | hexdump -C 00000000 2e 01 fd 9d 12 27 00 00 00 19 74 45 58 74 53 6f |.....'....tEXtSo| 00000010 66 74 77 61 72 65 00 77 77 77 2e 69 6e 6b 73 63 |ftware.www.inksc| Multipart $ curl -s -r 64-95,128-143 http://localhost:7681/libwebsockets.org-logo.png | hexdump -C 00000000 5f 6c 77 73 0d 0a 43 6f 6e 74 65 6e 74 2d 54 79 |_lws..Content-Ty| 00000010 70 65 3a 20 69 6d 61 67 65 2f 70 6e 67 0d 0a 43 |pe: image/png..C| 00000020 6f 6e 74 65 6e 74 2d 52 61 6e 67 65 3a 20 62 79 |ontent-Range: by| 00000030 74 65 73 20 36 34 2d 39 35 2f 37 30 32 39 0d 0a |tes 64-95/7029..| 00000040 0d 0a 2e 01 fd 9d 12 27 00 00 00 19 74 45 58 74 |.......'....tEXt| 00000050 53 6f 66 74 77 61 72 65 00 77 77 77 2e 69 6e 6b |Software.www.ink| 00000060 73 63 5f 6c 77 73 0d 0a 43 6f 6e 74 65 6e 74 2d |sc_lws..Content-| 00000070 54 79 70 65 3a 20 69 6d 61 67 65 2f 70 6e 67 0d |Type: image/png.| 00000080 0a 43 6f 6e 74 65 6e 74 2d 52 61 6e 67 65 3a 20 |.Content-Range: | 00000090 62 79 74 65 73 20 31 32 38 2d 31 34 33 2f 37 30 |bytes 128-143/70| 000000a0 32 39 0d 0a 0d 0a 05 14 50 40 05 15 a5 c4 60 43 |29......P@....`C| 000000b0 91 c4 4a d4 c4 fc 5f 6c 77 73 0d 00 |..J..._lws..| The corresponding header part is like this 0x0030: 4854 5450 2f31 2e31 2032 3036 HTTP/1.1.206 0x0040: 200d 0a73 6572 7665 723a 206c 7773 7773 ...server:.lwsws 0x0050: 0d0a 636f 6e74 656e 742d 7479 7065 3a20 ..content-type:. 0x0060: 6d75 6c74 6970 6172 742f 6279 7465 7261 multipart/bytera 0x0070: 6e67 6573 0d0a 6163 6365 7074 2d72 616e nges..accept-ran 0x0080: 6765 733a 2062 7974 6573 0d0a 636f 6e74 ges:.bytes..cont 0x0090: 656e 742d 6c65 6e67 7468 3a20 3138 380d ent-length:.188. 0x00a0: 0a63 6163 6865 2d63 6f6e 7472 6f6c 3a20 .cache-control:. 0x00b0: 7072 6976 6174 6520 6d61 782d 6167 653a private.max-age: 0x00c0: 2036 300d 0a63 6f6e 6e65 6374 696f 6e3a .60..connection: 0x00d0: 206b 6565 702d 616c 6976 650d 0a65 7461 .keep-alive..eta 0x00e0: 673a 2030 3030 3031 4237 3535 3444 3433 g:.00001B7554D43 0x00f0: 3033 330d 0a0d 0a 033....
2016-12-12 13:36:25 +08:00
"group__service.html#ga53e3d0801dfda7960a7249dd559e68a2",
"group__wsstatus.html#gaccd9c59336efad8af0554f79cc5966fd",
RFC7233 HTTP Ranges support for server This adds a serverside implementation of RFC7233 HTTP ranges. - LWS_WITH_RANGES is on by default at cmake - Accept-Ranges: bytes is added if LWS_WITH_RANGES is enabled - Both single ranges and multipart (2+) ranges are supported Test with curl like this Single $ $ curl -s -r 64-95 http://localhost:7681/libwebsockets.org-logo.png | hexdump -C 00000000 2e 01 fd 9d 12 27 00 00 00 19 74 45 58 74 53 6f |.....'....tEXtSo| 00000010 66 74 77 61 72 65 00 77 77 77 2e 69 6e 6b 73 63 |ftware.www.inksc| Multipart $ curl -s -r 64-95,128-143 http://localhost:7681/libwebsockets.org-logo.png | hexdump -C 00000000 5f 6c 77 73 0d 0a 43 6f 6e 74 65 6e 74 2d 54 79 |_lws..Content-Ty| 00000010 70 65 3a 20 69 6d 61 67 65 2f 70 6e 67 0d 0a 43 |pe: image/png..C| 00000020 6f 6e 74 65 6e 74 2d 52 61 6e 67 65 3a 20 62 79 |ontent-Range: by| 00000030 74 65 73 20 36 34 2d 39 35 2f 37 30 32 39 0d 0a |tes 64-95/7029..| 00000040 0d 0a 2e 01 fd 9d 12 27 00 00 00 19 74 45 58 74 |.......'....tEXt| 00000050 53 6f 66 74 77 61 72 65 00 77 77 77 2e 69 6e 6b |Software.www.ink| 00000060 73 63 5f 6c 77 73 0d 0a 43 6f 6e 74 65 6e 74 2d |sc_lws..Content-| 00000070 54 79 70 65 3a 20 69 6d 61 67 65 2f 70 6e 67 0d |Type: image/png.| 00000080 0a 43 6f 6e 74 65 6e 74 2d 52 61 6e 67 65 3a 20 |.Content-Range: | 00000090 62 79 74 65 73 20 31 32 38 2d 31 34 33 2f 37 30 |bytes 128-143/70| 000000a0 32 39 0d 0a 0d 0a 05 14 50 40 05 15 a5 c4 60 43 |29......P@....`C| 000000b0 91 c4 4a d4 c4 fc 5f 6c 77 73 0d 00 |..J..._lws..| The corresponding header part is like this 0x0030: 4854 5450 2f31 2e31 2032 3036 HTTP/1.1.206 0x0040: 200d 0a73 6572 7665 723a 206c 7773 7773 ...server:.lwsws 0x0050: 0d0a 636f 6e74 656e 742d 7479 7065 3a20 ..content-type:. 0x0060: 6d75 6c74 6970 6172 742f 6279 7465 7261 multipart/bytera 0x0070: 6e67 6573 0d0a 6163 6365 7074 2d72 616e nges..accept-ran 0x0080: 6765 733a 2062 7974 6573 0d0a 636f 6e74 ges:.bytes..cont 0x0090: 656e 742d 6c65 6e67 7468 3a20 3138 380d ent-length:.188. 0x00a0: 0a63 6163 6865 2d63 6f6e 7472 6f6c 3a20 .cache-control:. 0x00b0: 7072 6976 6174 6520 6d61 782d 6167 653a private.max-age: 0x00c0: 2036 300d 0a63 6f6e 6e65 6374 696f 6e3a .60..connection: 0x00d0: 206b 6565 702d 616c 6976 650d 0a65 7461 .keep-alive..eta 0x00e0: 673a 2030 3030 3031 4237 3535 3444 3433 g:.00001B7554D43 0x00f0: 3033 330d 0a0d 0a 033....
2016-12-12 13:36:25 +08:00
"structlws__http__mount.html#a4283e30ea89d27ae7d061ad760d1d146"
];
var SYNCONMSG = 'click to disable panel synchronisation';
var SYNCOFFMSG = 'click to enable panel synchronisation';