turn

Documentation

Overview

Package turn provides utilities to run a TURN server

Index

• Variables
• type TURN
  • func New(publicIP, realm, protocol string, port int) (*TURN, error)
  • func (t *TURN) Close() error
  • func (t *TURN) Run() error

Variables

var (
	ErrPublicIPEmpty       = errors.New("Public IP empty")
	ErrUnsupportedProtocol = errors.New("Protocol unsupported")
)

Types

type TURN

type TURN struct {
	PublicIP string
	Realm    string
	Port     int
	Protocol string
	// contains filtered or unexported fields
}

func New

func New(publicIP, realm, protocol string, port int) (*TURN, error)

New returns a new TURN instance or an error 'publicIP' is the public IP which can be contacted by users via the internet 'realm' is the realm this TURN server runs under, usually your domain, defaults to chapper.dev 'port' the port this TURN server listens on, defaults to 50554

func (*TURN) Close

func (t *TURN) Close() error

Close closes the TURN server

func (*TURN) Run

func (t *TURN) Run() error

Run runs the TURN server