Documentation
¶
Overview ¶
SIGNALING. Allows both room and simplest signaling. Signaling is the process of relaying information between peers in a webrtc context.
Namely information about offers, answers and ice-candidates
Simplest Signaling:
To a known user, this server can relay that information. It might be required to additionally add peer finding functionality. I.e. a query of who is currently in a room. And broadcast a notify if a new user connects. This was not required for the concrete problem at hand that this util-library aimed to solve But it is trivial to add.
Room signaling is just simplest signaling, with virtual servers.
For how rooms are created, destroyed and function in general, see the room_forwarding_*.go files in wsclientable
Index ¶
- func StartRoomSignalingServerUnencrypted(cfg *ini.File)
- func StartRoomSignalingServerUnencryptedWithCustomControllers(cfg *ini.File, controllers ...wsclientable.RoomControllerI)
- func StartRoomSignalingServerWithSSL(cfg *ini.File)
- func StartRoomSignalingServerWithSSLWithCustomControllers(cfg *ini.File, controllers ...wsclientable.RoomControllerI)
- func StartSimplestSignalingServerUnencrypted(cfg *ini.File)
- func StartSimplestSignalingServerWithSSL(cfg *ini.File)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func StartRoomSignalingServerUnencrypted ¶
func StartRoomSignalingServerUnencrypted(cfg *ini.File)
minimal example config, with all required fields and some comments in example_configs/room_unencrypted.ini
Starts a room signaling server with all possible controllers (config see ini) Within rooms, it will allow direct forwarding to other KNOWN users (on message types offer, answer, candidate)
func StartRoomSignalingServerUnencryptedWithCustomControllers ¶ added in v1.0.6
func StartRoomSignalingServerUnencryptedWithCustomControllers(cfg *ini.File, controllers ...wsclientable.RoomControllerI)
Starts a room signaling server with only the given room controllers Within rooms, it will allow direct forwarding to other KNOWN users (on message types offer, answer, candidate)
func StartRoomSignalingServerWithSSL ¶
func StartRoomSignalingServerWithSSL(cfg *ini.File)
minimal example config, with all required fields and some comments in example_configs/room_ssl.ini
Starts a room signaling server with all possible controllers (config see ini) Within rooms, it will allow direct forwarding to other KNOWN users (on message types offer, answer, candidate)
func StartRoomSignalingServerWithSSLWithCustomControllers ¶ added in v1.0.6
func StartRoomSignalingServerWithSSLWithCustomControllers(cfg *ini.File, controllers ...wsclientable.RoomControllerI)
Starts a room signaling server with only the given room controllers Within rooms, it will allow direct forwarding to other KNOWN users (on message types offer, answer, candidate)
func StartSimplestSignalingServerUnencrypted ¶
func StartSimplestSignalingServerUnencrypted(cfg *ini.File)
minimal example config, with all required fields and some comments in example_configs/simplest_unencrypted.ini
Starts a room signaling server with all possible controllers (config see ini) Allows direct forwarding to other KNOWN users (on message types offer, answer, candidate)
func StartSimplestSignalingServerWithSSL ¶
func StartSimplestSignalingServerWithSSL(cfg *ini.File)
minimal example config, with all required fields and some comments in example_configs/simplest_ssl.ini
Starts a room signaling server with all possible controllers (config see ini) Allows direct forwarding to other KNOWN users (on message types offer, answer, candidate)
Types ¶
This section is empty.
Source Files