rxswiftcommunity / rxstarscream Goto Github PK

View Code? Open in Web Editor NEW

152.0 7.0 52.0 16.27 MB

A lightweight extension to subscribe Starscream websocket events with RxSwift

License: MIT License

Ruby 8.56% Swift 83.48% Objective-C 5.77% Shell 2.19%

rxstarscream's Introduction

RxStarscream

A lightweight extension to Starscream to track websocket events using RxSwift observables.

Installation

CocoaPods

RxStarscream is available through CocoaPods. Add the following line to your Podfile:

pod 'RxStarscream'

Then run:

pod install

RxStarscream version vs Swift version.

Below is a table that shows which version of RxStarscream you should use for your Swift version.

Swift	RxStarscream	RxSwift
>= 4.2	>= 0.10	>= 4.3
< 4.2	>= 0.8	>= 4.0
3.X	0.7	3.0.0 - 3.6.1

Carthage

Add this to your Cartfile

github "RxSwiftCommunity/RxStarscream"

Then run:

carthage update

Usage examples

After installing via CococPods or Carthage, you should import the framework.

import RxStarscream

Once imported, you can open a connection to your WebSocket server.

socket = WebSocket(url: URL(string: "ws://localhost:8080/")!)
socket.connect()

Now you can subscribe e.g to all of the websocket events:

socket.rx.response.subscribe(onNext: { (response: WebSocketEvent) in
	switch response {
	case .connected:
		print("Connected")
	case .disconnected(let error):
		print("Disconnected with optional error : \(error)")
	case .message(let msg):
		print("Message : \(msg)")
	case .data(_):
		print("Data")
	case .pong:
		print("Pong")
  	}
}).disposed(by: disposeBag)

Or just to a connect event:

socket.rx.connected.subscribe(onNext: { (isConnected: Bool) in
	print("Is connected : \(isConnected)")
}).disposed(by: disposeBag)

Or just to a message event:

socket.rx.text.subscribe(onNext: { (message: String) in
	print("Message : \(message)")
}).disposed(by: disposeBag)

Sample Project

There's a sample project (you need to run carthage update for it to compile).

The sample project uses echo server - https://www.websocket.org/echo.html

Have fun!

Thanks

Everyone in the RxSwift Slack channel.

Contributing

Bug reports and pull requests are welcome.

License

RxStarscream is available under the MIT license. See the LICENSE file for more info.

rxstarscream's People

Contributors

Stargazers

Watchers

rxstarscream's Issues

Add Unit Tests

You should add Unit Tests to the repository.

Disconnected with optional error : "Connection refused"

When I tried to run the sample project with just basics to connect web socket, getting this error -Disconnected with optional error : Optional(Error Domain=NSPOSIXErrorDomain Code=61 "Connection refused"

@_exported import RxSwift
@_exported import RxStarscream
import Starscream

  override func viewDidLoad() {
        super.viewDidLoad()
 private let disposeBag = DisposeBag()
 
socket = WebSocket(url: URL(string: "ws://localhost:8080/")!)
        socket.connect()

 socket.rx.response.subscribe(onNext: { (response: WebSocketEvent) in
            switch response {
            case .connected:
                print("Connected")
            case .disconnected(let error):
                print("Disconnected with optional error : \(error)")
            case .message(let msg):
                print("Message : \(msg)")
            case .data(_):
                print("Data")
            case .pong:
                print("Pong")
            }
        }).disposed(by: disposeBag)
}

am I doing anything wrong, I could find the solution..

Use WebsocketClient protocol to support mocking

This was introduced in daltoniam/Starscream#311. Afaict there should be nothing that prevents RxStarscream to replace the dependence on Websocket classes with the protocol, which would make it much easier to write tests.

Socket.io connection

Hello 👋,
I wondering is it possible to use RxStarscream with a serveur on Socket.io ? I know I should use Socket.io swift client but have you already try to make it work without the socket.io swift client ? I manage to connect but I get instant disconnect with code error 1000 but according to the RFC 6455 1000 is like a normal closure. If you have any idea or help to provide I will really appreciate it 😄 !

MainScheduler.ensureExecutingOnScheduler

RxCocoa DelegateProxyType.proxy(for:) need to excute on main scheduler.
What I think RxCocoa is designed for UI operations.

But websocket may not need to force on the main scheduler.

Update pod

Pod is not in actual state.
Dependency fix from d716e42 is not applied because spec.version is not changed

Update dependencies

Swift 4.2 and Xcode 10
newest RxSwift and Starscream
readme info about older Swift versions

Unable to use pod

Hi,

I'm getting this issue when I run pod update:
RxSwift (~> 2.5.0) required by RxStarscream (0.2)

I am running RxSwift 2.6
Could you please update the dependency.

Best regards,
ZkY.

issue with the real License.

In README it's under MIT
but in LICENSE file, it's under Apache License

Not compatible with latest RxSwift

I tried to do a pod install which resulted in the following:

[!] CocoaPods could not find compatible versions for pod "RxSwift":
  In snapshot (Podfile.lock):
    RxSwift (= 6.1.0)

  In Podfile:
    RxCocoa was resolved to 6.1.0, which depends on
      RxSwift (= 6.1.0)

    RxStarscream was resolved to 0.3, which depends on
      RxSwift (~> 2.5.0)

    RxSwift

My Podfile looks like this:

platform :ios, '10.0'

target 'MyApp' do
	use_frameworks!

	pod 'Firebase/Core'
	pod 'Firebase/Analytics'
	pod 'Firebase/Crashlytics'

	pod 'RxSwift'
	pod 'RxCocoa'

	pod 'RxStarscream'
end

Add CI to this repo

You should add Continuous Integration to the repository.

Not able to build RxStartscream with Carthage

Getting this error while doing carthage update

*** Skipped building RxStarscream due to the error:
Dependency "RxStarscream" has no shared framework schemes for any of the platforms: iOS

If you believe this to be an error, please file an issue with the maintainers at https://github.com/RxSwiftCommunity/RxStarscream/issues/new

ld: '/xxx/Carthage/Checkouts/RxStarscream/Carthage/Build/iOS/RxTest.framework/RxTest' does not contain bitcode. You must rebuild it with bitcode enabled (Xcode setting ENABLE_BITCODE), obtain an updated library from the vendor, or disable bitcode for this target. for architecture arm64

I've submitted a P.R. to fix this issue: #10