piermesh/docs/readme.md

PierMesh documentation

Contents:

• run: PierMesh service runner
  • Node
    • Node.toLog
    • Node.actions
    • Node.todo
    • Node.network
    • Node.catch
    • Node.cache
    • Node.nodeInfo
    • Node.onodeID
    • Node.oTransceiver
    • Node.processed
    • Node.proc
    • Node.mTasks
    • Node.action_initNodeDH()
    • Node.action_keyDeriveDH()
    • Node.action_map()
    • Node.action_sendCatch()
    • Node.action_sendToPeer()
    • Node.cLog()
    • Node.spongeListen()
• ui: TUI application
  • TUI
    • TUI.visibleLogo
    • TUI.nodeOb
    • TUI.done
    • TUI.CSS_PATH
    • TUI.action_quitFull()
    • TUI.action_toggleFullscreen()
    • TUI.compose()
    • TUI.do_set_cpu_percent()
    • TUI.do_set_mem()
    • TUI.do_write_line()
    • TUI.on_mount()
• Network: Network map representation
  • Network
    • Network.omap
    • Network.imap
    • Network.emaps
    • Network.lookup
    • Network.addLookup()
    • Network.addie()
    • Network.addin()
    • Network.addoe()
    • Network.addon()
    • Network.doLookup()
    • Network.export()
      • Network.path
    • Network.getRoute()
    • Network.mimport()
    • Network.render()
• hopper: Small internet interop utilities
  • get()
  • post()
• Daisy based cache
  • Cache
    • Cache.create()
    • Cache.get()
    • Cache.refresh()
    • Cache.search()
• Daisy Catch cache
  • Catch
    • Catch.get()
    • Catch.sget()
• Daisy
  • Daisy
    • Daisy.filepath
    • Daisy.msg
    • Daisy.get()
    • Daisy.read()
    • Daisy.sublist()
    • Daisy.write()
• Soil: Daisy signal management
  • Compound
    • Compound.on_any_event()
• Store: Daisy key value store
  • Store
    • Store.getRecord()
    • Store.update()
• WhaleSong: Diffie hellman ephemeral Fernet based encryption
  • DHEFern
    • DHEFern.cLog
    • DHEFern.loadedParams
    • DHEFern.loadedKeys
    • DHEFern.nodeNickname
    • DHEFern.cache
    • DHEFern.publicKey
    • DHEFern.privateKey
    • DHEFern.checkInMem()
    • DHEFern.decrypt()
    • DHEFern.encrypt()
    • DHEFern.genKeyPair()
    • DHEFern.genParams()
    • DHEFern.getParamsBytes()
    • DHEFern.getRecord()
    • DHEFern.getSalt()
    • DHEFern.initStore()
    • DHEFern.keyDerive()
    • DHEFern.loadParamBytes()
    • DHEFern.loadRecordToMem()
• base: Primary filtering functionality
  • Filter
    • Filter.cache
    • Filter.mCheck()
    • Filter.protoMap()
    • Filter.protoRoute()
    • Filter.selfCheck()
    • Filter.sieve()
• Protocols
  • bubble.filter()
  • catch.filter()
  • cryptography.filter()
  • map.filter()
• Header packet: Metadata packet
  • Header
    • Header.sender
    • Header.senderDisplayName
    • Header.recipient
    • Header.recipientNode
    • Header.subpacket
    • Header.wantFullResponse
    • Header.pAction
    • Header.dump()
    • Header.usePreset()
• Packet: Base packet
  • Packet
    • Packet.data
    • Packet.packetsID
    • Packet.packetNumber
    • Packet.packetCount
    • Packet.packetsClass
    • Packet.dump()
    • Packet.parsePayload()
• SinglePacket: Singular packet messages for very low data applications
  • SinglePacket
• SubMessage: Additional data for larger messages
  • SubMessage
• SubPacket: Packets for submessages
  • SubPacket
• Transceiver: Layer 0 data transceiving
  • Transceiver
    • Transceiver.cLog
    • Transceiver.cryptographyInfo
    • Transceiver.filter
    • Transceiver.tcache
    • Transceiver.tcatch
    • Transceiver.notConnected
    • Transceiver.acks
    • Transceiver.onodeID
    • Transceiver.messages
    • Transceiver.addPackets()
    • Transceiver.announce()
    • Transceiver.awaitFullResponse()
    • Transceiver.awaitResponse()
    • Transceiver.initNodeDH()
    • Transceiver.onConnection()
    • Transceiver.onReceive()
    • Transceiver.progressCheck()
    • Transceiver.responseCheck()
    • Transceiver.send()
    • Transceiver.sendAnnounce()
• serve: Web UI server
  • Server
    • Server.cLog
    • Server.transmitter
    • Server.network
    • Server.nodeID
    • Server.peerIDs
    • Server.app
    • Server.catch
    • Server.sendToPeer()