TimeoutConnector
in package
implements
ConnectorInterface
FinalYes
Table of Contents
Interfaces
- ConnectorInterface
- The `ConnectorInterface` is responsible for providing an interface for establishing streaming connections, such as a normal TCP/IP connection.
Properties
- $connector : mixed
- $loop : mixed
- $timeout : mixed
Methods
- __construct() : mixed
- connect() : PromiseInterface<string|int, ConnectionInterface>
- Creates a streaming connection to the given remote address
Properties
$connector
private
mixed
$connector
$loop
private
mixed
$loop
$timeout
private
mixed
$timeout
Methods
__construct()
public
__construct(ConnectorInterface $connector, float $timeout[, LoopInterface|null $loop = null ]) : mixed
Parameters
- $connector : ConnectorInterface
- $timeout : float
- $loop : LoopInterface|null = null
connect()
Creates a streaming connection to the given remote address
public
connect(mixed $uri) : PromiseInterface<string|int, ConnectionInterface>
If returns a Promise which either fulfills with a stream implementing
ConnectionInterface on success or rejects with an Exception if the
connection is not successful.
$connector->connect('google.com:443')->then(
function (React\Socket\ConnectionInterface $connection) {
// connection successfully established
},
function (Exception $error) {
// failed to connect due to $error
}
);
The returned Promise MUST be implemented in such a way that it can be cancelled when it is still pending. Cancelling a pending promise MUST reject its value with an Exception. It SHOULD clean up any underlying resources and references as applicable.
$promise = $connector->connect($uri);
$promise->cancel();
Parameters
- $uri : mixed
Return values
PromiseInterface<string|int, ConnectionInterface> —Resolves with a ConnectionInterface on success or rejects with an Exception on error.