Pike v8.0 release 1738

Class Protocols.WebSocket.Frame


Variable data

string Protocols.WebSocket.Frame.data

Description

Data part of the frame. Valid for frames of type FRAME_BINARY, FRAME_PING and FRAME_PONG.


Variable fin

bool Protocols.WebSocket.Frame.fin

Description

Set to 1 if this a final frame, i.e. the last frame of a fragmented message or a non-fragmentation frame.


Variable opcode

FRAME Protocols.WebSocket.Frame.opcode


Variable reason

CLOSE_STATUS Protocols.WebSocket.Frame.reason

Description

Only exists for frames of type FRAME_CLOSE.


Variable text

string Protocols.WebSocket.Frame.text

Description

Only exists for frames of type FRAME_TEXT.


Method create

Protocols.WebSocket.Frame Protocols.WebSocket.Frame(FRAME opcode, void|string|CLOSE_STATUS)
Protocols.WebSocket.Frame Protocols.WebSocket.Frame(FRAME_TEXT, string text)
Protocols.WebSocket.Frame Protocols.WebSocket.Frame(FRAME_BINARY, string(8bit) data)
Protocols.WebSocket.Frame Protocols.WebSocket.Frame(FRAME_CLOSE, CLOSE_STATUS reason)
Protocols.WebSocket.Frame Protocols.WebSocket.Frame(FRAME_PING, string(8bit) data)
Protocols.WebSocket.Frame Protocols.WebSocket.Frame(FRAME_PONG, string(8bit) data)