PHP 클래스 Wrench\Payload\Payload

Represents a WebSocket protocol payload, which may be made up of multiple frames.

보호된 프로퍼티들

프로퍼티	타입	설명
$buffer		String representation of the payload contents
$frames	Wrench\Frame\Frame[]	A payload may consist of one or more frames

메소드	설명
__toString ( ) : string
encode ( string $data, integer $type = Protocol::TYPE_TEXT, boolean $masked = false ) : Payload	Encodes a payload
getPayload ( ) : string
getRemainingData ( ) : number \| null	Gets the number of remaining bytes before this payload will be complete
getType ( ) : integer	Gets the type of the payload
isComplete ( ) : boolean	Whether the payload is complete
isWaitingForData ( ) : boolean	Whether this payload is waiting for more data
receiveData ( string $data ) : void	Receive raw data into the payload
sendToSocket ( Socket $socket ) : boolean

메소드	설명
getCurrentFrame ( ) : mixed	Gets the current frame for the payload
getFrame ( ) : Wrench\Frame\Frame	Get a frame object
getReceivingFrame ( ) : Wrench\Frame\Frame	Gets the frame into which data should be receieved

public __toString ( ) : string
리턴	string

Encodes a payload

public encode ( string $data, integer $type = Protocol::TYPE_TEXT, boolean $masked = false ) : Payload
$data	string
$type	integer
$masked	boolean
리턴	Payload

Gets the current frame for the payload

protected getCurrentFrame ( ) : mixed
리턴	mixed

Get a frame object

abstract protected getFrame ( ) : Wrench\Frame\Frame
리턴	Wrench\Frame\Frame

public getPayload ( ) : string
리턴	string

Gets the frame into which data should be receieved

protected getReceivingFrame ( ) : Wrench\Frame\Frame
리턴	Wrench\Frame\Frame

May return 0 (no more bytes required) or null (unknown number of bytes required).

public getRemainingData ( ) : number \| null
리턴	number \| null

The type of a payload is taken from its first frame

public getType ( ) : integer
리턴	integer

Whether the payload is complete

public isComplete ( ) : boolean
리턴	boolean

Whether this payload is waiting for more data

public isWaitingForData ( ) : boolean
리턴	boolean

Receive raw data into the payload

public receiveData ( string $data ) : void
$data	string
리턴	void

public sendToSocket ( Socket $socket ) : boolean
$socket	Wrench\Socket\Socket
리턴	boolean

String representation of the payload contents

protected $buffer

A payload may consist of one or more frames

protected Frame[],Wrench\Frame $frames
리턴	Wrench\Frame\Frame[]