Class Socket
CakePHP network socket connection class.
Core base class for network communication.
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_connectionErrors protected
arrayUsed to capture connection warnings which can happen when there are SSL errors for example.
-
$_defaultConfig protected
arrayDefault configuration settings for the socket connection
-
$_encryptMethods protected
arrayContains all the encryption methods available
-
$connected public
boolThis boolean contains the current state of the Socket class
-
$connection public
resourceReference to socket connection resource
-
$description public
stringObject description
-
$encrypted public
boolTrue if the socket stream is encrypted after a Cake\Network\Socket::enableCrypto() call
-
$lastError public
arrayThis 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
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_connectionErrorHandler() protected
socket_stream_client() does not populate errNum, or $errStr when there are connection errors, as in the case of SSL verification failure.
-
address() public
Get the IP address of the current connection.
-
addresses() public
Get all IP addresses associated with the current connection.
-
config() public
Usage
-
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
-
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 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
Set the last error.
-
write() public
Write data to the socket.
Method Detail
__construct() ¶ public
__construct(array $config = [])Constructor.
Parameters
-
array$config optional Socket configuration, which will be merged with the base configuration
See Also
_configDelete() ¶ protected
_configDelete(string $key): voidDelete a single config key
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
Parameters
-
string|array$key Key to write to.
-
mixed$value Value to write.
-
bool|string$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_connectionErrorHandler() ¶ protected
_connectionErrorHandler(int $code, string $message): voidsocket_stream_client() does not populate errNum, or $errStr when there are connection errors, as in the case of SSL verification failure.
Instead we need to handle those errors manually.
Parameters
-
int$code Code number.
-
string$message Message.
Returns
voidaddress() ¶ public
address(): stringGet the IP address of the current connection.
Returns
stringIP address
addresses() ¶ public
addresses(): arrayGet all IP addresses associated with the current connection.
Returns
arrayIP addresses
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array|null$key optional The key to get/set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisThe object itself.
connect() ¶ public
connect(): boolConnect the socket to the given host and port.
Returns
boolSuccess
Throws
Cake\Network\Exception\SocketExceptioncontext() ¶ public
context(): null|arrayGet the connection context.
Returns
null|arrayNull when there is no connection, an array when there is.
disconnect() ¶ public
disconnect(): boolDisconnect the socket from the current connection.
Returns
boolSuccess
enableCrypto() ¶ public
enableCrypto(string $type, string $clientOrServer = 'client', bool $enable = true): boolEncrypts current stream socket, using one of the defined encryption methods
Parameters
-
string$type can be one of 'ssl2', 'ssl3', 'ssl23' or 'tls'
-
string$clientOrServer optional can be one of 'client', 'server'. Default is 'client'
-
bool$enable optional enable or disable encryption. Default is true (enable)
Returns
boolTrue on success
Throws
InvalidArgumentExceptionWhen an invalid encryption scheme is chosen.
Cake\Network\Exception\SocketExceptionWhen attempting to enable SSL/TLS fails
See Also
host() ¶ public
host(): stringGet the host name of the current connection.
Returns
stringHost name
lastError() ¶ public
lastError(): string|nullGet the last error as a string.
Returns
string|nullLast error
read() ¶ public
read(int $length = 1024): mixedRead data from the socket. Returns false if no data is available or no connection could be established.
Parameters
-
int$length optional Optional buffer length to read; defaults to 1024
Returns
mixedSocket data
reset() ¶ public
reset(array $state = null): boolResets the state of this Socket instance to it's initial state (before Object::__construct got executed)
Parameters
-
array$state optional Array with key and values to reset
Returns
boolTrue on success
setLastError() ¶ public
setLastError(int $errNum, string $errStr): voidSet the last error.
Parameters
-
int$errNum Error code
-
string$errStr Error string
Returns
voidwrite() ¶ public
write(string $data): boolWrite data to the socket.
Parameters
-
string$data The data to write to the socket
Returns
boolSuccess
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_connectionErrors ¶ protected
Used to capture connection warnings which can happen when there are SSL errors for example.
Type
array$encrypted ¶ public
True if the socket stream is encrypted after a Cake\Network\Socket::enableCrypto() call
Type
bool$lastError ¶ public
This variable contains an array with the last error number (num) and string (str)
Type
array