Spec-Zone.ru › CakePHP 2.7

Класс CakeSocket

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

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

Прямые известные подклассы

HttpSocket
Пакет: Cake\Сеть
Авторские права: 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-адрес текущего соединения.

Возвращает

string
IP-адрес

addressesисходный код public

addresses( )

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

Возвращает

array
IP-адреса

connectисходный код public

connect( )

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

Возвращает

boolean
Успех

Выбрасывает

SocketException
SocketException

contextисходный код public

context( )

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

Возвращает

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

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 (включить).

Возвращает

boolean
True при успехе

Выбрасывает

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

См. также

stream_socket_enable_crypto

hostисходный код public

host( )

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

Возвращает

string
Имя хоста

lastErrorисходный код 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
Массив с ключом и значениями для сброса

Возвращает

boolean
True при успехе

setLastErrorисходный код public

setLastError( integer $errNum , string $errStr )

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

Параметры

целое число $errNum
Код ошибки
строка $errStr
Строка ошибки

writeисходный код public

write( string $data )

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

Параметры

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

Возвращает

boolean
Успех

Резюме свойств

$_baseConfigsource

protected array

Основные параметры конфигурации для подключения к сокету

array(
    'persistent' => false,
    'host' => 'localhost',
    'protocol' => 'tcp',
    'port' => 80,
    'timeout' => 30
)

$_connectionErrorssource

protected array

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

array()

$_encryptMethodssource

protected array

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

array(
    // @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
)

$configsource

public array

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

array()

$connectedsource

public boolean

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

false

$connectionsource

public resource

Ссылка на ресурс подключения к сокету

null

$descriptionsource

public string

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

'Remote DataSource Network Socket Interface'

$encryptedsource

public boolean

Истинно, если поток сокета зашифрован после вызова CakeSocket::enableCrypto()

false

$lastErrorsource

public array

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

array()

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API