Overview

Namespaces

  • Evenement
  • None
  • PHP
  • Psr
    • Http
      • Message
  • Ratchet
    • Http
    • RFC6455
      • Handshake
      • Messaging
    • Server
    • Session
      • Serialize
      • Storage
        • Proxy
    • Wamp
    • WebSocket
  • React
    • EventLoop
      • Tick
      • Timer
    • Socket
    • Stream
  • Symfony
    • Component
      • HttpFoundation
        • Session
          • Attribute
          • Flash
          • Storage
            • Handler
            • Proxy
      • Routing
        • Annotation
        • Exception
        • Generator
          • Dumper
        • Loader
          • DependencyInjection
        • Matcher
          • Dumper
        • Tests
          • Annotation
          • Fixtures
            • AnnotatedClasses
            • OtherAnnotatedClasses
          • Generator
            • Dumper
          • Loader
          • Matcher
            • Dumper

Classes

  • ServerProtocol
  • Topic
  • TopicManager
  • WampConnection
  • WampServer

Interfaces

  • WampServerInterface

Exceptions

  • Exception
  • JsonException
  • Overview
  • Namespace
  • Class
  • Tree

Interface WampServerInterface

An extension of Ratchet\ComponentInterface to server a WAMP application onMessage is replaced by various types of messages for this protocol (pub/sub or rpc)

Ratchet\Wamp\WampServerInterface implements Ratchet\ComponentInterface

Direct known implementers

Ratchet\Wamp\TopicManager
Namespace: Ratchet\Wamp
Located at Ratchet/Wamp/WampServerInterface.php
Methods summary
public
# onCall( Ratchet\ConnectionInterface $conn, string $id, string|Ratchet\Wamp\Topic $topic, array $params )

An RPC call has been received

An RPC call has been received

Parameters

$conn
Ratchet\ConnectionInterface
$conn
$id
string
$id The unique ID of the RPC, required to respond to
$topic
string|Ratchet\Wamp\Topic
$topic The topic to execute the call against
$params
array
$params Call parameters received from the client
public
# onSubscribe( Ratchet\ConnectionInterface $conn, string|Ratchet\Wamp\Topic $topic )

A request to subscribe to a topic has been made

A request to subscribe to a topic has been made

Parameters

$conn
Ratchet\ConnectionInterface
$conn
$topic
string|Ratchet\Wamp\Topic
$topic The topic to subscribe to
public
# onUnSubscribe( Ratchet\ConnectionInterface $conn, string|Ratchet\Wamp\Topic $topic )

A request to unsubscribe from a topic has been made

A request to unsubscribe from a topic has been made

Parameters

$conn
Ratchet\ConnectionInterface
$conn
$topic
string|Ratchet\Wamp\Topic
$topic The topic to unsubscribe from
public
# onPublish( Ratchet\ConnectionInterface $conn, string|Ratchet\Wamp\Topic $topic, string $event, array $exclude, array $eligible )

A client is attempting to publish content to a subscribed connections on a URI

A client is attempting to publish content to a subscribed connections on a URI

Parameters

$conn
Ratchet\ConnectionInterface
$conn
$topic
string|Ratchet\Wamp\Topic
$topic The topic the user has attempted to publish to
$event
string
$event Payload of the publish
$exclude
array
$exclude A list of session IDs the message should be excluded from (blacklist)
$eligible
array
$eligible A list of session Ids the message should be send to (whitelist)
Methods inherited from Ratchet\ComponentInterface
onClose(), onError(), onOpen()
Ratchet API documentation generated by ApiGen 2.8.0