htmon-client

Htmon::Client

A Faye-Websocket based Websocket or ActionCable client.

Installation

Add this line to your application's Gemfile:

gem 'htmon-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install htmon-client

Usage

Initialize client, which automatically connects and reconnects to server, by default.

  client = Htmon::Client.new(server: 'ws://example.org/cable', channels: 'SystemChannel')

The autoreconnect could be disables by passing autoconnect: false to constructor.

You are able to react on open and receive events.

  # Globally
  Htmon::Client.on_receive do |mesage|
    # content will be dumped and replied
    { command: :message ... }
  end

  # Instance based
  client.on_receive do |mesage|
    # content will be dumped and replied
    { command: :message ... }
  end

If a callbacks will return nil, then the reply will be skipped.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/timmyArch/htmon-client.

License

The gem is available as open source under the terms of the MIT License.