net

type BroadcastChannel interface {
	// Name returns the name of this broadcast channel.
	Name() string
	// Send function publishes a message to the channel. Message needs to
	// conform to the marshalling interface. Message will be periodically
	// retransmitted by the channel for the lifetime of the provided context
	// according to the default StandardRetransmissionStrategy. Retransmission
	// strategy can be set through the `retransmissionStrategy` vararg. If the
	// vararg is given more than one value, the first value is used as the
	// valid strategy.
	Send(
		ctx context.Context,
		message TaggedMarshaler,
		retransmissionStrategy ...RetransmissionStrategy,
	) error
	// Recv installs a message handler that will receive messages from the
	// channel for the entire lifetime of the provided context.
	// When the context is done, handler is automatically unregistered and
	// receives no more messages. Already received message retransmissions are
	// filtered out before calling the handler.
	Recv(ctx context.Context, handler func(m Message))
	// SetUnmarshaler set an unmarshaler that will unmarshal a given
	// type to a concrete object that can be passed to and understood by any
	// registered message handling functions. The unmarshaler should be a
	// function that returns a fresh object of type proto.TaggedUnmarshaler,
	// ready to read in the bytes for an object marked as tpe.
	//
	// The string type associated with the unmarshaler is the result of calling
	// Type() on a raw unmarshaler.
	SetUnmarshaler(unmarshaler func() TaggedUnmarshaler)
	// SetFilter registers a broadcast channel filter which will be used
	// to determine if given broadcast channel message should be processed
	// by the receivers.
	SetFilter(filter BroadcastChannelFilter) error
}

type BroadcastChannelFilter func(*operator.PublicKey) bool

type ConnectionManager interface {
	ConnectedPeers() []string
	ConnectedPeersAddrInfo() map[string][]string
	GetPeerPublicKey(connectedPeer string) (*operator.PublicKey, error)
	DisconnectPeer(connectedPeer string)

	// AddrStrings returns all listen addresses of the provider.
	AddrStrings() []string

	IsConnected(address string) bool
}

type Firewall interface {

	// Validate takes the remote peer public key and executes all the checks
	// needed to decide whether the connection with the remote peer can be
	// approved.
	// If expectations are not met, this function should return an error
	// describing what is wrong.
	Validate(remotePeerPublicKey *operator.PublicKey) error
}

type Message interface {
	TransportSenderID() TransportIdentifier
	SenderPublicKey() []byte

	Payload() interface{}

	Type() string
	Seqno() uint64
}

type Provider interface {
	// ID returns provider identifier.
	ID() TransportIdentifier
	// Type gives an information about provider type.
	Type() string

	// BroadcastChannelFor provides a broadcast channel instance for given
	// channel name.
	BroadcastChannelFor(name string) (BroadcastChannel, error)

	// ConnectionManager returns the connection manager used by the provider.
	ConnectionManager() ConnectionManager

	// CreateTransportIdentifier creates a transport identifier based on the
	// provided operator public key.
	CreateTransportIdentifier(
		operatorPublicKey *operator.PublicKey,
	) (TransportIdentifier, error)

	// BroadcastChannelForwarderFor creates a message relay for given channel name.
	BroadcastChannelForwarderFor(name string)
}

type RetransmissionStrategy int

type TaggedMarshaler interface {
	pb.Marshaler
	Type() string
}

type TaggedUnmarshaler interface {
	pb.Unmarshaler
	Type() string
}

type TransportIdentifier interface {
	String() string
}