Skip to content

Added README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
royra wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# websocket_c
A partial implementation of the WebSocket protocol in C, designed for use in embedded systems

## Features:

1. Static memory usage at runtime - no `malloc`s.
2. Caller-provided memory for incoming packets.
3. Supports 30X redirect responses with relative or absolute URLs.
4. Custom HTTP headers (e.g, for authentication) may be provided in the connection request.
5. "Ping" message implementation for heartbeats/keepalive.

## Building

`cmake .`

`make`

### Tests

The included "main" will run some unit tests and connect to the URL provided at the command line.
If you don't have a websocket server to test with, see https://github.com/vi/websocat

### Customization

* If you're using a custom IP stack, replace gethostbyname and socket calls `read` and `write` with your platform's implementations.
* Remove or replace debug message calls `hex_dump` and `printf`.

## Input URL format

See the included "main" for examples of URLs accepted.