PHP Класс Network\Connection

Socket connection.
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$error string Error encountered on the socket.
$error_str string Error encountered on the socket.

Защищенные свойства (Protected)

Свойство Тип Описание
$_read_attempted integer Read Attempts
$_read_buffer string | null Read Buffer
$_socket resource Socket that is connected.

Открытые методы

Метод Описание
__construct ( resource $socket ) : void Constructs a new connection.
_read_buffer ( integer $length = XPSPL_SOCKET_READ_LENGTH, integer $flags = MSG_DONTWAIT ) : string Reads the given length of data from the socket into the read buffer.
disconnect ( ) : event\Disconnect Send the signal to disconnect this socket.
flush_read_buffer ( ) : void Flushes the read buffer.
get_address ( ) : string | null Returns the address of the socket.
get_resource ( ) : resource Returns the socket resource.
is_connected ( ) : boolean Returns if the socket is currently connected.
read ( $length = XPSPL_SOCKET_READ_LENGTH, $start ) : void Read data from the socket.
write ( string $string, integer $flags = null ) : integer | boolean Writes data to the socket.

Защищенные методы

Метод Описание
_connect ( ) : void Establishes the socket connection.

Описание методов

__construct() публичный Метод

Constructs a new connection.
public __construct ( resource $socket ) : void
$socket resource Socket connection.
Результат void

_connect() защищенный Метод

Establishes the socket connection.
protected _connect ( ) : void
Результат void

_read_buffer() публичный Метод

Reads the given length of data from the socket into the read buffer.
public _read_buffer ( integer $length = XPSPL_SOCKET_READ_LENGTH, integer $flags = MSG_DONTWAIT ) : string
$length integer Maximum number of bytes to read in. Default = 2MB
$flags integer See php.net/socket_recv
Результат string

disconnect() публичный Метод

Send the signal to disconnect this socket.
public disconnect ( ) : event\Disconnect
Результат event\Disconnect

flush_read_buffer() публичный Метод

Flushes the read buffer.
public flush_read_buffer ( ) : void
Результат void

get_address() публичный Метод

Returns the address of the socket.
public get_address ( ) : string | null
Результат string | null

get_resource() публичный Метод

Returns the socket resource.
public get_resource ( ) : resource
Результат resource

is_connected() публичный Метод

Returns if the socket is currently connected.
public is_connected ( ) : boolean
Результат boolean

read() публичный Метод

Read data from the socket.
public read ( $length = XPSPL_SOCKET_READ_LENGTH, $start ) : void
Результат void

write() публичный Метод

Writes data to the socket.
public write ( string $string, integer $flags = null ) : integer | boolean
$string string String to send.
$flags integer Send flags - php.net/socket_send
Результат integer | boolean Number of bytes written, False on error

Описание свойств

$_read_attempted защищенное свойство

Read Attempts
protected int $_read_attempted
Результат integer

$_read_buffer защищенное свойство

Read Buffer
protected string|null $_read_buffer
Результат string | null

$_socket защищенное свойство

Socket that is connected.
protected resource $_socket
Результат resource

$error публичное свойство

Error encountered on the socket.
public string $error
Результат string

$error_str публичное свойство

Error encountered on the socket.
public string $error_str
Результат string