Add documentation for using Unix domain sockets. (#1954)
Some checks failed
test / ubuntu (push) Has been cancelled
test / macos (push) Has been cancelled
test / windows (push) Has been cancelled

* Add documentation for using unix domain sockets.

* Formatting
This commit is contained in:
Andrew McDaniel 2024-10-03 10:53:25 -04:00 committed by GitHub
parent 10d68cff50
commit 131bc6c674
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -843,6 +843,23 @@ Use `poll` instead of `select`
`select` system call is used as default since it's more widely supported. If you want to let cpp-httplib use `poll` instead, you can do so with `CPPHTTPLIB_USE_POLL`.
Unix Domain Socket Support
--------------------------
Unix Domain Socket support is available on Linux and macOS.
```c++
// Server
httplib::Server svr("./my-socket.sock");
svr.set_address_family(AF_UNIX).listen("./my-socket.sock", 80);
// Client
httplib::Client cli("./my-socket.sock");
cli.set_address_family(AF_UNIX);
```
"my-socket.sock" can be a relative path or an absolute path. You application must have the appropriate permissions for the path. You can also use an abstract socket address on Linux. To use an abstract socket address, prepend a null byte ('\x00') to the path.
Split httplib.h into .h and .cc
-------------------------------