Класс Socket

__constructsource public

__construct( array $config [] )

Конструктор.

Параметры

массив $config необязательно []

Настройка сокета, которая будет слита с базовой конфигурацией

См. также

Socket::$_baseConfig

__destructsource public

__destruct( )

Деструктор, используемый для отключения от текущего соединения.

_connectionErrorHandlersource protected

_connectionErrorHandler( integer $code , string $message )

socket_stream_client() не заполняет errNum или $errStr при ошибках соединения, как, например, при ошибке проверки SSL.

Вместо этого нам нужно обработать эти ошибки вручную.

Параметры

целое число $code

Код ошибки.

строка $message

Сообщение.

_setSslContextsource protected

_setSslContext( string $host )

Настройка параметров контекста SSL.

Параметры

строка $host

Имя хоста, к которому выполняется подключение.

addresssource public

address( )

Получить IP-адрес текущего соединения.

Возвращает

string
IP-адрес

addressessource public

addresses( )

Получить все IP-адреса, связанные с текущим соединением.

Возвращает

array
IP-адреса

connectsource public

connect( )

Подключить сокет к указанному хосту и порту.

Возвращает

boolean
Успех

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

contextsource public

context( )

Получить контекст подключения.

Возвращает

null|array
Null, если нет подключения, массив, если есть.

disconnectsource public

disconnect( )

Отключить сокет от текущего соединения.

Возвращает

boolean
Успех

enableCryptosource public

enableCrypto( string $type , string $clientOrServer 'client' , boolean $enable true )

Шифрует текущий сокет потока, используя один из определенных методов шифрования.

Параметры

строка $type

может быть одной из 'ssl2', 'ssl3', 'ssl23' или 'tls'

строка $clientOrServer необязательно 'client'

может быть одной из 'client', 'server'. По умолчанию 'client'

логическое значение $enable необязательно true

включить или отключить шифрование. По умолчанию включено (true)

Возвращает

boolean
True в случае успеха

Исключения

InvalidArgumentException
При выборе неверного метода шифрования.
Cake\Network\Exception\SocketException
При попытке включить SSL/TLS

См. также

stream_socket_enable_crypto

hostsource public

host( )

Получить имя хоста текущего подключения.

Возвращает

string
Имя хоста

lastErrorsource public

lastError( )

Получить последнюю ошибку в виде строки.

Возвращает

string|null
Последняя ошибка

readsource public

read( integer $length 1024 )

Прочитать данные из сокета. Возвращает false, если данные недоступны или подключение не удалось установить.

Параметры

целое число $length необязательно 1024

Необязательная длина буфера для чтения; по умолчанию 1024

Возвращает

mixed
Данные сокета

resetsource public

reset( array $state null )

Сбрасывает состояние экземпляра Socket до первоначального состояния (до выполнения Object::__construct).

Параметры

массив $state необязательно null

Массив с ключами и значениями для сброса

Возвращает

boolean
True в случае успеха

setLastErrorsource public

setLastError( integer $errNum , string $errStr )

Установить последнюю ошибку.

Параметры

целое число $errNum

Код ошибки

строка $errStr

Строка ошибки

writesource public

write( string $data )

Записать данные в сокет.

Параметры

строка $data

Данные для записи в сокет

Возвращает

boolean
Успех

_configDeletesource protected

_configDelete( string $key )

Удалить отдельный ключ конфигурации

Параметры

строка $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
если происходит попытка перезаписи существующей конфигурации

_configReadsource protected

_configRead( string|null $key )

Прочитать переменную конфигурации

Параметры

строка|null $key

Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Записать переменную конфигурации

Параметры

строка|массив $key

Ключ для записи.

смешанный тип $value

Значение для записи.

логическое значение|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
если происходит попытка перезаписи существующей конфигурации

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всего конфига:

$this->config();

Чтение определённого значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определённого значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфига одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array|null $key необязательно null

Ключ для получения/установки или полный массив настроек.

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное слияние или перезаписывать существующий конфиг, по умолчанию true.

Возвращаемое значение

mixed
Значение конфига, которое читается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

Объединяет предоставленный конфиг с существующим. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определённого значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфига одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив настроек.

mixed|null $value необязательно null

Значение для установки.

Возвращаемое значение

mixed
$this Сам объект.

[]

[
    'persistent' => false,
    'host' => 'localhost',
    'protocol' => 'tcp',
    'port' => 80,
    'timeout' => 30
]

[
    // @codingStandardsIgnoreStart
    'sslv2_client' => STREAM_CRYPTO_METHOD_SSLv2_CLIENT,
    'sslv3_client' => STREAM_CRYPTO_METHOD_SSLv3_CLIENT,
    'sslv23_client' => STREAM_CRYPTO_METHOD_SSLv23_CLIENT,
    'tls_client' => STREAM_CRYPTO_METHOD_TLS_CLIENT,
    'sslv2_server' => STREAM_CRYPTO_METHOD_SSLv2_SERVER,
    'sslv3_server' => STREAM_CRYPTO_METHOD_SSLv3_SERVER,
    'sslv23_server' => STREAM_CRYPTO_METHOD_SSLv23_SERVER,
    'tls_server' => STREAM_CRYPTO_METHOD_TLS_SERVER
    // @codingStandardsIgnoreEnd
]

false

null

'Remote DataSource Network Socket Interface'

false

[]

[]

false