stingray.WebSocket object reference

Description

Implements a web socket client interface.

Constructors and accessors

stingray.WebSocket()

Other related reference items

	stingray.WebSocket()
	Networking

Related help topics

Release Notes > Stingray 1.4 Release Notes

Enumerations

stingray.WebSocket.MessageType Supported message types.

stingray.WebSocket.State Websocket states

Functions

close ( self ) Closes the web socket.

Parameters

self :

stingray.WebSocket

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

poll ( self ) : stingray.WebSocket.MessageType?, string? Polls the WebSocket for new data.

Parameters

self :

stingray.WebSocket

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

MessageType?	The type of the returned payload, TEXT or BINARY. If there is no new data, nil is returned. The ? notation indicates that this type is optional: there may be zero or one instances of it.
string?	The payload of the message or nil if there was no new data. The ? notation indicates that this type is optional: there may be zero or one instances of it.

send ( self, msg, type ) Sends a websocket message.

Parameters

self :	stingray.WebSocket	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
msg :	string	The string to send over the websocket.
type :	stingray.WebSocket.MessageType?	The type of the message, TEXT or BINARY. This defaults to TEXT unless specified. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

state ( self ) : stingray.WebSocket.State Returns the current state of the web socket.

Parameters

self :

stingray.WebSocket

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

State

The current state of the web socket.