package
0.1.6
Repository: https://github.com/supergiant-hq/xnet.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

P2P (Peer-to-Peer) Network

This package provides a framework to create a P2P Network

Modules

  • Broker
    • Server
      • Manages connections between Broker Clients.
      • Right now, a network can only have one Broker Server.
      • This is by design as a Broker Server has the sole task of brokering between Clients. It does not act as a Relay.
    • Client
      • Standalone entity used to connect to other clients (peers).
  • Relay
    • When a P2P connection cannot be established, the clients can request route traffic through a relay.
    • There can be multiple relays in a P2P network. A client choses the one closest to it (by pinging) to relay it's connection.
    • A client can also use a predefined relay instead of dynamically choosing one closest to it.
  • Server
    • Used in Broker - Server
    • Helps in establishing P2P connections between clients.
  • Client
    • Used in Broker - Client
    • Manages P2P connections with other clients.

Examples

  • xTUNNEL - Tunnel TCP/UDP traffic between nodes