From 79cfb5683f3e3cf8f32d37d78f76e56ff5ef6941 Mon Sep 17 00:00:00 2001 From: Nicolas Mora Date: Fri, 30 Dec 2022 20:54:27 -0500 Subject: [PATCH] Update documentation --- API.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/API.md b/API.md index 50a6bd1d..ab2648db 100644 --- a/API.md +++ b/API.md @@ -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) @@ -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 @@ -1755,7 +1755,7 @@ sigaction(SIGPIPE, &(struct sigaction){SIG_IGN}, NULL); Check the `sigaction` documentation for more details. -### Websocket status +### Client Websocket status 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: