package
0.0.0-20240401061429-5b28944b9e4f
Repository: https://github.com/muka/peerjs-go.git
Documentation: pkg.go.dev
# Functions
New creates a new PeerServer.
NewAuth init a new Auth middleware.
NewCheckBrokenConnections create a new CheckBrokenConnections.
NewClient initialize a new client.
NewHandlersRegistry creates a new HandlersRegistry.
NewHeartbeatHandler handles a heartbeat.
NewHTTPServer init a server.
NewMessageHandler creates a new MessageHandler.
NewMessageQueue creates a new MessageQueue.
No description provided by the author
NewOptions create default options.
NewRealm creates a new Realm.
NewTransmissionHandler handles transmission of messages.
NewWebSocketServer create a new WebSocketServer.
# Constants
No description provided by the author
ErrorConnectionLimitExceeded Server has reached its concurrent user limit.
ErrorInvalidKey Invalid key provided.
ErrorInvalidToken Invalid token provided.
ErrorInvalidWSParameters No id, token, or key supplied to websocket server.
MessageTypeAnswer ANSWER.
MessageTypeCandidate CANDIDATE.
MessageTypeError ERROR.
MessageTypeExpire EXPIRE.
MessageTypeHeartbeat HEARTBEAT.
MessageTypeIDTaken ID-TAKEN.
MessageTypeLeave LEAVE.
MessageTypeOffer OFFER.
MessageTypeOpen OPEN.
WebsocketEventClose close.
WebsocketEventConnection connection.
WebsocketEventError error.
WebsocketEventMessage message.
# Variables
ClientIDGenerator default hash generator.
# Structs
Auth handles request authentication.
AuthError is an error that occurs during authentication and contains the original error plus the http status code that should be returned to the client.
CheckBrokenConnections watch for broken connections.
Client implementation.
ClientMessage wrap a message received by a client.
HandlersRegistry handlers registry.
HTTPServer peer server.
MessageHandler wrap the message handler.
MessageQueue type.
MessagesExpire check for expired messages.
Options peer server options.
PeerServer wrap the peer server functionalities.
Realm implementation of a realm.
WebSocketServer wrap the websocket server.
# Interfaces
IClient client interface.
IHandlersRegistry interface for HandlersRegistry.
IMessageHandler interface for MessageHandler.
IMessageQueue message queue interface.
IMessagesExpire MessagesExpire interface.
IRealm interface for Realm.
# Type aliases
Handler wrap a callback.