1
0
mirror of https://github.com/Ylianst/MeshAgent synced 2025-12-15 15:53:55 +00:00

Updated documentation

This commit is contained in:
Bryan Roe
2022-07-21 22:50:58 -07:00
parent fd93f62fe4
commit 687f79d8d1
4 changed files with 89 additions and 7 deletions

36
docs/Files.md Normal file
View File

@@ -0,0 +1,36 @@
## Project Files
### Abstract
This document highlights what each of the files in the project are, and what they do at a higher level.
### Microstack
The files in this folder makeup the native core of the Mesh Agent. It is what provides the underlying plumbing as well
as the main event loop. It is inherently single threaded using Asynchronous I/O throughout.
- **[ILibAsyncSocket](files/ILibAsyncSocket.md)**
Provides the underyling TCP socket functionality
- **ILibAsyncUDPSocket**
Provides the underlying UDP socket functionality
- **ILibAsyncServerSocket**
Provides the underlying TCP Server functionality
- ILibCrypto
- **ILibIPAddressMonitor**
Provides events for Network state changes
- **ILibMulticastSocket**
Provides UDP Multicast/Broadcast functionality
- **[ILibParsers](files/ILibParsers.md)**
Provides the core event loop implementation, as well as some helper methods
- **ILibProcessPipe**
Provides child process dispatching functionality
- **ILibRemoteLogging**
Provides a web based logging mechanism, for native components
- **ILibSimpleDataStore**
Provides a lightweight data store for use by the agent
- **ILibWebClient**
Provides a lightweight HTTP/1.1 client implementation
- **ILibWebRTC**
Provides lightweight WebRTC Data Channel implementation
- **ILibWebServer**
Provides a lightweight HTTP/1.1 server implementation
- **ILibWrapperWebRTC**
Provides a pseudo object oriented abstraction for WebRTC Data Channel Setup/Creation