server

package

Go to main page

Versions in this module

v4

v4.2.7

Apr 14, 2024

v4.2.6

Feb 19, 2024

v4.2.5

Feb 19, 2024

v4.2.4

Feb 19, 2024

v4.2.3

Feb 19, 2024

v4.2.2

Feb 15, 2023

v4.2.1

Feb 12, 2023

v4.2.1-beta1

Feb 4, 2023

v4.2.0

Feb 2, 2023

v4.1.5

Feb 2, 2023

Changes in this version

type Server

+ func NewPProf() *Server

v4.1.4

Jan 27, 2023

v4.1.3

Jan 24, 2023

Changes in this version

+ type Pinger struct

+ func NewPinger(ctx context.Context, dur time.Duration, ping func()) *Pinger

+ func (p *Pinger) ReceivePong()

v4.1.2

May 4, 2022

Changes in this version

type ClientConfig

+ PeerConfig PeerConfig

type Config

+ Frontend Frontend

+ type Frontend struct

+ EncodedInsertableStreams bool

+ type PeerConfig struct

+ EncodedInsertableStreams bool

+ ICEServers []ICEAuthServer

v4.1.1

Dec 28, 2021

Changes in this version

+ const IOSH264Fmtp

+ var ErrDuplicateClientID = errors.New("duplicate client id")

+ func InitConfig(c *Config)

+ func NewInterceptorRegistry(mediaEngine *webrtc.MediaEngine) (*interceptor.Registry, error)

+ func NewMediaEngine() *webrtc.MediaEngine

+ func NewMeshHandler(log logger.Logger, wss *WSS) http.Handler

+ func NewNetworkTypes(log logger.Logger, networkTypes []string) (ret []webrtc.NetworkType)

+ func ParseUDPAddr(addr string) (*net.UDPAddr, error)

+ func ParseUDPAddrs(addrs []string) ([]*net.UDPAddr, error)

+ func ReadConfigFile(filename string, c *Config) (err error)

+ func ReadConfigFiles(filenames []string, c *Config) (err error)

+ func ReadConfigFromEnv(prefix string, c *Config)

+ func ReadConfigYAML(reader io.Reader, c *Config) error

+ func RegisterCodecs(mediaEngine *webrtc.MediaEngine, registry *codecs.Registry)

+ type Adapter interface

+ Add func(client ClientWriter) error

+ Broadcast func(msg message.Message) error

+ Clients func() (map[identifiers.ClientID]string, error)

+ Close func() error

+ Emit func(clientID identifiers.ClientID, msg message.Message) error

+ Metadata func(clientID identifiers.ClientID) (string, bool)

+ Remove func(clientID identifiers.ClientID) error

+ SetMetadata func(clientID identifiers.ClientID, metadata string) bool

+ Size func() (int, error)

+ type AdapterFactory struct

+ NewAdapter func(room identifiers.RoomID) Adapter

+ func NewAdapterFactory(log logger.Logger, c StoreConfig) *AdapterFactory

+ func (a *AdapterFactory) Close() (err error)

+ type AdapterRoomManager struct

+ func NewAdapterRoomManager(newAdapter NewAdapterFunc) *AdapterRoomManager

+ func (r *AdapterRoomManager) Enter(room identifiers.RoomID) (adapter Adapter, isNew bool)

+ func (r *AdapterRoomManager) Exit(room identifiers.RoomID) (isRemoved bool)

+ type AuthType string

+ const AuthTypeNone

+ const AuthTypeSecret

+ type ByteSerializer struct

+ func (s ByteSerializer) Deserialize(data []byte) (msg message.Message, err error)

+ func (s ByteSerializer) Serialize(m message.Message) ([]byte, error)

+ type ChannelRoomManager struct

+ func NewChannelRoomManager(roomManager RoomManager) *ChannelRoomManager

+ func (r *ChannelRoomManager) AcceptEvent() (RoomEvent, error)

+ func (r *ChannelRoomManager) Close()

+ func (r *ChannelRoomManager) Enter(room identifiers.RoomID) (adapter Adapter, isNew bool)

+ func (r *ChannelRoomManager) Exit(room identifiers.RoomID) (isRemoved bool)

