Connection
class Connection extends Connection
Traits
Properties
| protected int|null | $lastSeenAt | The last time the connection was seen. |
from Connection |
| protected bool | $hasBeenPinged | Stores the ping state of the connection. |
from Connection |
| protected bool | $usesControlFrames | Indicates if the connection uses control frames. |
from Connection |
| protected bool | $connectionSlotAcquired | Whether a connection slot was acquired for this connection. |
from Connection |
| protected bool | $disconnecting | Whether this connection is being cleaned up after a transport disconnect. |
from Connection |
| protected string|null | $id | The normalized socket ID. |
Methods
Create a new connection instance.
Get the raw socket connection identifier.
Get the normalized socket ID.
Send a message to the connection.
Send a control frame to the connection.
Terminate a connection.
Disconnect and unsubscribe from all channels.
Mark the connection as using control frames to track activity.
Whether a connection slot was acquired for this connection.
Mark that a connection slot was acquired for this connection.
Details
in
Connection at line 46
__construct(WebSocketConnection $connection, Application $application, string|null $origin)
Create a new connection instance.
at line 23
string
identifier()
Get the raw socket connection identifier.
at line 31
string
id()
Get the normalized socket ID.
at line 43
void
send(string $message)
Send a message to the connection.
at line 55
void
control(int $opcode = WEBSOCKET_OPCODE_PING)
Send a control frame to the connection.
at line 63
void
terminate(int|null $code = null, string|null $reason = null)
Terminate a connection.
in
Connection at line 82
Application
app()
Get the application the connection belongs to.
in
Connection at line 90
string|null
origin()
Get the origin of the connection.
in
Connection at line 98
void
ping()
Mark the connection as pinged.
in
Connection at line 106
void
pong()
Mark the connection as ponged.
in
Connection at line 114
int|null
lastSeenAt()
Get the last time the connection was seen.
in
Connection at line 122
Connection
setLastSeenAt(int $time)
Set the connection last seen at timestamp.
in
Connection at line 132
Connection
touch()
Touch the connection last seen at timestamp.
in
Connection at line 143
void
disconnect(int|null $code = null, string|null $reason = null)
Disconnect and unsubscribe from all channels.
in
Connection at line 151
bool
isActive()
Determine whether the connection is still active.
in
Connection at line 159
bool
isInactive()
Determine whether the connection is inactive.
in
Connection at line 167
bool
isStale()
Determine whether the connection is stale.
in
Connection at line 175
bool
usesControlFrames()
Determine whether the connection uses control frames.
in
Connection at line 183
Connection
setUsesControlFrames(bool $usesControlFrames = true)
Mark the connection as using control frames to track activity.
in
Connection at line 193
bool
hasAcquiredConnectionSlot()
Whether a connection slot was acquired for this connection.
in
Connection at line 201
void
markConnectionSlotAcquired()
Mark that a connection slot was acquired for this connection.
in
Connection at line 209
void
clearConnectionSlotAcquired()
Clear the connection slot acquired flag.
in
Connection at line 217
void
markDisconnecting()
Mark the connection as disconnecting (transport closed).
in
Connection at line 225
bool
isDisconnecting()
Determine whether the connection is disconnecting.
in
GeneratesIdentifiers at line 12
protected string
generateId()
Generate a Pusher-compatible socket ID.