campfire

type CampFire interface {
	// Accept returns a connection to a peer.
	Accept() (io.ReadWriteCloser, error)
	// Close closes the camp fire.
	Close() error
	// Errors returns a channel of errors.
	Errors() <-chan error
	// Ready returns a channel that is closed when the camp fire is ready.
	Ready() <-chan struct{}
}

type Location struct {
	// PSK is the pre-shared key.
	PSK []byte
	// LocalSecret is the computed local secret from the PSK.
	LocalSecret string
	// RemoteSecret is the computed remote secret from the PSK.
	RemoteSecret string
	// TURNServer is the selected TURN server.
	TURNServer string
	// ExpiresAt is the time at which the campfire expires.
	ExpiresAt time.Time
}

type Message struct {
	// Type is the type of message.
	Type MessageType
	// Candidate is an ICE candidate.
	Candidate string
	// SDP is an SDP offer or answer.
	SDP string
}

type MessageType int

type Options struct {
	// PSK is the pre-shared key.
	PSK []byte
	// TURNServers is an optional list of turn servers to use.
	TURNServers []string
}

type Stream interface {
	// PeerID returns the peer ID of the remote peer.
	PeerID() string
	// SendCandidate sends an ICE candidate on the stream.
	// This is a convenience method for sending a Candidate message.
	SendCandidate(candidate string) error
	// SendOffer sends an SDP offer on the stream.
	// This is a convenience method for sending an SDP message.
	SendOffer(offer webrtc.SessionDescription) error
	// Receive receives a message from the stream.
	Receive() (Message, error)
	// Close closes the stream.
	Close() error
}

type WaitingRoom interface {
	// Connetions returns a channel that receives new incoming connections.
	Connections() <-chan Stream
	// Peers returns a channel that receives new peers that have joined the
	// campfire. A new stream to the peer is opened for each peer and sent
	// on the channel.
	Peers() <-chan Stream
	// Location returns the location of the campfire.
	Location() *Location
	// Errors returns a channel that receives errors.
	Errors() <-chan error
	// Close closes the waiting room.
	Close() error
}