Scamper
40.0.0
API
Generated with
Scamper/scamper.http/scamper.http.websocket/WebSocket

WebSocket

scamper.http.websocket.WebSocket
object WebSocket

Provides utilities for WebSocket handshake.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
WebSocket.type

Members list

Value members

Concrete methods

def acceptKey(key: String): String

Generates header value for Sec-WebSocket-Accept using supplied WebSocket key.

Generates header value for Sec-WebSocket-Accept using supplied WebSocket key.

Value parameters

key

WebSocket key

Attributes

def checkHandshake(req: HttpRequest, res: HttpResponse): Boolean

Checks for successful WebSocket handshake based on supplied request and response.

Checks for successful WebSocket handshake based on supplied request and response.

Value parameters

req

WebSocket request

res

WebSocket response

Attributes

Returns

true if handshake is successful; false otherwise

def generateKey(): String

Generates WebSocket key.

Generates WebSocket key.

Attributes

def isUpgrade(req: HttpRequest): Boolean

Tests request for WebSocket upgrade.

Tests request for WebSocket upgrade.

Value parameters

req

request

Attributes

def isUpgrade(res: HttpResponse): Boolean

Tests response for WebSocket upgrade.

Tests response for WebSocket upgrade.

Value parameters

res

response

Attributes

def validate(req: HttpRequest): HttpRequest

Validates WebSocket request.

Validates WebSocket request.

Value parameters

req

WebSocket request

Attributes

Returns

unmodified WebSocket request

Throws
InvalidWebSocketRequest

if WebSocket request is invalid

Concrete fields

val guid: String

Globally Unique Identifier – 258EAFA5-E914-47DA-95CA-C5AB0DC85B11

Globally Unique Identifier – 258EAFA5-E914-47DA-95CA-C5AB0DC85B11

Attributes

Generated with