Live danmaku server in OpenResty (WIP)
Lua
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/resty/danmaku
README.md

README.md

Name

lua-resty-danmaku - Danmaku server based on the ngx_lua cosocket API

Table of Contents

  • Description
  • Synopsis
  • Sample configuration
  • TODO
  • Copyright and License
  • See Also

Description

This Lua library is a Danmaku server based on ngx_lua module. Currently this server can only work on Websocket protocol.

Note that at least ngx_lua 0.10.0 or ngx_openresty 1.9.7.2 is required. Also, lua-resty-websocket is required to accept Websocket connections.

Synopsis

Back to TOC

Sample configuration

server {
        listen 80;
        listen 443 ssl http2;

        location ~ /danmaku/(\d+) {
            set $liveid $1;
            set $keep_alive_timeout 30000;
            content_by_lua "
                local dmk = require('resty.danmaku')
                dmk.run()
            ";
        }

        location = /danmaku/stat {
             content_by_lua "
                local u = require 'resty.danmaku.stat'
                require 'resty.danmaku.broadcaster'
                ngx.say(u._get_stat())
             ";
        }
}

Back to TOC

TODO

  • HTTP pooling support
  • TCP protocol support

Back to TOC

Copyright and License

This module is licensed under the BSD license.

Copyright (C) 2016, by fffonion fffonion@gmail.com.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC

See Also

Back to TOC