piermesh/docs/Splash/serve.md

57 lines
1.2 KiB
Markdown

<a id="serve-web-ui-server"></a>
# serve: Web UI server
### *class* Splash.serve.Server(transceiver, catch, onodeID, network, cryptographyInfo, remoteCatchIndex, cache)
Web server that serves the web ui and provides web to node communication
[🔗 Source](https://git.utopic.work/PierMesh/piermesh/src/branch/main/src/Sponge/serve.py)
#### transceiver
Reference to our Transceiver.Transceiver.Transceiver instance
* **Type:**
[Transceiver.Transceiver.Transceiver](/PierMesh/piermesh/src/branch/main/docs/Transceiver/Transceiver.md#Transceiver.Transceiver.Transceiver)
#### network
Reference to our Siph.Network.Network
* **Type:**
Siph.Network.Network
#### nodeID
String converted PierMesh node ID
* **Type:**
str
#### peerIDs
Map of peer IDs to Websocket sessions
* **Type:**
dict
#### app
Microdot server instance
#### catch
Reference to our Catch Cache instance to pull from for serving Catchs
* **Type:**
[Daisy.Catch.Catch](/PierMesh/piermesh/src/branch/main/docs/Daisy/Catch.md#Daisy.Catch.Catch)
#### *async* getPSKs()
Get all PSKs for display
#### *async* sendToPeer(peerID: str, data: str, target: str)
Send data to Websocket of peer with peerID