Documentation
¶
Index ¶
- Constants
- type SessionCtx
- func (session *SessionCtx) GetWebRTCPeer() types.WebRTCPeer
- func (session *SessionCtx) GetWebSocketPeer() types.WebSocketPeer
- func (session *SessionCtx) ID() string
- func (session *SessionCtx) IsHost() bool
- func (session *SessionCtx) PrivateModeEnabled() bool
- func (session *SessionCtx) Profile() types.MemberProfile
- func (session *SessionCtx) Send(event string, payload any)
- func (session *SessionCtx) SetCursor(cursor types.Cursor)
- func (session *SessionCtx) SetWebRTCConnected(webrtcPeer types.WebRTCPeer, connected bool)
- func (session *SessionCtx) SetWebRTCPeer(webrtcPeer types.WebRTCPeer)
- func (session *SessionCtx) SetWebSocketConnected(websocketPeer types.WebSocketPeer, connected bool, delayed bool)
- func (session *SessionCtx) SetWebSocketPeer(websocketPeer types.WebSocketPeer)
- func (session *SessionCtx) State() types.SessionState
- type SessionManagerCtx
- func (manager *SessionManagerCtx) AdminBroadcast(event string, payload any, exclude ...string)
- func (manager *SessionManagerCtx) Authenticate(r *http.Request) (types.Session, error)
- func (manager *SessionManagerCtx) Broadcast(event string, payload any, exclude ...string)
- func (manager *SessionManagerCtx) ClearHost()
- func (manager *SessionManagerCtx) CookieClearToken(w http.ResponseWriter, r *http.Request)
- func (manager *SessionManagerCtx) CookieEnabled() bool
- func (manager *SessionManagerCtx) CookieSetToken(w http.ResponseWriter, token string)
- func (manager *SessionManagerCtx) Create(id string, profile types.MemberProfile) (types.Session, string, error)
- func (manager *SessionManagerCtx) Delete(id string) error
- func (manager *SessionManagerCtx) Get(id string) (types.Session, bool)
- func (manager *SessionManagerCtx) GetByToken(token string) (types.Session, bool)
- func (manager *SessionManagerCtx) GetHost() (types.Session, bool)
- func (manager *SessionManagerCtx) InactiveCursorsBroadcast(event string, payload any, exclude ...string)
- func (manager *SessionManagerCtx) List() []types.Session
- func (manager *SessionManagerCtx) OnConnected(listener func(session types.Session))
- func (manager *SessionManagerCtx) OnCreated(listener func(session types.Session))
- func (manager *SessionManagerCtx) OnDeleted(listener func(session types.Session))
- func (manager *SessionManagerCtx) OnDisconnected(listener func(session types.Session))
- func (manager *SessionManagerCtx) OnHostChanged(listener func(session types.Session))
- func (manager *SessionManagerCtx) OnProfileChanged(listener func(session types.Session))
- func (manager *SessionManagerCtx) OnSettingsChanged(listener func(new types.Settings, old types.Settings))
- func (manager *SessionManagerCtx) OnStateChanged(listener func(session types.Session))
- func (manager *SessionManagerCtx) PopCursors() map[types.Session][]types.Cursor
- func (manager *SessionManagerCtx) SetCursor(cursor types.Cursor, session types.Session)
- func (manager *SessionManagerCtx) SetHost(host types.Session)
- func (manager *SessionManagerCtx) Settings() types.Settings
- func (manager *SessionManagerCtx) Update(id string, profile types.MemberProfile) error
- func (manager *SessionManagerCtx) UpdateSettings(new types.Settings)
Constants ¶
View Source
const WS_DELAYED_DURATION = 5 * time.Second
client is expected to reconnect within 5 second if some unexpected websocket disconnect happens
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SessionCtx ¶
type SessionCtx struct {
// contains filtered or unexported fields
}
func (*SessionCtx) GetWebRTCPeer ¶
func (session *SessionCtx) GetWebRTCPeer() types.WebRTCPeer
func (*SessionCtx) GetWebSocketPeer ¶
func (session *SessionCtx) GetWebSocketPeer() types.WebSocketPeer
func (*SessionCtx) ID ¶
func (session *SessionCtx) ID() string
func (*SessionCtx) IsHost ¶
func (session *SessionCtx) IsHost() bool
func (*SessionCtx) PrivateModeEnabled ¶
func (session *SessionCtx) PrivateModeEnabled() bool
func (*SessionCtx) Profile ¶
func (session *SessionCtx) Profile() types.MemberProfile
func (*SessionCtx) Send ¶
func (session *SessionCtx) Send(event string, payload any)
func (*SessionCtx) SetCursor ¶
func (session *SessionCtx) SetCursor(cursor types.Cursor)
func (*SessionCtx) SetWebRTCConnected ¶
func (session *SessionCtx) SetWebRTCConnected(webrtcPeer types.WebRTCPeer, connected bool)
func (*SessionCtx) SetWebRTCPeer ¶
func (session *SessionCtx) SetWebRTCPeer(webrtcPeer types.WebRTCPeer)
func (*SessionCtx) SetWebSocketConnected ¶
func (session *SessionCtx) SetWebSocketConnected(websocketPeer types.WebSocketPeer, connected bool, delayed bool)
func (*SessionCtx) SetWebSocketPeer ¶
func (session *SessionCtx) SetWebSocketPeer(websocketPeer types.WebSocketPeer)
func (*SessionCtx) State ¶
func (session *SessionCtx) State() types.SessionState
type SessionManagerCtx ¶
type SessionManagerCtx struct {
// contains filtered or unexported fields
}
func New ¶
func New(config *config.Session) *SessionManagerCtx
func (*SessionManagerCtx) AdminBroadcast ¶
func (manager *SessionManagerCtx) AdminBroadcast(event string, payload any, exclude ...string)
func (*SessionManagerCtx) Authenticate ¶
func (*SessionManagerCtx) Broadcast ¶
func (manager *SessionManagerCtx) Broadcast(event string, payload any, exclude ...string)
func (*SessionManagerCtx) ClearHost ¶
func (manager *SessionManagerCtx) ClearHost()
func (*SessionManagerCtx) CookieClearToken ¶
func (manager *SessionManagerCtx) CookieClearToken(w http.ResponseWriter, r *http.Request)
func (*SessionManagerCtx) CookieEnabled ¶
func (manager *SessionManagerCtx) CookieEnabled() bool
func (*SessionManagerCtx) CookieSetToken ¶
func (manager *SessionManagerCtx) CookieSetToken(w http.ResponseWriter, token string)
func (*SessionManagerCtx) Create ¶
func (manager *SessionManagerCtx) Create(id string, profile types.MemberProfile) (types.Session, string, error)
func (*SessionManagerCtx) Delete ¶
func (manager *SessionManagerCtx) Delete(id string) error
func (*SessionManagerCtx) Get ¶
func (manager *SessionManagerCtx) Get(id string) (types.Session, bool)
func (*SessionManagerCtx) GetByToken ¶
func (manager *SessionManagerCtx) GetByToken(token string) (types.Session, bool)
func (*SessionManagerCtx) GetHost ¶
func (manager *SessionManagerCtx) GetHost() (types.Session, bool)
func (*SessionManagerCtx) InactiveCursorsBroadcast ¶
func (manager *SessionManagerCtx) InactiveCursorsBroadcast(event string, payload any, exclude ...string)
func (*SessionManagerCtx) List ¶
func (manager *SessionManagerCtx) List() []types.Session
func (*SessionManagerCtx) OnConnected ¶
func (manager *SessionManagerCtx) OnConnected(listener func(session types.Session))
func (*SessionManagerCtx) OnCreated ¶
func (manager *SessionManagerCtx) OnCreated(listener func(session types.Session))
func (*SessionManagerCtx) OnDeleted ¶
func (manager *SessionManagerCtx) OnDeleted(listener func(session types.Session))
func (*SessionManagerCtx) OnDisconnected ¶
func (manager *SessionManagerCtx) OnDisconnected(listener func(session types.Session))
func (*SessionManagerCtx) OnHostChanged ¶
func (manager *SessionManagerCtx) OnHostChanged(listener func(session types.Session))
func (*SessionManagerCtx) OnProfileChanged ¶
func (manager *SessionManagerCtx) OnProfileChanged(listener func(session types.Session))
func (*SessionManagerCtx) OnSettingsChanged ¶
func (manager *SessionManagerCtx) OnSettingsChanged(listener func(new types.Settings, old types.Settings))
func (*SessionManagerCtx) OnStateChanged ¶
func (manager *SessionManagerCtx) OnStateChanged(listener func(session types.Session))
func (*SessionManagerCtx) PopCursors ¶
func (manager *SessionManagerCtx) PopCursors() map[types.Session][]types.Cursor
func (*SessionManagerCtx) SetCursor ¶
func (manager *SessionManagerCtx) SetCursor(cursor types.Cursor, session types.Session)
func (*SessionManagerCtx) SetHost ¶
func (manager *SessionManagerCtx) SetHost(host types.Session)
func (*SessionManagerCtx) Settings ¶
func (manager *SessionManagerCtx) Settings() types.Settings
func (*SessionManagerCtx) Update ¶
func (manager *SessionManagerCtx) Update(id string, profile types.MemberProfile) error
func (*SessionManagerCtx) UpdateSettings ¶
func (manager *SessionManagerCtx) UpdateSettings(new types.Settings)
Source Files
Click to show internal directories.
Click to hide internal directories.