Класс Socket

Класс соединения с сокетом сети CakePHP.

Базовый класс ядра для сетевого взаимодействия.

Пространство имён: Cake\Network

Краткое описание свойств

$_config protected

array

Конфигурация выполнения
$_configInitialized protected

bool

Указывает, была ли конфигурация свойства уже настроена с значениями по умолчанию
$_connectionErrors protected

array

Используется для захвата предупреждений о подключении, которые могут возникнуть, например, при ошибках SSL.
$_defaultConfig protected

array

Настройки конфигурации по умолчанию для соединения сокета
$_encryptMethods protected

array

Содержит все доступные методы шифрования
$connected public

bool

Это булево значение содержит текущее состояние класса Socket
$connection public

resource|null

Ссылка на ресурс соединения сокета
$description public

string

Описание объекта
$encrypted public

bool

Истина, если потоковый сокет зашифрован после вызова Cake\Network\Socket::enableCrypto()
$lastError public

array

Эта переменная содержит массив с последним номером ошибки (num) и строкой (str)

Краткое описание методов

__construct() public

Конструктор.
__destruct() public

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

Удаляет один ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_connectionErrorHandler() protected

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

Создаёт клиент потокового сокета. Моковая утилита.
_setSslContext() protected

Настраивает параметры контекста SSL.
address() public

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

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

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

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

Получает контекст подключения.
disconnect() public

Отключает сокет от текущего соединения.
enableCrypto() public

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

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для данного ключа.
host() public

Получает имя хоста текущего соединения.
lastError() public

Получает последнюю ошибку в виде строки.
read() public

Считывает данные из сокета. Возвращает null, если данные недоступны или подключение не может быть установлено.
reset() public

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

Устанавливает конфигурацию.
setLastError() public

Устанавливает последнюю ошибку.
write() public

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

END_OF_DOCUMENT_MARKER

Подробное описание методов

__construct() public

__construct(array $config = [])

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

Параметры

array $config необязательно: Настройка сокета, которая будет объединена с базовой настройкой.

См. также

\Cake\Network\Socket::$_baseConfig

__destruct() public

__destruct()

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

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Выбрасывает

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

_configRead() protected

_configRead(string|null $key): mixed

Читает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge необязательно: true для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Выбрасывает

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

_connectionErrorHandler() protected

_connectionErrorHandler(int $code, string $message): void

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

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

Параметры

int $code: Номер кода.
string $message: Сообщение.

Возвращает

void

_getStreamSocketClient() protected

_getStreamSocketClient(string $remoteSocketTarget, int $errNum, string $errStr, int $timeout, int $connectAs, resource $context): resource|null

Создаёт клиент потокового сокета. Утилита моделирования.

Параметры

string $remoteSocketTarget: удаленный сокет
int $errNum: номер ошибки
string $errStr: строка ошибки
int $timeout: таймаут
int $connectAs: флаги
resource $context: контекст

Возвращает

resource|null

_setSslContext() protected

_setSslContext(string $host): void

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

Параметры

string $host: Имя хоста, к которому осуществляется подключение.

Возвращает

void

address() public

address(): string

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

Возвращает

string

addresses() public

addresses(): array

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

Возвращает

array

configShallow() public

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

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

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

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

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

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

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

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

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно: Значение для установки.

Возвращает

$this

connect() public

connect(): bool

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

enableCrypto(string $type, string $clientOrServer = 'client', bool $enable = true): void

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

Параметры

string $type: может быть 'ssl2', 'ssl3', 'ssl23' или 'tls'
string $clientOrServer необязательно: может быть 'client' или 'server'. По умолчанию 'client'
bool $enable необязательно: включить или отключить шифрование. По умолчанию true (включить)

Возвращает

void

Выбрасывает

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

См. также

stream_socket_enable_crypto

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

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

Чтение всей конфигурации:

$this->getConfig();

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

$this->getConfig('key');

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

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

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key необязательно: Ключ для получения или null для всей конфигурации.
mixed $default необязательно: Значение возврата, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для этого конкретного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

read(int $length = 1024): string|null

Считать данные из сокета. Возвращает null, если данные недоступны или подключение не может быть установлено.

Параметры

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

Возвращает

string|null

reset() public

reset(array|null $state = null): void

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

Параметры

array|null $state необязательно: Массив с ключами и значениями для сброса

Возвращает

void

setConfig() public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

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

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

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

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

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

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

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

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно: Значение для установки.
bool $merge необязательно: Производить рекурсивное объединение или перезапись существующей конфигурации. По умолчанию true.

Возвращает

$this

Выбрасывает

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

setLastError() public

setLastError(int|null $errNum, string $errStr): void

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

Параметры

int|null $errNum: Код ошибки
string $errStr: Текст ошибки

Возвращает

void

write() public

write(string $data): int

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

Параметры

string $data: Данные для записи в сокет.

Возвращает

int

array

© 2005–present 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.
https://api.cakephp.org/4.2/class-Cake.Network.Socket.html