Class CakeSocket

Properties summary

• $_baseConfig protected
  array
  Base configuration settings for the socket connection
• $_connectionErrors protected
  array

  Used to capture connection warnings which can happen when there are SSL errors for example.

• $_encryptMethods protected
  array
  Contains all the encryption methods available
• $config public
  array
  Configuration settings for the socket connection
• $connected public
  boolean
  This boolean contains the current state of the CakeSocket class
• $connection public
  resource
  Reference to socket connection resource
• $description public
  string
  Object description
• $encrypted public
  boolean
  True if the socket stream is encrypted after a CakeSocket::enableCrypto() call
• $lastError public
  array
  This variable contains an array with the last error number (num) and string (str)

Method Summary

• __construct() public

  Constructor.

• __destruct() public

  Destructor, used to disconnect from current connection.

• _connectionErrorHandler() protected

  socket_stream_client() does not populate errNum, or $errStr when there are connection errors, as in the case of SSL verification failure.

• _setSslContext() protected

  Configure the SSL context options.

• address() public

  Gets the IP address of the current connection.

• addresses() public

  Gets all IP addresses associated with the current connection.

• connect() public

  Connects the socket to the given host and port.

• context() public

  Gets the connection context.

• disconnect() public

  Disconnects the socket from the current connection.

• enableCrypto() public

  Encrypts current stream socket, using one of the defined encryption methods.

• host() public

  Gets the host name of the current connection.

• lastError() public

  Gets the last error as a string.

• read() public

  Reads data from the socket. Returns false if no data is available or no connection could be established.

• reset() public

  Resets the state of this Socket instance to it's initial state (before Object::__construct got executed)

• setLastError() public

  Sets the last error.

• write() public

  Writes data to the socket.

Method Detail

Properties detail

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

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
)

array()

false

null

'Remote DataSource Network Socket Interface'

false

array()