net

package

v0.19.0 Latest Latest Go to latest Published: Sep 8, 2021 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nimona/go-nimona

Documentation ¶

Index ¶

Constants
func GetAddresses(protocol string, l net.Listener, includeLocal bool, includePrivate bool, ...) []string
func GetLocalPeerAddresses(port int, includeLocal bool, includePrivate bool, includeIPV6 bool) ([]string, error)
func Read(conn *Connection) (*object.Object, error)
func Write(o *object.Object, conn *Connection) error
type Connection
type ListenConfig
type Listener
type Network
- func New(peerKey crypto.PrivateKey) Network
type Transport

Constants ¶

View Source

const (
	// ErrAllAddressesFailed for when a peer cannot be dialed
	ErrAllAddressesFailed = errors.Error("all addresses failed to dial")
	// ErrNoAddresses for when a peer has no addresses
	ErrNoAddresses = errors.Error("no addresses")
	// ErrMissingSignature is when the signature is missing
	ErrMissingSignature = errors.Error("signature missing")
	// ErrAllAddressesBlocked all peer's addresses are currently blocked
	ErrAllAddressesBlocked = errors.Error("all addresses blocked")
	// ErrInvalidSignature signature is invalid
	ErrInvalidSignature = errors.Error("invalid signature")
	// ErrConnectionClosed connection is closed, will usually be merged with
	// an underlying error
	ErrConnectionClosed = errors.Error("connection closed")
)

Variables ¶

This section is empty.

Functions ¶

func GetAddresses ¶

func GetAddresses(
	protocol string,
	l net.Listener,
	includeLocal bool,
	includePrivate bool,
	includeIPV6 bool,
) []string

GetAddresses returns the addresses the transport is listening to

func GetLocalPeerAddresses ¶

func GetLocalPeerAddresses(
	port int,
	includeLocal bool,
	includePrivate bool,
	includeIPV6 bool,
) ([]string, error)

GetLocalPeerAddresses returns the addresses TCP can listen to on the local machine

func Read ¶

func Read(conn *Connection) (*object.Object, error)

func Write ¶

func Write(o *object.Object, conn *Connection) error

Types ¶

type Connection ¶

type Connection struct {
	ID string

	LocalPeerKey  crypto.PublicKey
	RemotePeerKey crypto.PublicKey
	IsIncoming    bool
	// contains filtered or unexported fields
}

func (*Connection) Close ¶

func (c *Connection) Close() error

func (*Connection) LocalAddr ¶

func (c *Connection) LocalAddr() string

func (*Connection) RemoteAddr ¶

func (c *Connection) RemoteAddr() string

type ListenConfig ¶

type ListenConfig struct {
	BindLocal   bool
	BindPrivate bool
	BindIPV6    bool
}

type Listener ¶

type Listener interface {
	Close() error
	Addresses() []string
}

type Network ¶

type Network interface {
	Dial(
		ctx context.Context,
		peer *peer.ConnectionInfo,
	) (*Connection, error)
	Listen(
		ctx context.Context,
		bindAddress string,
		listenConfig *ListenConfig,
	) (Listener, error)
	Accept() (*Connection, error)
	Addresses() []string
}

Network interface

func New ¶

func New(
	peerKey crypto.PrivateKey,
) Network

New creates a new p2p network

type Transport ¶

type Transport interface {
	Dial(
		ctx context.Context,
		address string,
	) (*Connection, error)
	Listen(
		ctx context.Context,
		bindAddress string,
		key crypto.PrivateKey,
	) (net.Listener, error)
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL