diff options
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | websocksy.h | 6 |
2 files changed, 6 insertions, 6 deletions
@@ -144,8 +144,8 @@ The integrated default backend takes the following configuration arguments: This repository comes with some plugins already included, in addition to the built-in backend and framing functions. Documentation for these resides in the `plugins/` directory. - * [backend\_file](plugins/backend_file.md) - * [framing\_fixedlength](plugins/framing_fixedlength.md) +* [backend\_file](plugins/backend_file.md) +* [framing\_fixedlength](plugins/framing_fixedlength.md) # Building @@ -211,7 +211,7 @@ peer). To select the frame type, set the `opcode` argument. The default frame ty The `framing_data` pointer can be used to store data on a per-connection basis. If the pointer is nonzero when the connection is terminated, the function will be called with a NULL `data` pointer -as an indication the any allocation within `framing_data` is to be freed. +as an indication that any allocation within `framing_data` is to be freed. An example plugin providing the [`fixedlength` framing function](plugins/framing_fixedlength.c) is provided in the repository. Additions to the `websocksy` plugin library are welcome! diff --git a/websocksy.h b/websocksy.h index a97784b..64dcc8d 100644 --- a/websocksy.h +++ b/websocksy.h @@ -79,11 +79,11 @@ typedef struct /*_ws_http_header*/ { * * separator: Separate binary frames on a sequence of bytes * * newline: Forward text frames separated by newlines (\r\n) * - * The separator function is called once for every succesful read from the peer socket and called + * The separator function is called once for every successful read from the peer socket and called * again when it indicates a frame boundary but there is still data in the buffer. - * The `framing_data` pointer can be used to store protocol-dependent data on a per-connection basis. + * The `framing_data` pointer can be used to store data on a per-connection basis. * If the pointer is nonzero when the connection is terminated, the function will be called with a - * NULL `data` pointer as an indication the any allocation within `framing_data` is to be freed. + * NULL `data` pointer as an indication that any allocation within `framing_data` is to be freed. * The return value is the number of bytes to be sent to the peer. */ typedef int64_t (*ws_framing)(uint8_t* data, size_t length, size_t last_read, ws_operation* opcode, void** framing_data, const char* config); |