Embedded/sc
1
0
Fork 0
mirror of https://github.com/tezc/sc.git synced 2025-01-28 07:03:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: Minor fixes

Browse Source
This commit is contained in:
Ozan Tezcan 2023-03-19 21:53:57 +03:00
parent 504f9ac09e
commit 1bb8296eca
8 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -29,30 +29,30 @@ Sanitizers : valgrind and clang/gcc sanitizers(address, undefined, thread)
### List
| Library | Description |
|--------------------------------|--------------------------------------------------------------------------------------------|
| **[array](array)** | Generic array/vector |
| **[buffer](buffer)** | Buffer for encoding/decoding variables, best fit for protocol/serialization implementations|
| **[condition](condition)** | Condition wrapper for Posix and Windows |
| **[crc32](crc32)** | Crc32c, uses crc32c CPU instruction if available |
| **[heap](heap)** | Min heap which can be used as max heap/priority queue as well |
| **[ini](ini)** | Ini parser |
| **[linked list](linked-list)** | Intrusive linked list |
| **[logger](logger)** | Logger |
| **[map](map)** | A high performance open addressing hashmap |
| **[memory map](memory-map)** | Mmap wrapper for Posix and Windows |
| **[mutex](mutex)** | Mutex wrapper for Posix and Windows |
| **[option](option)** | Cmdline argument parser. Very basic one |
| **[perf](perf)** | Benchmark utility to get performance counters info via perf_event_open() |
| **[queue](queue)** | Generic queue which can be used as dequeue/stack/list as well |
| **[sc](sc)** | Utility functions |
| **[signal](signal)** | Signal safe snprintf & Signal handler (handling CTRL+C, printing backtrace on crash etc) |
| **[socket](socket)** | Pipe / tcp sockets(also unix domain sockets) /Epoll/Kqueue/WSAPoll for Posix and Windows |
| **[string](string)** | Length prefixed, null terminated C strings. |
| **[thread](thread)** | Thread wrapper for Posix and Windows. |
| **[time](time)** | Time and sleep functions for Posix and Windows |
| **[timer](timer)** | Hashed timing wheel implementation with fast poll / cancel ops |
| **[uri](uri)** | A basic uri parser |
| Library | Description |
|--------------------------------|---------------------------------------------------------------------------------------------|
| **[array](array)** | Generic array/vector |
| **[buffer](buffer)** | Buffer for encoding/decoding variables, best fit for protocol/serialization implementations |
| **[condition](condition)** | Condition wrapper for Posix and Windows |
| **[crc32](crc32)** | Crc32c, uses crc32c CPU instruction if available |
| **[heap](heap)** | Min heap which can be used as max heap/priority queue as well |
| **[ini](ini)** | Ini parser |
| **[linked list](linked-list)** | Intrusive linked list |
| **[logger](logger)** | Logger |
| **[map](map)** | A high performance open addressing hashmap |
| **[memory map](memory-map)** | Mmap wrapper for Posix and Windows |
| **[mutex](mutex)** | Mutex wrapper for Posix and Windows |
| **[option](option)** | Cmdline argument parser. Very basic one |
| **[perf](perf)** | Benchmark utility to get performance counters info via perf_event_open() |
| **[queue](queue)** | Generic queue which can be used as dequeue/stack/list as well |
| **[sc](sc)** | Utility functions |
| **[signal](signal)** | Signal safe snprintf & Signal handler (handling CTRL+C, printing backtrace on crash etc) |
| **[socket](socket)** | Pipe / tcp sockets(also unix domain sockets) /Epoll/Kqueue/WSAPoll for Posix and Windows |
| **[string](string)** | Length prefixed, null terminated C strings. |
| **[thread](thread)** | Thread wrapper for Posix and Windows. |
| **[time](time)** | Time and sleep functions for Posix and Windows |
| **[timer](timer)** | Hashed timing wheel implementation with fast poll / cancel ops |
| **[uri](uri)** | A basic uri parser |
-

2
buffer/README.md
View File

@ -3,7 +3,7 @@
### Overview
- Buffer implementation for serializing data/protocol implementation.
- Works with binary data, 8/16/32/64 bit integers, double and strings.
- Works with binary data, 8/16/32/64-bit integers, double and strings.
- Strings are kept length prefixed and null ended. So, no need to copy string
when you are reading, you just get the pointer. This is useful to avoid memory
allocation overhead.

2
linked-list/README.md
View File

@ -4,7 +4,7 @@
- Intrusive doubly linked list.
- Basically, same as adding next and prev pointers to your structs.
- Add/remove from head/tail is possible so it can be used as list, stack,
- Add/remove from head/tail is possible, so it can be used as list, stack,
queue, dequeue etc.
### Usage

2
map/README.md
View File

@ -3,7 +3,7 @@
### Overview
- Open addressing hashmap with linear probing.
- Requires postfix naming, e.g sc_map_str, sc_map_int. It's ugly but necessary
- Requires postfix naming, e.g. sc_map_str, sc_map_int. It's ugly but necessary
for better performance.
- Comes with predefined key value pairs :

2
queue/README.md
View File

@ -3,7 +3,7 @@
### Overview
- Queue implementation which grows when you add elements.
- Add/remove from head/tail is possible so it can be used as list, stack,
- Add/remove from head/tail is possible, so it can be used as list, stack,
queue, dequeue etc.
- It comes with predefined types, check out at the end of sc_queue.h, you can
add there (sc_queue_def) if you need more.

4
signal/README.md
View File

@ -5,8 +5,8 @@
- Signal handling to handle shutdown and fatal signals.
- Also provides signal safe snprintf/vsnprintf.
- On shutdown signal, writes 1 byte to a fd which is set by user, so your app
can shutdown properly.
- Double shutdown signal handling: e.g user presses CTRL+C twice, exits without
can shut down properly.
- Double shutdown signal handling: e.g. user presses CTRL+C twice, exits without
waiting graceful shutdown.
- Fatal signal handling. Prints backtrace with program counter indicator. You
should compile with debug symbols or with -rdynamic for GCC.

10
socket/README.md
View File

@ -4,11 +4,11 @@
- Includes three implementations :
| Implementation | Description |
|-------------------|----------------------------------------------------------|
| sc_sock_xxx | TCP socket wrapper for blocking and nonblocking sockets |
| sc_sock_poll_xxx | Epoll / Kqueue / WSAPoll wrapper |
| sc_sock_pipe_xxx | Unix pipe() and an equivalent implementation for Windows.|
| Implementation | Description |
|------------------|-----------------------------------------------------------|
| sc_sock_xxx | TCP socket wrapper for blocking and nonblocking sockets |
| sc_sock_poll_xxx | Epoll / Kqueue / WSAPoll wrapper |
| sc_sock_pipe_xxx | Unix pipe() and an equivalent implementation for Windows. |
- Works for IPv4, IPv6 and Unix domain sockets. (~ Windows 10 2018 added Unix

2
uri/README.md
View File

@ -2,7 +2,7 @@
### Overview
- URI parser but not a full featured one. It just splits parts of an url.
- URI parser but not a full-featured one. It just splits parts of an url.
- Internally, it does a single allocation but each part is represented as null
ended string, so it plays nicely with C string functions.