README

关于

Clank 是一个为简化应用架构中的 WebSocket 功能而设计的 Symfony2 Bundle。

类似于 Socket.IO，它提供了服务器端和客户端代码，确保您只需编写尽可能少的代码即可让应用运行。

由 Ratchet 和 Autobahn JS 支持，并与 Symfony2 结合使用。

资源

• 安装说明
• 客户端 JavaScript
• RPC 服务器端
• Pub/Sub 主题处理器
• 周期性服务(在 IO 循环中每 x 秒运行的函数)
• 会话管理
• Clank 服务器事件

代码食谱

• 在服务器和客户端之间共享配置

示例项目

• Clank Chat (查看源代码) 这是一个简单的聊天室网站，用户可以加入任何频道并与那里的人聊天。

安装说明

### 步骤 1: 通过 composer 安装 将以下内容添加到您的 composer.json

{
    "require": {
        "jdare/clank-bundle": "0.1.*"
    }
}

然后更新 composer 以安装新包

php composer.phar update

### 步骤 2: 添加到您的 App Kernel

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new JDare\ClankBundle\JDareClankBundle(),
    );
}

### 步骤 3: 添加到 Assetic Bundles

将 "JDareClankBundle" 添加到 app/config 中的 assetic bundles（这是渲染客户端代码所必需的）。

# Assetic Configuration
assetic:
    ...
    bundles:        [ JDareClankBundle ]

### 步骤 4: 配置 WebSocket 服务器

将以下内容添加到您的 app/config.yml

# Clank Configuration
clank:
    web_socket_server:
        port: 8080        #The port the socket server will listen on
        host: 127.0.0.1   #(optional) The host ip to bind to

注意：在客户端连接时，如果可能，请使用与这里相同的值以确保会话等兼容性。

步骤 5: 启动服务器

Clank 服务器端安装现已完成。您应该可以从 symfony 安装根目录运行它。

php app/console clank:server

如果一切顺利，您将看到以下类似内容

Starting Clank
Launching Ratchet WS Server on: *:8080

这意味着 WebSocket 服务器现在正在运行！

下一步

有关如何使用 Clank 的进一步文档，请继续进行客户端设置。

• 设置客户端 JavaScript