Skip to content

Commit

Permalink
comment
Browse files Browse the repository at this point in the history
  • Loading branch information
gammazero committed Mar 24, 2018
1 parent e8d9fe4 commit 3f5bb7c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions transport/websocketpeer.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ type WebsocketConfig struct {
EnableContextTakeover bool `json:"enable_context_takeover"`
CompressionLevel int `json:"compression_level"`

// For WebsocketServer configuration only
// For WebsocketServer configuration only. These options are configured
// for the router by passing WebsocketConfig to
// WebsocketServer.SetConfig().
//
// EnableTrackingCookie tells the server to send a random-value cookie to
// the websocket client. A returning client may identify itself by sending
Expand All @@ -49,14 +51,12 @@ type WebsocketConfig struct {
// }
//
// The "cookie" and "nextcookie" values are retrieved similarly.
EnableTrackingCookie bool `json:"enable_tracking_cookie"`
//
// EnableRequestCapture tells the server to include the upgrade HTTP
// request in the HELLO and session details. It is stored in
// Details.transport.auth.request|*http.Request and is available to
// auth/authz logic.
//
// EnableTrackingCookie and EnableRequestCapture is configured for the
// server by passing WebsocketConfig to WebsocketServer.SetConfig().
EnableTrackingCookie bool `json:"enable_tracking_cookie"`
EnableRequestCapture bool `json:"enable_request_capture"`

// For websocket client configuration only
Expand Down

0 comments on commit 3f5bb7c

Please sign in to comment.