Skip to content

Commit

Permalink
Update exception docblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
trowski committed Dec 28, 2023
1 parent 3f20dab commit 5c076e4
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/WebsocketMessage.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public function isBinary(): bool
}

/**
* @throws StreamException
* @throws WebsocketClosedException
*/
public function read(?Cancellation $cancellation = null): ?string
{
Expand All @@ -79,7 +79,7 @@ public function read(?Cancellation $cancellation = null): ?string
* Buffer the entire message contents. Note that the given size limit may not be reached if a smaller message size
* limit has been imposed by {@see Rfc6455Client::$messageSizeLimit}.
*
* @throws BufferException|StreamException
* @throws WebsocketClosedException|BufferException
* @see Payload::buffer()
*/
public function buffer(?Cancellation $cancellation = null, int $limit = \PHP_INT_MAX): string
Expand Down Expand Up @@ -116,7 +116,10 @@ public function getIterator(): \Traversable
}

/**
* @throws BufferException|StreamException
* Buffers entire stream before returning. Use {@see self::buffer()} to optionally provide a {@see Cancellation}
* and/or length limit.
*
* @throws WebsocketClosedException|BufferException
*/
public function __toString(): string
{
Expand Down

0 comments on commit 5c076e4

Please sign in to comment.