diff options
Diffstat (limited to 'v2/README.md')
| -rw-r--r-- | v2/README.md | 41 |
1 files changed, 26 insertions, 15 deletions
diff --git a/v2/README.md b/v2/README.md index 2f1e648..8ef1c6b 100644 --- a/v2/README.md +++ b/v2/README.md @@ -3,30 +3,27 @@ The idea is the following: - tcp server that you can send messages to - history upon connecting - date of messages sent -- authentication -- encrypted communication (tls?) - client for reading the messages and sending them at the same time - - rooms - encryption - authentication ## client -- wrapping messages -- prompt -- sending message +- [x] prompt +- [x] sending message - [x] bug: do not allow sending empty message +- [x] wrapping messages ## server -- log messages -- check if when sending and the client is offline (due to connection loss) what happens -- timeout on recv? +- [ ] log messages to file (save history) +- [ ] check if when sending and the client is offline (due to connection loss) what happens +- [ ] timeout on recv? ## common -- handle messages that are too large -- connect/disconnections messages -- use IP address / domain -- chat history +- [ ] handle messages that are too large +- [ ] connect/disconnections messages +- [ ] use IP address / domain +- [ ] chat history ## Protocol For now the protocol consists of sending Message type over the network, but in the future something @@ -37,9 +34,8 @@ more flexible might be required. Because it will make it easier to do things li - The null terminator must be sent with the string. - The text can be arbitrary length -- [ ] use char text[]; instead of char* -- todo: compression? +- [ ] compression ## Arena's 1. There is an arena for the messages' texts (`msgTextArena`) and an arena for the messages @@ -51,8 +47,23 @@ M.text = ArenaPush(msgTextArena, M.text_len); ``` Notice, that this depends on knowing the text's length before allocating the memory. +## Strings +- the length of a string (eg. `Message.text_len`) always **excludes** the null terminator unless stated explicitly +- the `#define *_LEN` are the max length **including** the null terminator ## Keybinds - `Ctrl+C` | `Ctrl+D`: quits - `Ctrl+U`: Erase input line - `Ctrl+W`: Erase word behind cursor + + +## Resources I used for building this +- source code I looked at: + - https://github.com/git-bruh/matrix-tui + - https://github.com/NikitaIvanovV/ictree + - https://github.com/termbox/termbox2 +- *mmap & gdb*: [Tsoding - "Why linux has this syscall?" ](https://youtu.be/sFYFuBzu9Ow?si=CX32IzFVA8OPDZvS) +- *pthreads*: [C for dummies](https://c-for-dummies.com/blog/?p=5365) +- *unicode and wide characters*: [C for dummies](https://c-for-dummies.com/blog/?p=2578) +- *sockets*: [Nir Lichtman - Making Minimalist Chat Server in C on Linux](https://www.youtube.com/watch?v=gGfTjKwLQxY) +- syscall manpages |