p2p

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

Documentation

Overview

Package p2p provides Peer-to-Peer network functionality

Index

• Constants
• type ConnectionMode
• type ConnectionState

Constants

const (
	TickerDuration    = time.Second * 15
	RequestTimeout    = time.Second * 5
	ConnectionTimeout = time.Second * 15
)

const (
	KEY_PORT          = "PORT"
	KEY_CONNECTION_ID = "CONNECTION_ID"

	KEY_STREAM_IGNORE  = "STREAM_IGNORE"
	KEY_STREAM_MESSAGE = "STREAM_MESSAGE"
)

const (
	TAG_RELAY = "relay"
)

Types

type ConnectionMode

type ConnectionMode string

const (
	ConnectionModeRelay ConnectionMode = "relay"
	ConnectionModeP2P   ConnectionMode = "p2p"
)

type ConnectionState

type ConnectionState int

const (
	ConnectionStateDisconnected ConnectionState = iota
	ConnectionStateConnecting
	ConnectionStateConnected
)