Spec-Zone.ru › CakePHP 2.8

Класс CakeSocket

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

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

Непосредственные подклассы

  • HttpSocket
Пакет: Cake\Network
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Network/CakeSocket.php

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

  • $_baseConfig protected
    array
    Базовые параметры конфигурации для подключения к сокету
  • $_connectionErrors protected
    array

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

  • $_encryptMethods protected
    array
    Содержит все доступные методы шифрования
  • $config public
    array
    Настройки конфигурации для подключения к сокету
  • $connected public
    boolean
    Это булево значение содержит текущее состояние класса CakeSocket
  • $connection public
    resource
    Ссылка на ресурс подключения к сокету
  • $description public
    string
    Описание объекта
  • $encrypted public
    boolean
    Истина, если поток сокета зашифрован после вызова CakeSocket::enableCrypto()
  • $lastError public
    array
    Эта переменная содержит массив с последним номером ошибки (num) и строкой (str)

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

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

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

  • _setSslContext() protected
    Настройка параметров контекста SSL.
  • address() public
    Получает IP-адрес текущего подключения.
  • addresses() public
    Получает все IP-адреса, связанные с текущим подключением.
  • connect() public
    Подключает сокет к указанному хосту и порту.
  • context() public
    Получает контекст подключения.
  • disconnect() public
    Отключает сокет от текущего подключения.
  • enableCrypto() public
    Шифрует текущий поток сокета, используя один из определенных методов шифрования.
  • host() public
    Получает имя хоста текущего подключения.
  • lastError() public
    Получает последнюю ошибку в виде строки.
  • read() public

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

  • reset() public
    Сбрасывает состояние экземпляра Socket в исходное состояние (до выполнения Object::__construct)
  • setLastError() public
    Устанавливает последнюю ошибку.
  • write() public
    Записывает данные в сокет.

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

__construct()source public

__construct( array $config array() )

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

Параметры

массив $config необязательный array()
Настройка сокета, которая будет слита с базовой настройкой

См. также

CakeSocket::$_baseConfig

__destruct()source public

__destruct( )

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

_connectionErrorHandler()source protected

_connectionErrorHandler( integer $code , string $message )

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

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

Параметры

целое число $code
Код.
строка $message
Сообщение.

_setSslContext()source protected

_setSslContext( string $host )

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

Параметры

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

address()source public

address( )

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

Возвращает

строка
IP-адрес

addresses()source public

addresses( )

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

Возвращает

массив
IP-адреса

connect()source public

connect( )

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

Возвращает

логическое значение
Успех

Выбрасывает

SocketException

context()source public

context( )

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

Возвращает

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

disconnect()source public

disconnect( )

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

Возвращает

логическое значение
Успех

enableCrypto()source public

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

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

Параметры

строка $type
Тип, который может быть одним из 'sslv2', 'sslv3', 'sslv23' или 'tls'.
строка $clientOrServer необязательный 'client'
Может быть 'client' или 'server'. По умолчанию 'client'.
логическое значение $enable необязательный true
Включить или отключить шифрование. По умолчанию включено (true).

Возвращает

логическое значение
Истина при успехе

Выбрасывает

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

См. также

stream_socket_enable_crypto

host()source public

host( )

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

Возвращает

строка
Имя хоста

lastError()source public

lastError( )

Возвращает последнюю ошибку в виде строки.

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

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

read()source public

read( integer $length 1024 )

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

Параметры

integer $length по желанию 1024
Длина буфера для чтения (по желанию), по умолчанию 1024

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

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

reset()source public

reset( array $state null )

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

Параметры

array $state по желанию null
Массив с ключами и значениями для сброса

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

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

setLastError()source public

setLastError( integer $errNum , string $errStr )

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

Параметры

integer $errNum
Код ошибки
string $errStr
Строка ошибки

write()source public

write( string $data )

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

Параметры

string $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.8/class-CakeSocket.html

Spec-Zone.ru

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