jdare / clank-bundle
Symfony ClankBundle
0.1.6
2013-11-23 17:19 UTC
Requires
- php: >=5.3.2
- cboden/ratchet: 0.2.*
- symfony/framework-bundle: ~2.1
README
关于
Clank 是一个用于将 WebSocket 功能集成到易于使用应用架构中的 Symfony2 Bundle。
与 Socket.IO 类似,它提供了服务器端和客户端代码,确保您需要编写的代码尽可能少,以启动并运行您的应用。
由 Ratchet 和 Autobahn JS 驱动,并使用 Symfony2
资源
- 安装说明
- 客户端 JavaScript
- RPC 服务器端
- PubSub 主题处理程序
- 定期服务(在 IO 循环中每 x 秒运行的功能)
- 会话管理
- Clank 服务器事件
代码秘籍
示例项目
- Clank Chat (查看源代码) 这是一个简单的聊天室网站,用户可以加入任何频道并与那里的人聊天。
安装说明
### 步骤 1:通过 composer 安装
{ "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 的进一步文档,请继续进行客户端设置。