Documentation

FrameInterface extends DataInterface

Table of Contents

Methods

__toString()  : string
Should return the unmasked payload received from peer
addBuffer()  : mixed
Add incoming data to the frame from peer
getContents()  : string
Get raw contents of the message
getMaskingKey()  : string
32-big string
getOpcode()  : int
getPayload()  : string
Get the payload (message) sent from peer
getPayloadLength()  : int
Get the number of bytes the payload is set to be
isCoalesced()  : bool
Determine if the message is complete or still fragmented
isFinal()  : bool
Is this the final frame in a fragmented message?
isMasked()  : bool
Is the payload masked?

Methods

__toString()

Should return the unmasked payload received from peer

public __toString() : string
Return values
string

addBuffer()

Add incoming data to the frame from peer

public addBuffer(mixed $buf) : mixed
Parameters
$buf : mixed

getContents()

Get raw contents of the message

public getContents() : string
Return values
string

getMaskingKey()

32-big string

public getMaskingKey() : string
Return values
string

getPayload()

Get the payload (message) sent from peer

public getPayload() : string
Return values
string

getPayloadLength()

Get the number of bytes the payload is set to be

public getPayloadLength() : int
Return values
int

isCoalesced()

Determine if the message is complete or still fragmented

public isCoalesced() : bool
Return values
bool

isFinal()

Is this the final frame in a fragmented message?

public isFinal() : bool
Return values
bool

isMasked()

Is the payload masked?

public isMasked() : bool
Return values
bool

        
On this page

Search results