ConnectorInterface
in
The `ConnectorInterface` is responsible for providing an interface for establishing streaming connections, such as a normal TCP/IP connection.
This is the main interface defined in this package and it is used throughout React's vast ecosystem.
Most higher-level components (such as HTTP, database or other networking service clients) accept an instance implementing this interface to create their TCP/IP connection to the underlying networking service. This is usually done via dependency injection, so it's fairly simple to actually swap this implementation against any other implementation of this interface.
The interface only offers a single connect() method.
Tags
Table of Contents
Methods
- connect() : PromiseInterface<string|int, ConnectionInterface>
- Creates a streaming connection to the given remote address
Methods
connect()
Creates a streaming connection to the given remote address
public
connect(string $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 : string
Tags
Return values
PromiseInterface<string|int, ConnectionInterface> —Resolves with a ConnectionInterface on success or rejects with an Exception on error.