From 8c3788dd3ed287245a63250915ba5655c71418c5 Mon Sep 17 00:00:00 2001
From: Julien Maulny <doubjulien@hotmail.fr>
Date: Fri, 8 Aug 2014 14:53:19 +0200
Subject: [PATCH] Add server launched event documentation

---
 Resources/docs/ClankEvents.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/Resources/docs/ClankEvents.md b/Resources/docs/ClankEvents.md
index f4192c7..0b037f4 100644
--- a/Resources/docs/ClankEvents.md
+++ b/Resources/docs/ClankEvents.md
@@ -2,6 +2,7 @@
 
 Sometimes you will need to perform a server side action when a user connects or disconnects. Clank will fire events for 3 reasons:
 
+* Server launched
 * Client Connects
 * Client Disconnects
 * On Socket Error
@@ -16,11 +17,22 @@ Create a [Symfony 2 event listener class](http://symfony.com/doc/current/cookboo
 <?php
 namespace Acme\HelloBundle\EventListener;
 
+use JDare\ClankBundle\Event\ServerEvent;
 use JDare\ClankBundle\Event\ClientEvent;
 use JDare\ClankBundle\Event\ClientErrorEvent;
 
 class AcmeClientEventListener
 {
+    /**
+     * Called on clank server launched
+     * 
+     * @param \JDare\ClankBundle\Event\ServerEvent $event
+     */
+    public function onServerLaunched(ServerEvent $event)
+    {
+        echo 'Server launched' . PHP_EOL;
+    }
+    
     /**
      * Called whenever a client connects
      *
@@ -66,12 +78,26 @@ class AcmeClientEventListener
 Add this to your bundles "services.xml"
 
 _Note: the 3 events to listen for in the tags are: "clank.client.connected", "clank.client.disconnected", "clank.client.error"._
+
 ```xml
 <service id="kernel.listener.clank.client_event" class="Acme\HelloBundle\EventListener\AcmeClientEventListener">
+    <tag name="kernel.event_listener" event="clank.server.launched" method="onServerLaunched" />
     <tag name="kernel.event_listener" event="clank.client.connected" method="onClientConnect" />
     <tag name="kernel.event_listener" event="clank.client.disconnected" method="onClientDisconnect" />
     <tag name="kernel.event_listener" event="clank.client.error" method="onClientError" />
 </service>
 ```
 
-You will now notice that when a user connects or disconnects from your server, you will be given a notification in the command line.
\ No newline at end of file
+Or if you are using yml:
+```yml
+    kernel.listener.clank.client_event:
+        class: Acme\HelloBundle\EventListener\AcmeClientEventListener
+        tags:
+            - { name: kernel.event_listener, event: clank.server.launched , method: onServerLaunched }
+            - { name: kernel.event_listener, event: clank.client.connected, method: onClientConnect }
+            - { name: kernel.event_listener, event: clank.client.disconnected, method: onClientDisconnect }
+            - { name: kernel.event_listener, event: clank.client.error, method: onClientError }
+
+```
+
+You will now notice that when a user connects or disconnects from your server, you will be given a notification in the command line.