Skip to content

Add server launched event documentation #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alcalyn wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add server launched event documentation #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion Resources/docs/ClankEvents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
*
Expand Down Expand Up @@ -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.
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.