__construct()source public

__construct( array $config [] )

Constructor.

Parameters

array $config optional []

Socket configuration, which will be merged with the base configuration

See

\Cake\Network\Socket::$_baseConfig

__destruct()source public

__destruct( )

Destructor, used to disconnect from current connection.

_connectionErrorHandler()source protected

_connectionErrorHandler( integer $code , string $message )

socket_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

integer $code

Code number.

string $message

Message.

_setSslContext()source protected

_setSslContext( string $host )

Configure the SSL context options.

Parameters

string $host

The host name being connected to.

address()source public

address( )

Get the IP address of the current connection.

Returns

string
IP address

addresses()source public

addresses( )

Get all IP addresses associated with the current connection.

Returns

array
IP addresses

connect()source public

connect( )

Connect the socket to the given host and port.

Returns

boolean
Success

Throws

Cake\Network\Exception\SocketException

context()source public

context( )

Get the connection context.

Returns

null|array
Null when there is no connection, an array when there is.

disconnect()source public

disconnect( )

Disconnect the socket from the current connection.

Returns

boolean
Success

enableCrypto()source public

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

Encrypts 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 'client'

can be one of 'client', 'server'. Default is 'client'

boolean $enable optional true

enable or disable encryption. Default is true (enable)

Returns

boolean
True on success

Throws

InvalidArgumentException
When an invalid encryption scheme is chosen.
Cake\Network\Exception\SocketException
When attempting to enable SSL/TLS fails

See

stream_socket_enable_crypto

host()source public

host( )

Get the host name of the current connection.

Returns

string
Host name

lastError()source public

lastError( )

Get the last error as a string.

Returns

string|null
Last error

read()source public

read( integer $length 1024 )

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

Parameters

integer $length optional 1024

Optional buffer length to read; defaults to 1024

Returns

mixed
Socket data

reset()source public

reset( array|null $state null )

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

Parameters

array|null $state optional null

Array with key and values to reset

Returns

boolean
True on success

setLastError()source public

setLastError( integer $errNum , string $errStr )

Set the last error.

Parameters

integer $errNum

Error code

string $errStr

Error string

write()source public

write( string $data )

Write data to the socket.

Parameters

string $data

The data to write to the socket

Returns

boolean
Success

_configDelete()source protected

_configDelete( string $key )

Delete a single config key

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Write a config variable

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Usage

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 null

The key to get/set, or a complete array of configs.

mixed|null $value optional null

The value to set.

boolean $merge optional true

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow()source public

configShallow( string|array $key , mixed|null $value null )

Merge 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 null

The value to set.

Returns

$this The object itself.

[]

[
    'persistent' => false,
    'host' => 'localhost',
    'protocol' => 'tcp',
    'port' => 80,
    'timeout' => 30
]

[
    // @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
]

false

null

'Remote DataSource Network Socket Interface'

false

[]