peernet

Documentation

Overview

Copyright (c) Microsoft Corporation. Licensed under the MIT License.

Index

• type Network
  • func New(h host.Host) (Network, error)

Types

type Network

type Network interface {
	// DefaultTLSConfig creates a default TLS config.
	// This config should not require client certificate verification.
	DefaultTLSConfig() *tls.Config

	// RoundTripperFor returns an HTTP round tripper which authenticates the given peer.
	// If pid is empty, the round tripper should work for any peer.
	RoundTripperFor(pid peer.ID) http.RoundTripper

	// HTTPClientFor returns an HTTP client which authenticates the given peer.
	// If pid is empty, the client should work for any peer.
	HTTPClientFor(pid peer.ID) *http.Client
}

Network provides the transport and HTTP clients for communicating with peers.

func New

func New(h host.Host) (Network, error)

New creates a new network interface for communicating with peers.