peermap

Documentation

Index

• Variables
• type Config
  • func ReadConfig(configFile string) (cfg Config, err error)
  • func (cfg *Config) Overwrite(cfg1 Config)
• type NetState
• type Peer
  • func (p *Peer) Close() error
  • func (p *Peer) Read(b []byte) (n int, err error)
  • func (p *Peer) Start()
  • func (p *Peer) String() string
  • func (p *Peer) Write(b []byte) (n int, err error)
• type PeerMap
  • func New(cfg Config) (*PeerMap, error)
  • func (pm *PeerMap) FindPeer(network string, filter func(url.Values) bool) ([]*Peer, error)
  • func (pm *PeerMap) HandleGetNetworkMeta(w http.ResponseWriter, r *http.Request)
  • func (pm *PeerMap) HandleOIDCAuthorize(w http.ResponseWriter, r *http.Request)
  • func (pm *PeerMap) HandlePeerPacketConnect(w http.ResponseWriter, r *http.Request)
  • func (pm *PeerMap) HandlePutNetworkMeta(w http.ResponseWriter, r *http.Request)
  • func (pm *PeerMap) HandleQueryNetworkPeers(w http.ResponseWriter, r *http.Request)
  • func (pm *PeerMap) HandleQueryNetworks(w http.ResponseWriter, r *http.Request)
  • func (pm *PeerMap) Load() error
  • func (pm *PeerMap) Save() error
  • func (pm *PeerMap) Serve(ctx context.Context) error
• type RateLimiter
• type RateLimiterConfig

Variables

var (
	ErrAddressAlreadyInuse  = peer.Error{Code: 4000, Msg: "the network address is already in use"}
	ErrNetworkSecretExpired = peer.Error{Code: 4030, Msg: "network secret is expired"}
)

Types

type Config

type Config struct {
	Listen               string                    `yaml:"listen"`
	SecretKey            string                    `yaml:"secret_key"`
	STUNs                []string                  `yaml:"stuns"`
	PublicNetwork        string                    `yaml:"public_network"`
	OIDCProviders        []oidc.OIDCProviderConfig `yaml:"oidc_providers"`
	RateLimiter          *RateLimiterConfig        `yaml:"rate_limiter,omitempty"`
	SecretRotationPeriod time.Duration             `yaml:"secret_rotation_period"`
	SecretValidityPeriod time.Duration             `yaml:"secret_validity_period"`
	StateFile            string                    `yaml:"state_file"`
}

func ReadConfig

func ReadConfig(configFile string) (cfg Config, err error)

func (*Config) Overwrite

func (cfg *Config) Overwrite(cfg1 Config)

type NetState

type NetState struct {
	ID         string    `json:"id"`
	Alias      string    `json:"alias"`
	Neighbors  []string  `json:"neighbors"`
	CreateTime time.Time `json:"createTime"`
	UpdateTime time.Time `json:"updateTime"`
}

type Peer

type Peer struct {
	// contains filtered or unexported fields
}

func (*Peer) Close

func (p *Peer) Close() error

func (*Peer) Read

func (p *Peer) Read(b []byte) (n int, err error)

func (*Peer) Start

func (p *Peer) Start()

func (*Peer) String

func (p *Peer) String() string

func (*Peer) Write

func (p *Peer) Write(b []byte) (n int, err error)

type PeerMap

type PeerMap struct {
	// contains filtered or unexported fields
}

func New

func New(cfg Config) (*PeerMap, error)

func (*PeerMap) FindPeer

func (pm *PeerMap) FindPeer(network string, filter func(url.Values) bool) ([]*Peer, error)

func (*PeerMap) HandleGetNetworkMeta

func (pm *PeerMap) HandleGetNetworkMeta(w http.ResponseWriter, r *http.Request)

func (*PeerMap) HandleOIDCAuthorize

func (pm *PeerMap) HandleOIDCAuthorize(w http.ResponseWriter, r *http.Request)

func (*PeerMap) HandlePeerPacketConnect

func (pm *PeerMap) HandlePeerPacketConnect(w http.ResponseWriter, r *http.Request)

func (*PeerMap) HandlePutNetworkMeta

func (pm *PeerMap) HandlePutNetworkMeta(w http.ResponseWriter, r *http.Request)

func (*PeerMap) HandleQueryNetworkPeers

func (pm *PeerMap) HandleQueryNetworkPeers(w http.ResponseWriter, r *http.Request)

func (*PeerMap) HandleQueryNetworks

func (pm *PeerMap) HandleQueryNetworks(w http.ResponseWriter, r *http.Request)

func (*PeerMap) Load

func (pm *PeerMap) Load() error

Load networks state

func (*PeerMap) Save

func (pm *PeerMap) Save() error

Save networks state

func (*PeerMap) Serve

func (pm *PeerMap) Serve(ctx context.Context) error

type RateLimiter

type RateLimiter struct {
	Limit int `yaml:"limit"`
	Burst int `yaml:"burst"`
}

type RateLimiterConfig

type RateLimiterConfig struct {
	Limit   int         `yaml:"limit"`
	Burst   int         `yaml:"burst"`
	Relay   RateLimiter `yaml:"relay"`
	StreamR RateLimiter `yaml:"stream_r"`
	StreamW RateLimiter `yaml:"stream_w"`
}