Class ServerProtocol

WebSocket Application Messaging Protocol

Ratchet\Wamp\ServerProtocol implements Ratchet\MessageComponentInterface, Ratchet\WebSocket\WsServerInterface

Namespace: Ratchet\Wamp
Link: http://wamp.ws/spec
Link: +--------------+----+------------------+ | Message Type | ID | DIRECTION | |--------------+----+------------------+ | WELCOME | 0 | Server-to-Client | | PREFIX | 1 | Bi-Directional | | CALL | 2 | Client-to-Server | | CALL RESULT | 3 | Server-to-Client | | CALL ERROR | 4 | Server-to-Client | | SUBSCRIBE | 5 | Client-to-Server | | UNSUBSCRIBE | 6 | Client-to-Server | | PUBLISH | 7 | Client-to-Server | | EVENT | 8 | Server-to-Client | +--------------+----+------------------+
Located at Ratchet/Wamp/ServerProtocol.php

Methods summary
`public`	# `__construct( Ratchet\Wamp\WampServerInterface $serverComponent )` Parameters `$serverComponent` `Ratchet\Wamp\WampServerInterface` $serverComponent An class to propagate calls through
`public array`	# `getSubProtocols( )` If any component in a stack supports a WebSocket sub-protocol return each supported in an array If any component in a stack supports a WebSocket sub-protocol return each supported in an array Returns `array` Implementation of `Ratchet\WebSocket\WsServerInterface::getSubProtocols()`
`public`	# `onOpen( Ratchet\ConnectionInterface $conn )` When a new connection is opened it will be passed to this method When a new connection is opened it will be passed to this method Parameters `$conn` `Ratchet\ConnectionInterface` $conn The socket/connection that just connected to your application Throws `Exception` Implementation of `Ratchet\ComponentInterface::onOpen()`
`public`	# `onMessage( Ratchet\ConnectionInterface $from, string $msg )` Triggered when a client sends data through the socket Triggered when a client sends data through the socket Parameters `$from` `Ratchet\ConnectionInterface` $from The socket/connection that sent the message to your application `$msg` `string` $msg The message received Throws `Ratchet\Wamp\Exception` `Ratchet\Wamp\JsonException` Implementation of `Ratchet\MessageInterface::onMessage()`
`public`	# `onClose( Ratchet\ConnectionInterface $conn )` This is called before or after a socket is closed (depends on how it's closed). SendMessage to $conn will not result in an error if it has already been closed. This is called before or after a socket is closed (depends on how it's closed). SendMessage to $conn will not result in an error if it has already been closed. Parameters `$conn` `Ratchet\ConnectionInterface` $conn The socket/connection that is closing/closed Throws `Exception` Implementation of `Ratchet\ComponentInterface::onClose()`
`public`	# `onError( Ratchet\ConnectionInterface $conn, Ratchet\Wamp\Exception $e )` If there is an error with one of the sockets, or somewhere in the application where an Exception is thrown, the Exception is sent back down the stack, handled by the Server and bubbled back up the application through this method If there is an error with one of the sockets, or somewhere in the application where an Exception is thrown, the Exception is sent back down the stack, handled by the Server and bubbled back up the application through this method Parameters `$conn` `Ratchet\ConnectionInterface` $conn `$e` `Exception` $e Throws `Exception` Implementation of `Ratchet\ComponentInterface::onError()`

Constants summary
`integer`	`MSG_WELCOME`	`0`	#
`integer`	`MSG_PREFIX`	`1`	#
`integer`	`MSG_CALL`	`2`	#
`integer`	`MSG_CALL_RESULT`	`3`	#
`integer`	`MSG_CALL_ERROR`	`4`	#
`integer`	`MSG_SUBSCRIBE`	`5`	#
`integer`	`MSG_UNSUBSCRIBE`	`6`	#
`integer`	`MSG_PUBLISH`	`7`	#
`integer`	`MSG_EVENT`	`8`	#

Properties summary
`protected Ratchet\Wamp\WampServerInterface`	`$_decorating`		#
`protected SplObjectStorage`	`$connections`		#