Sha256: a4885e1efcdc7adcd70b950cb4aa6e51dc1abf092ee457b06e8a609ce35d7600

Contents?: true

Size: 1.21 KB

Versions: 7

Compression:

Stored size: 1.21 KB

Contents

# isomorfeus-transport

Transport and PubSub for isomorfeus.

### Community and Support
At the [Isomorfeus Framework Project](http://isomorfeus.com) 

## Installation
isomorfeus-transport is usually installed with the installer.
Otherwise add to your Gemfile:
```ruby
gem 'isomorfeus-transport'
```
and bundle install/update

## Server Side Rendering
`yarn add ws`

The 'ws' module then needs to be imported in application_ssr.js:
```
import WebSocket from 'ws';
global.WebSocket = WebSocket;
```

## Configuration options

Client and Server:
- Isomorfeus.api_websocket_path - path for server side endpoint, default: `/isomorfeus/api/websocket`

Server only:
- Isomorfeus.middlewares - all the rack middlewares to load


## LucidChannel

Isomorfeus-transport provides the LucidChannel::Mixin and LucidChannel::Base class.
These can be used for subscriptions and publishing messages.

### Subscriptions
```ruby
class MyChannel < LucidChannel::Base
end

# subscribe to channel
MyChannel.subscribe

# unsubscribe
MyChannel.unsubscribe
```

### Processing messages
```ruby
class MyChannel < LucidChannel::Base
  on_message do |message|
    puts "received: " + message
  end
end
```

### Sending mesages
```ruby
MyChannel.send_message('uiuiui')
```

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
isomorfeus-transport-1.0.0.epsilon1 README.md
isomorfeus-transport-1.0.0.delta12 README.md
isomorfeus-transport-1.0.0.delta11 README.md
isomorfeus-transport-1.0.0.delta10 README.md
isomorfeus-transport-1.0.0.delta9 README.md
isomorfeus-transport-1.0.0.delta8 README.md
isomorfeus-transport-1.0.0.delta7 README.md