+ func (r *ChannelRoomManager) RoomEventsChannel() <-chan RoomEvent

+ type Client struct

+ func NewClient(conn WSReadWriter) *Client

+ func NewClientWithID(conn WSReadWriter, id identifiers.ClientID) *Client

+ func (c *Client) Close(statusCode websocket.StatusCode, reason string) error

+ func (c *Client) Err() error

+ func (c *Client) ID() identifiers.ClientID

+ func (c *Client) Messages() <-chan message.Message

+ func (c *Client) Metadata() string

+ func (c *Client) SetMetadata(metadata string)

+ func (c *Client) Write(msg message.Message) error

+ func (c *Client) WriteCtx(ctx context.Context, msg message.Message) error

+ type ClientConfig struct

+ BaseURL string

+ CallID string

+ ICEServers []ICEAuthServer

+ Network NetworkType

+ Nickname string

+ PeerID string

+ type ClientWriter interface

+ ID func() identifiers.ClientID

+ Metadata func() string

+ SetMetadata func(metadata string)

+ Write func(msg message.Message) error

+ type Config struct

+ BaseURL string

+ BindHost string

+ BindPort int

+ FS string

+ ICEServers []ICEServer

+ Network NetworkConfig

+ Prometheus PrometheusConfig

+ Store StoreConfig

+ TLS TLSConfig

+ func ReadConfig(filenames []string) (c Config, err error)

+ type DataTransceiver struct

+ func NewDataTransceiver(log logger.Logger, clientID identifiers.ClientID, ...) *DataTransceiver

+ func (d *DataTransceiver) Close()

+ func (d *DataTransceiver) MessagesChannel() <-chan webrtc.DataChannelMessage

+ func (d *DataTransceiver) Send(message webrtc.DataChannelMessage) <-chan error

+ type Deserializer interface

+ Deserialize func([]byte) (message.Message, error)

+ type Doner interface

+ Done func()

+ type Embed struct

+ Resources fs.FS

+ Static fs.FS

+ Templates fs.FS

+ type ICEAuthServer struct

+ Credential string

+ URLs []string

+ Username string

+ func GetICEAuthServers(servers []ICEServer) (result []ICEAuthServer)

+ type ICEServer struct

+ AuthSecret struct{ ... }

+ AuthType AuthType

+ URLs []string

+ type JSONMessage struct

+ Payload string

+ Type string

+ type LocalTrack struct

+ func (t LocalTrack) Track() transport.Track

+ type MemoryAdapter struct

+ func NewMemoryAdapter(room identifiers.RoomID) *MemoryAdapter

+ func (m *MemoryAdapter) Add(client ClientWriter) (err error)

+ func (m *MemoryAdapter) Broadcast(msg message.Message) error

+ func (m *MemoryAdapter) Clients() (clientIDs map[identifiers.ClientID]string, err error)

+ func (m *MemoryAdapter) Close() error

+ func (m *MemoryAdapter) Emit(clientID identifiers.ClientID, msg message.Message) error

+ func (m *MemoryAdapter) Metadata(clientID identifiers.ClientID) (metadata string, ok bool)

+ func (m *MemoryAdapter) Remove(clientID identifiers.ClientID) (err error)

+ func (m *MemoryAdapter) SetMetadata(clientID identifiers.ClientID, metadata string) (ok bool)

+ func (m *MemoryAdapter) Size() (value int, err error)

+ type MultiErrorHandler = multierr.MultiErr

+ type Mux struct

+ BaseURL string

+ func NewMux(log logger.Logger, baseURL string, version string, network NetworkConfig, ...) *Mux

