1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
|
package sockjs
import (
"errors"
"net/http"
"sync"
"time"
)
// SessionState defines the current state of the session
type SessionState uint32
const (
// brand new session, need to send "h" to receiver
SessionOpening SessionState = iota
// active session
SessionActive
// session being closed, sending "closeFrame" to receivers
SessionClosing
// closed session, no activity at all, should be removed from handler completely and not reused
SessionClosed
)
var (
// ErrSessionNotOpen error is used to denote session not in open state.
// Recv() and Send() operations are not suppored if session is closed.
ErrSessionNotOpen = errors.New("sockjs: session not in open state")
errSessionReceiverAttached = errors.New("sockjs: another receiver already attached")
)
type session struct {
sync.RWMutex
id string
req *http.Request
state SessionState
recv receiver // protocol dependent receiver (xhr, eventsource, ...)
sendBuffer []string // messages to be sent to client
recvBuffer *messageBuffer // messages received from client to be consumed by application
closeFrame string // closeFrame to send after session is closed
// do not use SockJS framing for raw websocket connections
raw bool
// internal timer used to handle session expiration if no receiver is attached, or heartbeats if recevier is attached
sessionTimeoutInterval time.Duration
heartbeatInterval time.Duration
timer *time.Timer
// once the session timeouts this channel also closes
closeCh chan struct{}
}
type receiver interface {
// sendBulk send multiple data messages in frame frame in format: a["msg 1", "msg 2", ....]
sendBulk(...string)
// sendFrame sends given frame over the wire (with possible chunking depending on receiver)
sendFrame(string)
// close closes the receiver in a "done" way (idempotent)
close()
canSend() bool
// done notification channel gets closed whenever receiver ends
doneNotify() <-chan struct{}
// interrupted channel gets closed whenever receiver is interrupted (i.e. http connection drops,...)
interruptedNotify() <-chan struct{}
}
// Session is a central component that handles receiving and sending frames. It maintains internal state
func newSession(req *http.Request, sessionID string, sessionTimeoutInterval, heartbeatInterval time.Duration) *session {
s := &session{
id: sessionID,
req: req,
sessionTimeoutInterval: sessionTimeoutInterval,
heartbeatInterval: heartbeatInterval,
recvBuffer: newMessageBuffer(),
closeCh: make(chan struct{}),
}
s.Lock() // "go test -race" complains if ommited, not sure why as no race can happen here
s.timer = time.AfterFunc(sessionTimeoutInterval, s.close)
s.Unlock()
return s
}
func (s *session) sendMessage(msg string) error {
s.Lock()
defer s.Unlock()
if s.state > SessionActive {
return ErrSessionNotOpen
}
s.sendBuffer = append(s.sendBuffer, msg)
if s.recv != nil && s.recv.canSend() {
s.recv.sendBulk(s.sendBuffer...)
s.sendBuffer = nil
}
return nil
}
func (s *session) attachReceiver(recv receiver) error {
s.Lock()
defer s.Unlock()
if s.recv != nil {
return errSessionReceiverAttached
}
s.recv = recv
go func(r receiver) {
select {
case <-r.doneNotify():
s.detachReceiver()
case <-r.interruptedNotify():
s.detachReceiver()
s.close()
}
}(recv)
if s.state == SessionClosing {
if !s.raw {
s.recv.sendFrame(s.closeFrame)
}
s.recv.close()
return nil
}
if s.state == SessionOpening {
if !s.raw {
s.recv.sendFrame("o")
}
s.state = SessionActive
}
s.recv.sendBulk(s.sendBuffer...)
s.sendBuffer = nil
s.timer.Stop()
if s.heartbeatInterval > 0 {
s.timer = time.AfterFunc(s.heartbeatInterval, s.heartbeat)
}
return nil
}
func (s *session) detachReceiver() {
s.Lock()
s.timer.Stop()
s.timer = time.AfterFunc(s.sessionTimeoutInterval, s.close)
s.recv = nil
s.Unlock()
}
func (s *session) heartbeat() {
s.Lock()
if s.recv != nil { // timer could have fired between Lock and timer.Stop in detachReceiver
s.recv.sendFrame("h")
s.timer = time.AfterFunc(s.heartbeatInterval, s.heartbeat)
}
s.Unlock()
}
func (s *session) accept(messages ...string) error {
return s.recvBuffer.push(messages...)
}
// idempotent operation
func (s *session) closing() {
s.Lock()
defer s.Unlock()
if s.state < SessionClosing {
s.state = SessionClosing
s.recvBuffer.close()
if s.recv != nil {
s.recv.sendFrame(s.closeFrame)
s.recv.close()
}
}
}
// idempotent operation
func (s *session) close() {
s.closing()
s.Lock()
defer s.Unlock()
if s.state < SessionClosed {
s.state = SessionClosed
s.timer.Stop()
close(s.closeCh)
}
}
func (s *session) closedNotify() <-chan struct{} { return s.closeCh }
// Conn interface implementation
func (s *session) Close(status uint32, reason string) error {
s.Lock()
if s.state < SessionClosing {
s.closeFrame = closeFrame(status, reason)
s.Unlock()
s.closing()
return nil
}
s.Unlock()
return ErrSessionNotOpen
}
func (s *session) Recv() (string, error) {
return s.recvBuffer.pop()
}
func (s *session) Send(msg string) error {
return s.sendMessage(msg)
}
func (s *session) ID() string { return s.id }
func (s *session) GetSessionState() SessionState {
s.RLock()
defer s.RUnlock()
return s.state
}
func (s *session) Request() *http.Request {
return s.req
}
|