turn

Documentation

Overview

Package turn contains the STUN/TURN server.

Index

• type Options
• type Server
  • func NewServer(o *Options) (*Server, error)
  • func (s *Server) Close() error
  • func (s *Server) ListenPort() int

Types

type Options

type Options struct {
	// PublicIP is the public IP address of the TURN server. This is used for relaying.
	PublicIP string
	// RelayAddressUDP is the binding address the TURN server uses for request handling and STUN relays.
	// Defaults to 0.0.0.0.
	RelayAddressUDP string
	// ListenUDP is the address the TURN server listens on for UDP requests.
	ListenUDP string
	// Realm is the realm used for authentication.
	Realm string
	// PortRange is the range of ports the TURN server will use for relaying.
	PortRange string
}

Options contains the options for the TURN server.

type Server

type Server struct {
	*turn.Server
	// contains filtered or unexported fields
}

Server is a TURN server.

func NewServer

func NewServer(o *Options) (*Server, error)

NewServer creates and starts a new TURN server.

func (*Server) Close

func (s *Server) Close() error

func (*Server) ListenPort

func (s *Server) ListenPort() int

ListenPort returns the UDP port the TURN server is listening on.