aboutsummaryrefslogtreecommitdiffhomepage
path: root/assets/php/vendor/cboden/ratchet/src/Ratchet/ComponentInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'assets/php/vendor/cboden/ratchet/src/Ratchet/ComponentInterface.php')
-rw-r--r--assets/php/vendor/cboden/ratchet/src/Ratchet/ComponentInterface.php31
1 files changed, 31 insertions, 0 deletions
diff --git a/assets/php/vendor/cboden/ratchet/src/Ratchet/ComponentInterface.php b/assets/php/vendor/cboden/ratchet/src/Ratchet/ComponentInterface.php
new file mode 100644
index 0000000..37e41b1
--- /dev/null
+++ b/assets/php/vendor/cboden/ratchet/src/Ratchet/ComponentInterface.php
@@ -0,0 +1,31 @@
+<?php
+namespace Ratchet;
+
+/**
+ * This is the interface to build a Ratchet application with.
+ * It implements the decorator pattern to build an application stack
+ */
+interface ComponentInterface {
+ /**
+ * When a new connection is opened it will be passed to this method
+ * @param ConnectionInterface $conn The socket/connection that just connected to your application
+ * @throws \Exception
+ */
+ function onOpen(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.
+ * @param ConnectionInterface $conn The socket/connection that is closing/closed
+ * @throws \Exception
+ */
+ function onClose(ConnectionInterface $conn);
+
+ /**
+ * 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
+ * @param ConnectionInterface $conn
+ * @param \Exception $e
+ * @throws \Exception
+ */
+ function onError(ConnectionInterface $conn, \Exception $e);
+}