https://github.com/rolandoislas/BrightWebSocket

RFC 6455 WebSocket Library for the Roku
https://github.com/rolandoislas/BrightWebSocket

brightscript roku websocket

Last synced: 3 months ago
JSON representation

RFC 6455 WebSocket Library for the Roku

• Host: GitHub
• URL: https://github.com/rolandoislas/BrightWebSocket
• Owner: rolandoislas
• License: other
• Archived: true
• Created: 2018-02-25T08:00:06.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-07-10T14:14:34.000Z (over 5 years ago)
• Last Synced: 2024-08-02T20:48:09.325Z (6 months ago)
• Topics: brightscript, roku, websocket
• Language: Brightscript
• Size: 115 KB
• Stars: 14
• Watchers: 6
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • License: license.txt

Awesome Lists containing this project

README

        
# BrightWebSocket

A SceneGraph websocket client library written in BrightScript

**This repo is no longer maintained. See [This fork](https://github.com/SuitestAutomation/BrightWebSocket) for an actively maintained repo.**

# RFC 6455

Follows [RFC 6455](https://tools.ietf.org/html/rfc6455)

Notes:

- Uses ASCII instead of UTF-8 for string operations

- Does not support secure web sockets at this time

# Installation

The contents of the "src" folder in the repository's root should be placed

 in the "components" folder of a SceneGraph Roku app.

 

# Using the Library

The client follows the 

 [HTML WebSocket interface](https://html.spec.whatwg.org/multipage/web-sockets.html#the-websocket-interface), 

 modified to work with BrightScript conventions. Those familiar with browser

 (JavaScript) WebSocket implementations should find this client similar.

Example:

```brightscript

function init() as void

    m.ws = createObject("roSGNode", "WebSocketClient")

    m.ws.observeField("on_open", "on_open")

    m.ws.observeFiled("on_message", "on_message")

    m.ws.open = "ws://echo.websocket.org/"

end function

function on_open(event as object) as void

    m.ws.send = ["Hello World"]

end function

function on_message(event as object) as void

    print event.getData().message

end function

```

For a working sample app see the "test" folder. Its contents can be zipped for

 installation as a dev channel on a Roku.

# License

The MIT License. See license.txt.