Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
babelouest committed Dec 31, 2022
1 parent 48da51e commit 79cfb56
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
- [Prepare the request](#prepare-the-request)
- [Built-in client extension permessage-deflate](#built-in-client-extension-permessage-deflate)
- [Open the websocket](#open-the-websocket)
- [Websocket status](#websocket-status-1)
- [Client Websocket status](#client-websocket-status)
- [Outgoing request functions](#outgoing-request-functions)
- [Send HTTP request API](#send-http-request-api)
- [Send SMTP request API](#send-http-request-api)
Expand Down Expand Up @@ -1744,9 +1744,9 @@ To close a websocket communication, you can do one of the following:
*Note - broken pipe*
In some cases, when the client websocket connection is secured via TLS. If the connection is already closed, or broken, a `SIGPIPE` signal can occur, leading to a program crash. To avoid this issue, you can handle `SIGPIPE` signals using sigaction.
In some cases, when the client websocket connection is secured via TLS. If the connection is already closed, or broken, a `SIGPIPE` signal can occur, leading to a program crash. To avoid this issue, you can handle `SIGPIPE` signals using `sigaction`.
The following code is a simple example where all SIGPIPE signals are simplky ignored:
The following code is a simple example where all SIGPIPE signals are simply ignored:
```C
#include <signal.h>
Expand All @@ -1755,7 +1755,7 @@ sigaction(SIGPIPE, &(struct sigaction){SIG_IGN}, NULL);

Check the `sigaction` documentation for more details.

### Websocket status <a name="websocket-status-1"></a>
### Client Websocket status <a name="client-websocket-status"></a>

The following functions allow the application to know if the the websocket is still open, to enforce closing the websocket or to wait until the websocket is closed by the server:

Expand Down

0 comments on commit 79cfb56

Please sign in to comment.