PHP Class LdapTools\Utilities\TcpSocket

Author: Chad Sikorra ([email protected])

Protected Properties

Property	Type	Description
$options	array
$socket	boolean \| resource

Method	Description
__construct ( array $options = [] )
close ( )	Close the connection to the host.
connect ( string $host, integer $port, integer $timeout = 1 ) : boolean	Connect to the host on the port defined for this TCP socket.
enableEncryption ( integer $cryptoMethod = null ) : boolean	Enable encryption for the socket connection.
getParams ( ) : array	Get parameter/option information from the TCP socket stream/context.
read ( integer $length )	Read data from the TCP socket.
setOperationTimeout ( integer $timeout ) : boolean	Sets the timeout (in seconds) for TCP operations (not the initial connection attempt).
write ( mixed $data ) : integer	Write data to the TCP socket.

public __construct ( array $options = [] )
$options	array	The TCP stream context options.

Close the connection to the host.

public close ( )

Connect to the host on the port defined for this TCP socket.

public connect ( string $host, integer $port, integer $timeout = 1 ) : boolean
$host	string
$port	integer
$timeout	integer
return	boolean

Enable encryption for the socket connection.

public enableEncryption ( integer $cryptoMethod = null ) : boolean
$cryptoMethod	integer
return	boolean

Get parameter/option information from the TCP socket stream/context.

public getParams ( ) : array
return	array

Read data from the TCP socket.

public read ( integer $length )
$length	integer

Sets the timeout (in seconds) for TCP operations (not the initial connection attempt).

public setOperationTimeout ( integer $timeout ) : boolean
$timeout	integer
return	boolean

Write data to the TCP socket.

public write ( mixed $data ) : integer
$data	mixed
return	integer

protected array $options
return	array

protected bool\|resource $socket
return	boolean \| resource