vendor/gos/web-socket-bundle/src/Client/ClientStorageInterface.php line 10

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Gos\Bundle\WebSocketBundle\Client;
  5. use Gos\Bundle\WebSocketBundle\Client\Exception\ClientNotFoundException;
  6. use Gos\Bundle\WebSocketBundle\Client\Exception\StorageException;
  7. use Ratchet\ConnectionInterface;
  8. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  10. trigger_deprecation('gos/web-socket-bundle', '3.11', 'The "%s" interface is deprecated and will be removed in 4.0, use the new websocket authentication API instead.', ClientStorageInterface::class);
  12. /**
  13.  * @deprecated to be removed in 4.0, use the new websocket authentication API instead
  14.  *
  15.  * @method void removeAllClients()
  16.  */
  17. interface ClientStorageInterface
  18. {
  19.     /**
  20.      * @throws ClientNotFoundException if the specified client could not be found
  21.      * @throws StorageException        if the client could not be read from storage
  22.      */
  23.     public function getClient(string $identifier): TokenInterface;
  25.     public function getStorageId(ConnectionInterface $conn): string;
  27.     /**
  28.      * @throws StorageException if the client could not be saved to storage
  29.      */
  30.     public function addClient(string $identifier, TokenInterface $token): void;
  32.     /**
  33.      * @throws StorageException if there was an error reading from storage
  34.      */
  35.     public function hasClient(string $identifier): bool;
  37.     /**
  38.      * @throws StorageException if there was an error removing the client from storage
  39.      */
  40.     public function removeClient(string $identifier): bool;
  41. }