Класс CakeSocket
Класс соединения с сокетом сети CakePHP.
Базовый класс ядра для сетевого взаимодействия.
Прямые известные подклассы
HttpSocketАвторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположено в Cake/Network/CakeSocket.php
Подробное описание метода
__constructисходный код public
__construct( array $config array() )
Конструктор.
Параметры
- массив
$configнеобязательно массив() - Настройка сокета, которая будет объединена с базовой настройкой
См. также
CakeSocket::$_baseConfig__destructисходный код public
__destruct( )
Деструктор, используемый для отключения от текущего соединения.
_connectionErrorHandlerисходный код protected
_connectionErrorHandler( integer $code , string $message )
socket_stream_client() не заполняет errNum или $errStr при возникновении ошибок соединения, например, при ошибке проверки SSL.
Вместо этого нам нужно обработать эти ошибки вручную.
Параметры
- целое число
$code - Код.
- строка
$message - Сообщение.
_setSslContextисходный код protected
_setSslContext( string $host )
Настройте параметры контекста SSL.
Параметры
- строка
$host - Имя хоста, к которому происходит подключение.
addressисходный код public
address( )
Получает IP-адрес текущего соединения.
Возвращает
stringIP-адрес
addressesисходный код public
addresses( )
Получает все IP-адреса, связанные с текущим соединением.
Возвращает
arrayIP-адреса
connectисходный код public
connect( )
Подключает сокет к указанному хосту и порту.
Возвращает
booleanУспех
Выбрасывает
SocketExceptionSocketException
contextисходный код public
context( )
Получает контекст соединения.
Возвращает
null|arrayNull, если нет соединения, массив, если есть.
disconnectисходный код public
disconnect( )
Отключает сокет от текущего соединения.
Возвращает
booleanУспех
enableCryptoисходный код public
enableCrypto( string $type , string $clientOrServer 'client' , boolean $enable true )
Шифрует текущий сокет потока, используя один из определенных методов шифрования.
Параметры
- строка
$type - Тип, который может быть 'sslv2', 'sslv3', 'sslv23' или 'tls'.
- строка
$clientOrServerнеобязательно 'client' - Может быть 'client' или 'server'. По умолчанию 'client'.
- булево значение
$enableнеобязательно true - Включить или выключить шифрование. По умолчанию true (включить).
Возвращает
booleanTrue при успехе
Выбрасывает
InvalidArgumentExceptionПри выборе неверного алгоритма шифрования.
SocketExceptionПри попытке включить SSL/TLS.
См. также
stream_socket_enable_cryptolastErrorисходный код public
lastError( )
Получает последнюю ошибку в виде строки.
Возвращает
string|nullПоследняя ошибка
readисходный код public
read( integer $length 1024 )
Читает данные из сокета. Возвращает false, если данные недоступны или подключение не может быть установлено.
Параметры
- целое число
$lengthнеобязательно 1024 - Необязательная длина буфера для чтения; по умолчанию 1024
Возвращает
mixedДанные сокета
resetисходный код public
reset( array $state null )
Сбрасывает состояние экземпляра Socket в его начальное состояние (до выполнения Object::__construct)
Параметры
- массив
$stateнеобязательно null - Массив с ключом и значениями для сброса
Возвращает
booleanTrue при успехе
setLastErrorисходный код public
setLastError( integer $errNum , string $errStr )
Устанавливает последнюю ошибку.
Параметры
- целое число
$errNum - Код ошибки
- строка
$errStr - Строка ошибки
writeисходный код public
write( string $data )
Записывает данные в сокет.
Параметры
- строка
$data - Данные для записи в сокет
Возвращает
booleanУспех
Резюме свойств
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-CakeSocket.html