1. class
  2. Hypervel
  3. \
  4. Reverb
  5. \
  6. Connection

Connection

class Connection extends Connection

Traits

GeneratesIdentifiers

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 $established

Whether the Pusher connection handshake completed.

 from  Connection
protected bool $connectionSlotAcquired

Whether a connection slot was acquired for this connection.

 from  Connection
protected bool $rateLimiterInitialized

Whether message rate-limiter state was initialized.

 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

__construct(WebSocketConnection $connection, Application $application, string|null $origin)

Create a new connection instance.

from  Connection
string
identifier()

Get the raw socket connection identifier.

string
id()

Get the normalized socket ID.

void
send(string $message)

Send a message to the connection.

void
control(int $opcode = WEBSOCKET_OPCODE_PING)

Send a control frame to the connection.

void
terminate(int|null $code = null, string|null $reason = null)

Terminate a connection.

Application
app()

Get the application the connection belongs to.

from  Connection
string|null
origin()

Get the origin of the connection.

from  Connection
void
ping()

Mark the connection as pinged.

from  Connection
void
pong()

Mark the connection as ponged.

from  Connection
int|null
lastSeenAt()

Get the last time the connection was seen.

from  Connection
Connection
setLastSeenAt(int $time)

Set the connection last seen at timestamp.

from  Connection
Connection
touch()

Touch the connection last seen at timestamp.

from  Connection
void
disconnect(int|null $code = null, string|null $reason = null)

Disconnect and unsubscribe from all channels.

from  Connection
bool
isActive()

Determine whether the connection is still active.

from  Connection
bool
isInactive()

Determine whether the connection is inactive.

from  Connection
bool
isStale()

Determine whether the connection is stale.

from  Connection
bool
usesControlFrames()

Determine whether the connection uses control frames.

from  Connection
Connection
setUsesControlFrames(bool $usesControlFrames = true)

Mark the connection as using control frames to track activity.

from  Connection
bool
isEstablished()

Determine whether the connection handshake completed.

from  Connection
void
markEstablished()

Mark the connection as established.

from  Connection
bool
hasAcquiredConnectionSlot()

Whether a connection slot was acquired for this connection.

from  Connection
void
markConnectionSlotAcquired()

Mark that a connection slot was acquired for this connection.

from  Connection
void
clearConnectionSlotAcquired()

Clear the connection slot acquired flag.

from  Connection
bool
hasInitializedRateLimiter()

Determine whether rate-limiter state was initialized.

from  Connection
void
markRateLimiterInitialized()

Mark the rate limiter as initialized.

from  Connection
void
clearRateLimiterInitialized()

Clear the rate-limiter initialized flag.

from  Connection
void
markDisconnecting()

Mark the connection as disconnecting (transport closed).

from  Connection
bool
isDisconnecting()

Determine whether the connection is disconnecting.

from  Connection
string
generateId()

Generate a Pusher-compatible socket ID.

from  GeneratesIdentifiers

Details

in Connection at line 56
__construct(WebSocketConnection $connection, Application $application, string|null $origin)

Create a new connection instance.

Parameters

WebSocketConnection $connection
Application $application
string|null $origin

at line 23
string identifier()

Get the raw socket connection identifier.

Return Value

string

at line 31
string id()

Get the normalized socket ID.

Return Value

string

at line 43
void send(string $message)

Send a message to the connection.

Parameters

string $message

Return Value

void

at line 55
void control(int $opcode = WEBSOCKET_OPCODE_PING)

Send a control frame to the connection.

Parameters

int $opcode

Return Value

void

at line 63
void terminate(int|null $code = null, string|null $reason = null)

Terminate a connection.

Parameters

int|null $code
string|null $reason

Return Value

void

in Connection at line 92
Application app()

Get the application the connection belongs to.

Return Value

Application

in Connection at line 100
string|null origin()

Get the origin of the connection.

Return Value

string|null

in Connection at line 108
void ping()

Mark the connection as pinged.

Return Value

void

in Connection at line 116
void pong()

Mark the connection as ponged.

Return Value

void

in Connection at line 124
int|null lastSeenAt()

Get the last time the connection was seen.

Return Value

int|null

in Connection at line 132
Connection setLastSeenAt(int $time)

Set the connection last seen at timestamp.

Parameters

int $time

Return Value

Connection

in Connection at line 142
Connection touch()

Touch the connection last seen at timestamp.

Return Value

Connection

in Connection at line 153
void disconnect(int|null $code = null, string|null $reason = null)

Disconnect and unsubscribe from all channels.

Parameters

int|null $code
string|null $reason

Return Value

void

in Connection at line 161
bool isActive()

Determine whether the connection is still active.

Return Value

bool

in Connection at line 169
bool isInactive()

Determine whether the connection is inactive.

Return Value

bool

in Connection at line 177
bool isStale()

Determine whether the connection is stale.

Return Value

bool

in Connection at line 185
bool usesControlFrames()

Determine whether the connection uses control frames.

Return Value

bool

in Connection at line 193
Connection setUsesControlFrames(bool $usesControlFrames = true)

Mark the connection as using control frames to track activity.

Parameters

bool $usesControlFrames

Return Value

Connection

in Connection at line 203
bool isEstablished()

Determine whether the connection handshake completed.

Return Value

bool

in Connection at line 211
void markEstablished()

Mark the connection as established.

Return Value

void

in Connection at line 219
bool hasAcquiredConnectionSlot()

Whether a connection slot was acquired for this connection.

Return Value

bool

in Connection at line 227
void markConnectionSlotAcquired()

Mark that a connection slot was acquired for this connection.

Return Value

void

in Connection at line 235
void clearConnectionSlotAcquired()

Clear the connection slot acquired flag.

Return Value

void

in Connection at line 243
bool hasInitializedRateLimiter()

Determine whether rate-limiter state was initialized.

Return Value

bool

in Connection at line 251
void markRateLimiterInitialized()

Mark the rate limiter as initialized.

Return Value

void

in Connection at line 259
void clearRateLimiterInitialized()

Clear the rate-limiter initialized flag.

Return Value

void

in Connection at line 267
void markDisconnecting()

Mark the connection as disconnecting (transport closed).

Return Value

void

in Connection at line 275
bool isDisconnecting()

Determine whether the connection is disconnecting.

Return Value

bool

in GeneratesIdentifiers at line 12
protected string generateId()

Generate a Pusher-compatible socket ID.

Return Value

string