FrameInterface
interface FrameInterface implements Stringable
Methods
Get the opcode.
Set the opcode.
Return a copy with the given opcode.
Determine whether this is the final frame.
Set whether this is the final frame.
Return a copy with the given final-frame state.
Get the first reserved bit.
Set the first reserved bit.
Return a copy with the given first reserved bit.
Get the second reserved bit.
Set the second reserved bit.
Return a copy with the given second reserved bit.
Get the third reserved bit.
Set the third reserved bit.
Return a copy with the given third reserved bit.
Get the payload length.
Determine whether the frame is masked.
Set whether the frame is masked.
Return a copy with the given mask state.
Get the payload data.
Set the payload data.
Return a copy with the given payload data.
Convert the frame to a string.
Create a frame from the given value.
Details
at line 15
int
getOpcode()
Get the opcode.
at line 20
FrameInterface
setOpcode(int $opcode)
Set the opcode.
at line 25
FrameInterface
withOpcode(int $opcode)
Return a copy with the given opcode.
at line 30
bool
getFin()
Determine whether this is the final frame.
at line 35
FrameInterface
setFin(bool $fin)
Set whether this is the final frame.
at line 40
FrameInterface
withFin(bool $fin)
Return a copy with the given final-frame state.
at line 45
bool
getRSV1()
Get the first reserved bit.
at line 50
FrameInterface
setRSV1(bool $rsv1)
Set the first reserved bit.
at line 55
FrameInterface
withRSV1(bool $rsv1)
Return a copy with the given first reserved bit.
at line 60
bool
getRSV2()
Get the second reserved bit.
at line 65
FrameInterface
setRSV2(bool $rsv2)
Set the second reserved bit.
at line 70
FrameInterface
withRSV2(bool $rsv2)
Return a copy with the given second reserved bit.
at line 75
bool
getRSV3()
Get the third reserved bit.
at line 80
FrameInterface
setRSV3(bool $rsv3)
Set the third reserved bit.
at line 85
FrameInterface
withRSV3(bool $rsv3)
Return a copy with the given third reserved bit.
at line 90
int
getPayloadLength()
Get the payload length.
at line 95
bool
getMask()
Determine whether the frame is masked.
at line 100
FrameInterface
setMask(bool $mask)
Set whether the frame is masked.
at line 105
FrameInterface
withMask(bool $mask)
Return a copy with the given mask state.
at line 110
StreamInterface
getPayloadData()
Get the payload data.
at line 115
FrameInterface
setPayloadData(mixed $payloadData)
Set the payload data.
at line 120
FrameInterface
withPayloadData(mixed $payloadData)
Return a copy with the given payload data.
at line 125
string
toString()
Convert the frame to a string.
at line 130
static FrameInterface
from(mixed $frame)
Create a frame from the given value.