snowflake/client/lib/interfaces.go

package lib

import (
	"io"
	"net"
)

type Connector interface {
	Connect() error
}

type Resetter interface {
	Reset()
	WaitForReset()
}

// Interface for a single remote WebRTC peer.
// In the Client context, "Snowflake" refers to the remote browser proxy.
type Snowflake interface {
	io.ReadWriteCloser
	Resetter
	Connector
}

// Interface for catching Snowflakes. (aka the remote dialer)
type Tongue interface {
	Catch() (Snowflake, error)
}

// Interface for collecting some number of Snowflakes, for passing along
// ultimately to the SOCKS handler.
type SnowflakeCollector interface {

	// Add a Snowflake to the collection.
	// Implementation should decide how to connect and maintain the webRTCConn.
	Collect() (Snowflake, error)

	// Remove and return the most available Snowflake from the collection.
	Pop() Snowflake

	// Signal when the collector has stopped collecting.
	Melted() <-chan struct{}
}

// Interface to adapt to goptlib's SocksConn struct.
type SocksConnector interface {
	Grant(*net.TCPAddr) error
	Reject() error
	net.Conn
}

// Interface for the Snowflake's transport. (Typically just webrtc.DataChannel)
type SnowflakeDataChannel interface {
	io.Closer
	Send([]byte)
}