diff options
| author |  vnugent <public@vaughnnugent.com> | 2023-01-08 16:01:54 -0500 |
|---|---|---|
| committer | vnugent <public@vaughnnugent.com> | 2023-01-08 16:01:54 -0500 |
| commit | de94d788e9a47432a7630a8215896b8dd3628599 (patch) | |
| tree | 666dec06eef861d101cb6948aff52a3d354c8d73 /Net.Messaging.FBM/src/Server/readme.md | |
| parent | be6dc557a3b819248b014992eb96c1cb21f8112b (diff) | |
Reorder + analyzer cleanup
Diffstat (limited to 'Net.Messaging.FBM/src/Server/readme.md')
| -rw-r--r-- | Net.Messaging.FBM/src/Server/readme.md | 35 |
1 files changed, 0 insertions, 35 deletions
diff --git a/Net.Messaging.FBM/src/Server/readme.md b/Net.Messaging.FBM/src/Server/readme.md deleted file mode 100644 index 489e58f..0000000 --- a/Net.Messaging.FBM/src/Server/readme.md +++ /dev/null @@ -1,35 +0,0 @@ -# VNLib.Net.Messaging.FBM.Server - -Fixed Buffer Messaging Protocol server library. High performance statful messaging -protocol built on top of HTTP web-sockets. Low/no allocation, completely asynchronous -while providing a TPL API. This library provides a simple asynchronous request/response -architecture to web-sockets. This was initially designed to provide an alternative to -complete HTTP request/response overhead, but allow a simple control flow for work -across a network. - -Messages consist of a 4 byte message id, a collection of headers, and a message body. -The first 4 bytes of a message is the ID (for normal messages a signed integer greater than 0), -0 is reserved for error conditions, and negative numbers are reserved for internal -messages. Headers are identified by a single byte, followed by a variable length UTF8 -encoded character sequence, followed by a termination of 0xFF, 0xF1 (may change). - -### Message structure - 4 byte positive (signed 32-bit integer) message id - 2 byte termination - 1 byte header-id - variable length UTF8 value - 2 byte termination - -- other headers -- - 2 byte termination (extra termination, ie: empty header) - variable length payload - (end of message is the end of the payload) - - -XML Documentation is or will be provided for almost all public exports. APIs are intended to -be sensibly public and immutable to allow for easy extensability (via extension methods). I -often use extension libraries to provide additional functionality. (See cache library) - -This library is likely a niche use case, and is probably not for everyone. Unless you care -about reasonably efficient high frequency request/response messaging, this probably isnt -for you. This library provides a reasonable building block for distributed lock mechanisms -and small data caching.
\ No newline at end of file |