Class Socket

Properties summary

• $_config protected
  array

  Runtime config

• $_configInitialized protected
  bool

  Whether the config property has already been configured with defaults

• $_connectionErrors protected
  array

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

• $_defaultConfig protected
  array

  Default configuration settings for the socket connection

• $_encryptMethods protected
  array

  Contains all the encryption methods available

• $connected public
  bool

  This boolean contains the current state of the Socket class

• $connection public
  resource|null

  Reference to socket connection resource

• $description public
  string

  Object description

• $encrypted public
  bool

  True if the socket stream is encrypted after a Cake\Network\Socket::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.

• _configDelete() protected

  Deletes a single config key.

• _configRead() protected

  Reads a config key.

• _configWrite() protected

  Writes a config key.

• _connectionErrorHandler() protected

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

• _getStreamSocketClient() protected

  Create a stream socket client. Mock utility.

• _setSslContext() protected

  Configure the SSL context options.

• address() public

  Get the IP address of the current connection.

• addresses() public

  Get all IP addresses associated with the current connection.

• configShallow() public

  Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

• connect() public

  Connect the socket to the given host and port.

• context() public

  Get the connection context.

• disconnect() public

  Disconnect the socket from the current connection.

• enableCrypto() public

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

• getConfig() public

  Returns the config.

• getConfigOrFail() public

  Returns the config for this specific key.

• host() public

  Get the host name of the current connection.

• lastError() public

  Get the last error as a string.

• read() public

  Read data from the socket. Returns null 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)

• setConfig() public

  Sets the config.

• setLastError() public

  Set the last error.

• write() public

  Write data to the socket.

Method Detail

__construct(array $config)

__destruct()

_configDelete(string $key)

_configRead(?string $key)

_configWrite(mixed $key, mixed $value, mixed $merge)

_connectionErrorHandler(int $code, string $message)

_getStreamSocketClient(mixed $remoteSocketTarget, mixed $errNum, mixed $errStr, mixed $timeout, mixed $connectAs, mixed $context)

_setSslContext(string $host)

address()

addresses()

configShallow(mixed $key, mixed $value)

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

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

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

connect()

context()

disconnect()

enableCrypto(string $type, string $clientOrServer, bool $enable)

getConfig(?string $key, mixed $default)

$this->getConfig();

$this->getConfig('key');

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

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

getConfigOrFail(string $key)

host()

lastError()

read(int $length)

reset(?array $state)

setConfig(mixed $key, mixed $value, mixed $merge)

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

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

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

setLastError(?int $errNum, string $errStr)

write(string $data)

Property Detail