Documentation / Connection

Websocket: Connection

A Connection represents the actual connection between client and server. The Client only has a single Connection. The Server can have zero to many Connections.

The Connection instances are typically exposed in Listeners callbacks.

Sending messages

To send a message on connection, call the send() method with a Message instance. Any of the five message types can be sent this way.

$connection->send(new WebSocket\Message\Text("Server sends a message"));
$connection->send(new WebSocket\Message\Binary($binary));
$connection->send(new WebSocket\Message\Ping("My ping"));
$connection->send(new WebSocket\Message\Text("My pong"));
$connection->send(new WebSocket\Message\Close(1000, "Closing now"));

There are also convenience methods available for all types.

$connection->text("Server sends a message");
$connection->binary($binary);
$connection->ping("My ping");
$connection->pong("My pong");
$connection->close(1000, "Closing now");

Connection management

// Is connection open?
$connection->isConnected();

// Is connection readable?
$connection->isReadable();

// Is connection writable?
$connection->isWritable();

// Immediately disconnect client without normal close procedure
$connection->disconnect();

// Close connection for reading (may disconnect if already closed for writing)
$connection->closeRead();

// Close connection for writing (may disconnect if already closed for reading)
$connection->closeWrite();

Connection state

// Get local name for connection
$connection->getName();

// Get remote name for connection
$connection->getRemoteName();

// Get and set associated meta data on connection
$connection->setMeta('myMetaData', $anything);
$anything = $connection->getMeta('myMetaData');

// Trigger a tick event on connection
$connection->tick();

Handshake result

// Get the Request sent during handshake procedure
$connection->getHandshakeRequest();

// Get the Response sent during handshake procedure
$connection->getHandshakeResponse();

Configuration

Configuration is normally inherited from Client or Sever, but can also be explicitly set.

$configuration = $connection->getConfiguration();
$connection->setConfiguration($configuration);

Read more on Configuration.

Context

Connection exposes context options and parameters using the Phrity\Net\Context class.

$context = $connection->getContext();
$context->getOption("ssl", "verify_peer");
$context->setOption("ssl", "verify_peer", false);