+ func (mux *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type Negotiator struct

+ func NewNegotiator(log logger.Logger, initiator bool, peerConnection *webrtc.PeerConnection, ...) *Negotiator

+ func (n *Negotiator) AddTransceiverFromKind(t TransceiverRequest)

+ func (n *Negotiator) Done() <-chan struct{}

+ func (n *Negotiator) Negotiate() (done <-chan struct{})

+ type NetworkConfig struct

+ SFU NetworkConfigSFU

+ Type NetworkType

+ type NetworkConfigSFU struct

+ Interfaces []string

+ JitterBuffer bool

+ Protocols []string

+ TCPBindAddr string

+ TCPListenPort int

+ Transport TransportConfig

+ UDP struct{ ... }

+ type NetworkType string

+ const NetworkTypeMesh

+ const NetworkTypeSFU

+ type NewAdapterFunc func(room identifiers.RoomID) Adapter

+ type NodeManager struct

+ func NewNodeManager(params NodeManagerParams) (*NodeManager, error)

+ func (nm *NodeManager) Close() error

+ type NodeManagerParams struct

+ ListenAddr *net.UDPAddr

+ Log logger.Logger

+ Nodes []*net.UDPAddr

+ RoomManager *ChannelRoomManager

+ TracksManager TracksManager

+ type PageHandler func(w http.ResponseWriter, r *http.Request) (templateName string, data interface{}, err error)

+ type Params struct

+ TLSCertFile string

+ TLSKeyFile string

+ type PrometheusConfig struct

+ AccessToken string

+ type ReadyMessage struct

+ PeerID string

+ Room string

+ type RedisAdapter struct

+ func NewRedisAdapter(log logger.Logger, pubRedis *redis.Client, subRedis *redis.Client, ...) *RedisAdapter

+ func (a *RedisAdapter) Add(client ClientWriter) (err error)

+ func (a *RedisAdapter) Broadcast(msg message.Message) error

+ func (a *RedisAdapter) Clients() (map[identifiers.ClientID]string, error)

+ func (a *RedisAdapter) Close() error

+ func (a *RedisAdapter) Emit(clientID identifiers.ClientID, msg message.Message) error

+ func (a *RedisAdapter) Metadata(clientID identifiers.ClientID) (metadata string, ok bool)

+ func (a *RedisAdapter) Remove(clientID identifiers.ClientID) error

+ func (a *RedisAdapter) SetMetadata(clientID identifiers.ClientID, metadata string) (ok bool)

+ func (a *RedisAdapter) Size() (size int, err error)

+ type RedisConfig struct

+ Host string

+ Port int

+ Prefix string

+ type RemoteTrack struct

+ func (t RemoteTrack) Track() transport.Track

+ type Renderer struct

+ BaseURL string

+ Version string

+ func NewRenderer(log logger.Logger, templates Templates, baseURL string, version string) *Renderer

+ func (tr *Renderer) Render(h PageHandler) http.HandlerFunc

+ type RoomEvent struct

+ RoomName identifiers.RoomID

+ Type RoomEventType

+ type RoomEventType int

+ const RoomEventTypeAdd

+ const RoomEventTypeRemove

+ type RoomManager interface

+ Enter func(room identifiers.RoomID) (adapter Adapter, isNew bool)

+ Exit func(room identifiers.RoomID) (isRemoved bool)

+ type RoomManagerFactory struct

+ func NewRoomManagerFactory(params RoomManagerFactoryParams) *RoomManagerFactory

+ func (rmf *RoomManagerFactory) NewRoomManager(c NetworkConfig) (RoomManager, *NodeManager)

+ type RoomManagerFactoryParams struct

+ AdapterFactory *AdapterFactory

+ Log logger.Logger

+ TracksManager TracksManager

+ type SFU struct

+ func NewSFUHandler(log logger.Logger, wss *WSS, iceServers []ICEServer, ...) *SFU

+ func (sfu *SFU) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type Serializer interface

+ Serialize func(message.Message) ([]byte, error)

+ type Server struct

+ func New(params Params, handler http.Handler) *Server

+ func (s Server) Start(ctx context.Context, l net.Listener) error

+ type Signaller struct

+ func NewSignaller(log logger.Logger, initiator bool, peerConnection *webrtc.PeerConnection) (*Signaller, error)

+ func (s *Signaller) Close() (err error)

+ func (s *Signaller) Done() <-chan struct{}

+ func (s *Signaller) Initiator() bool

+ func (s *Signaller) Negotiate() <-chan struct{}

+ func (s *Signaller) NegotiationDone() <-chan struct{}

+ func (s *Signaller) SendTransceiverRequest(kind webrtc.RTPCodecType, direction webrtc.RTPTransceiverDirection)

+ func (s *Signaller) Signal(signal message.Signal) error

+ func (s *Signaller) SignalChannel() <-chan message.Signal

+ type SocketHandler struct

+ func NewSocketHandler(log logger.Logger, tracksManager TracksManager, ...) *SocketHandler

+ func (sh *SocketHandler) HandleMessage(msg message.Message) error

+ func (sh *SocketHandler) HangUp()

+ type StoreConfig struct

+ Redis RedisConfig

+ Type StoreType

+ type StoreType string

+ const StoreTypeMemory

+ const StoreTypeRedis

+ type TLSConfig struct

+ Cert string

+ Key string

+ type Templates map[string]*template.Template

+ func ParseTemplates(templatesFS fs.FS) Templates

+ func (t Templates) Get(name string) (tpl *template.Template, ok bool)

+ type TracksManager interface

+ Add func(room identifiers.RoomID, transport transport.Transport) (<-chan pubsub.PubTrackEvent, error)

+ Sub func(params sfu.SubParams) error

+ Unsub func(params sfu.SubParams) error

+ type TransceiverRequest struct

+ CodecType webrtc.RTPCodecType

+ Init webrtc.RtpTransceiverInit

+ type TransportConfig struct

+ ListenAddr string

+ Nodes []string

+ type WSCloser interface

+ Close func(statusCode websocket.StatusCode, reason string) error

+ type WSReadWriter interface

+ type WSReader interface

+ Read func(ctx context.Context) (websocket.MessageType, []byte, error)

+ type WSS struct

+ func NewWSS(log logger.Logger, rooms RoomManager) *WSS

+ func (wss *WSS) NewWebsocketContext(w http.ResponseWriter, r *http.Request) (*WebsocketContext, error)

+ type WSWriter interface

+ Write func(ctx context.Context, typ websocket.MessageType, msg []byte) error

+ type WebRTCTransport struct

+ func NewWebRTCTransport(log logger.Logger, roomID identifiers.RoomID, clientID identifiers.ClientID, ...) (*WebRTCTransport, error)

+ func (p *WebRTCTransport) AddTrack(t transport.Track) (transport.TrackLocal, transport.RTCPReader, error)

+ func (p *WebRTCTransport) ClientID() identifiers.ClientID

+ func (p *WebRTCTransport) Close() error

+ func (p *WebRTCTransport) Done() <-chan struct{}

+ func (p *WebRTCTransport) LocalTracks() []transport.TrackWithMID

+ func (p *WebRTCTransport) MessagesChannel() <-chan webrtc.DataChannelMessage

+ func (p *WebRTCTransport) RemoteTracksChannel() <-chan transport.TrackRemoteWithRTCPReader

+ func (p *WebRTCTransport) RemoveTrack(trackID identifiers.TrackID) error

+ func (p *WebRTCTransport) Send(message webrtc.DataChannelMessage) <-chan error

+ func (p *WebRTCTransport) Signal(signal message.Signal) error

+ func (p *WebRTCTransport) SignalChannel() <-chan message.Signal

+ func (p *WebRTCTransport) Type() transport.Type

+ func (p *WebRTCTransport) WriteRTCP(packets []rtcp.Packet) error

+ type WebRTCTransportFactory struct

+ func NewWebRTCTransportFactory(log logger.Logger, iceServers []ICEServer, sfuConfig NetworkConfigSFU) *WebRTCTransportFactory

+ func (f WebRTCTransportFactory) NewWebRTCTransport(roomID identifiers.RoomID, clientID identifiers.ClientID, ...) (*WebRTCTransport, error)

+ type WebsocketContext struct

+ func NewWebsocketContext(adapter Adapter, client *Client, roomID identifiers.RoomID, onClose func()) *WebsocketContext

+ func (w *WebsocketContext) Adapter() Adapter

+ func (w *WebsocketContext) ClientID() identifiers.ClientID

+ func (w *WebsocketContext) Close(statusCode websocket.StatusCode, reason string) error

+ func (w *WebsocketContext) Messages() <-chan message.Message

+ func (w *WebsocketContext) RoomID() identifiers.RoomID

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL