PHP Class Kafka\Socket

Public Methods

Method	Description
__construct ( $host, $port, integer $recvTimeoutSec, integer $recvTimeoutUsec = 750000, integer $sendTimeoutSec, integer $sendTimeoutUsec = 100000 )	__construct
close ( ) : void	close the socket
connect ( ) : void	Connects the socket
createFromStream ( $stream ) : Socket	Optional method to set the internal stream handle
isResource ( ) : boolean	checks if the socket is a valid resource
read ( integer $len, boolean $verifyExactLength = false ) : string	Read from the socket at most $len bytes.
rewind ( ) : void	Rewind the stream
setMaxWriteAttempts ( integer $number )
setRecvTimeoutSec ( float $recvTimeoutSec )
setRecvTimeoutUsec ( float $recvTimeoutUsec )
setSendTimeoutSec ( float $sendTimeoutSec )
setSendTimeoutUsec ( float $sendTimeoutUsec )
setStream ( mixed $stream ) : void	Optional method to set the internal stream handle
write ( string $buf ) : integer	Write to the socket.

__construct

public __construct ( $host, $port, integer $recvTimeoutSec, integer $recvTimeoutUsec = 750000, integer $sendTimeoutSec, integer $sendTimeoutUsec = 100000 )
$host
$port
$recvTimeoutSec	integer
$recvTimeoutUsec	integer
$sendTimeoutSec	integer
$sendTimeoutUsec	integer

close the socket

public close ( ) : void
return	void

Connects the socket

public connect ( ) : void
return	void

Optional method to set the internal stream handle

public static createFromStream ( $stream ) : Socket
$stream
return	Socket

checks if the socket is a valid resource

public isResource ( ) : boolean
return	boolean

This method will not wait for all the requested data, it will return as soon as any data is received.

public read ( integer $len, boolean $verifyExactLength = false ) : string
$len	integer	Maximum number of bytes to read.
$verifyExactLength	boolean	Throw an exception if the number of read bytes is less than $len
return	string	Binary data

Rewind the stream

public rewind ( ) : void
return	void

public setMaxWriteAttempts ( integer $number )
$number	integer

public setRecvTimeoutSec ( float $recvTimeoutSec )
$recvTimeoutSec	float

public setRecvTimeoutUsec ( float $recvTimeoutUsec )
$recvTimeoutUsec	float

public setSendTimeoutSec ( float $sendTimeoutSec )
$sendTimeoutSec	float

public setSendTimeoutUsec ( float $sendTimeoutUsec )
$sendTimeoutUsec	float

Optional method to set the internal stream handle

public setStream ( mixed $stream ) : void
$stream	mixed
return	void

Write to the socket.

public write ( string $buf ) : integer
$buf	string	The data to write
return	integer