A WebSocket frame that represents either text or binary data.
A WebSocket message is composed of one or more WebSocket frames.
If there is a just a single frame in the message then a single text or binary frame should be created with final = true.
If there are more than one frames in the message, then the first frame should be a text or binary frame with final = false, followed by one or more continuation frames. The last continuation frame should have final = true.
package |
Default |
---|
__construct()
binaryData() : \io\vertx\jphp\core\buffer\Buffer
binaryFrame( $arg0, $arg1) : \io\vertx\jphp\core\http\WebSocketFrame
closeReason() : string
string
string explaining close reason. Only use this for close frames
closeStatusCode() : integer
integer
status code of close frame. Only use this for close frames
continuationFrame( $arg0, $arg1) : \io\vertx\jphp\core\http\WebSocketFrame
isBinary() : boolean
boolean
true if it's a binary frame
isClose() : boolean
boolean
true if it's close frame
isContinuation() : boolean
boolean
true if it's a continuation frame
isFinal() : boolean
boolean
true if this is the final frame.
isText() : boolean
boolean
true if it's a text frame
pingFrame( $arg0) : \io\vertx\jphp\core\http\WebSocketFrame
pongFrame( $arg0) : \io\vertx\jphp\core\http\WebSocketFrame
textData() : string
string
the content of this frame as a UTF-8 string and returns the converted string. Only use this for text frames.
textFrame( $arg0, $arg1) : \io\vertx\jphp\core\http\WebSocketFrame