ftl

README

FTL Protocol

Reimplementation of the ftl-sdk published by Microsoft.

Not complete.

Documentation

Index

• Constants
• Variables
• type ChannelID
• type Conn
  • func Dial(targetHostname string, ftlPort int, channelID ChannelID, streamKey []byte) (conn *Conn, err error)
  • func (conn *Conn) Close() error
  • func (conn *Conn) Heartbeat() error
• type ConnConfig
• type FtlConnection
  • func (conn *FtlConnection) Close() error
  • func (conn *FtlConnection) ProcessCommand(command string) error
  • func (conn *FtlConnection) SendMessage(message string) error
• type FtlConnectionMetadata
• type Handler
• type Server
  • func NewServer(config *ServerConfig) *Server
  • func (srv *Server) Serve(listener net.Listener) error
• type ServerConfig
• type StreamID

Constants

const (
	DefaultPort  = 8084
	VersionMajor = 0
	VersionMinor = 2
)

const (
	MaxLineLenBytes  = 1024
	ReadWriteTimeout = time.Minute

	FTL_PAYLOAD_TYPE_SENDER_REPORT = 200
	FTL_PAYLOAD_TYPE_PING          = 250
)

Variables

var ErrClosed = errors.New("connection is closed")

var ErrConnectBeforeAuth = errors.New("control connection attempted command before successful authentication")

Connection Errors

var ErrInvalidHmacHash = errors.New("client provided invalid HMAC hash")

var ErrInvalidHmacHex = errors.New("client provided HMAC hash that could not be hex decoded")

var ErrMultipleConnect = errors.New("control connection attempted multiple CONNECT handshakes")

var ErrRead = errors.New("error during read")

var ErrUnexpectedArguments = errors.New("unexpected arguments")

var ErrWrite = errors.New("error during write")

Types

type ChannelID

type ChannelID uint32

Custom Types

type Conn

type Conn struct {
	AssignedMediaPort int

	MediaAddr *net.UDPAddr
	MediaConn *net.UDPConn
	// contains filtered or unexported fields
}

func Dial

func Dial(targetHostname string, ftlPort int, channelID ChannelID, streamKey []byte) (conn *Conn, err error)

func (*Conn) Close

func (conn *Conn) Close() error

func (*Conn) Heartbeat

func (conn *Conn) Heartbeat() error

type ConnConfig

type ConnConfig struct {
	Handler Handler
}

type FtlConnection

type FtlConnection struct {
	Metadata *FtlConnectionMetadata
	// contains filtered or unexported fields
}

func (*FtlConnection) Close

func (conn *FtlConnection) Close() error

func (*FtlConnection) ProcessCommand

func (conn *FtlConnection) ProcessCommand(command string) error

func (*FtlConnection) SendMessage

func (conn *FtlConnection) SendMessage(message string) error

type FtlConnectionMetadata

type FtlConnectionMetadata struct {
	ProtocolVersion string
	VendorName      string
	VendorVersion   string

	HasVideo         bool
	VideoCodec       string
	VideoHeight      uint
	VideoWidth       uint
	VideoPayloadType uint8
	VideoIngestSsrc  uint

	HasAudio         bool
	AudioCodec       string
	AudioPayloadType uint8
	AudioIngestSsrc  uint
}

type Handler

type Handler interface {
	GetHmacKey() (string, error)

	OnConnect(ChannelID) error
	OnPlay(FtlConnectionMetadata) error
	OnVideo(*rtp.Packet) error
	OnAudio(*rtp.Packet) error
	OnClose()
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(config *ServerConfig) *Server

func (*Server) Serve

func (srv *Server) Serve(listener net.Listener) error

type ServerConfig

type ServerConfig struct {
	Log logrus.FieldLogger
	// OnNewConnect is triggered on any connect to the FTL port, however it's not a
	// qualified FTL client until Handler.OnConnect is called.
	OnNewConnect func(net.Conn) (net.Conn, *ConnConfig)
}

type StreamID

type StreamID uint32