CHANGELOG

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog

This product uses Semantic Versioning.

5.3.0

• Fix retain cycles in URLSessionTransport and using default operation queue
• Adding an optional leeway to the HeartbeatTimer
• Added additional open methods in URLSessionTransport for further customization
• Using a thread-safe array for Channel bindings

5.2.2

• Changed URLSessionTransport to open to provide for custom behavior, such as SSL Pinning

5.2.1

• Added connectionState to Socket which exposes the Socket's ready state

5.2.0

• #226 Adds URLResponse as an optional value in socket.onError callbacks to allow for checking status codes from the server when the Socket connection errors out. See Examples in PR for more details

5.1.0

• Improves reconnection logic around a heartbeat timeout

5.0.0

• Removes RxSwift dependency
• Removes Starscream dependency
• Creating new repos to host these extensions

4.0.0

• Updates RxSwift version to 6.x

3.0.0

This ia a BREAKING release. The following has changed to properly matched the phoenix.js library

• message.payload.response is now automatically unwrapped and returned as message.payload for phx_reply events.
• The client now, be default, uses the JSON V2 Serializer which was added in phoenix 1.3. If you are still running 1.2 or earlier, then you will need to continue using SwiftPhoenixClient 2.1.0, or provide your own custom vsn, encoder and decoder to the Socket class.

2.1.1

• Fixed HeartbeatTimer to add thread safety and fix crash reported in #188

2.1.0

• Updated Presence.Options init method to be public
• Updated URLSessionWebsocketTask init method to accept a custom configuration

2.0.0

• Restructured project
• Added support for URLSession's Websocket Task
• Split Starscream and RxSwift into optional modules

1.3.0

• Fixed Cartfile declaration of Starscream
• Added HeartbeatTimer class which allows running Timers to run on their own thread
• Made Socket init public to allow customization of the transport methhod

1.2.1

• Pinned back Starscream version to fix Carthage build issue

1.2.0

• #153: Added ability to pass a closure when initializing a Socket to dynamically change params when reconnecting
• Fixed Package.swift and updated it to use latest Starscream

1.1.2

• #151: Made isJoined, isJoining, etc methods on Channel public

1.1.1

• #141: tvOS support
• #145: Refactored Socket reconnect strategy
• #146: Refactored Channel rejoin strategy

[1.1.0]

• Swift 5

[1.0.1]

• Fixed issue with Carthage installs

[1.0.0]

• Rewrite of large parts of the Socket and Channel classes
• Optional API for automatic retain cycle handling
• Presence support

0.9.3

Added

• #119: A working implementation of Presence

Changed

• #120: Xcode 10 and Swift 4.2

0.9.2

Fixed

• #111: Strong memory cycles between Socket, Channel and Timers
• #112: Leak when Socket disconnects and properly call onClose()
• #114: Carthage failing on builds and app store uploads

Changed

• #116: A Channel's topic is now exposed as public

0.9.1

Added

• Added security configuration to the underlying WebSocket.

0.9.0

Continue to improve the API and behavior of the library to behave similar to the JS library. This release introduces some breaking changes in the API that will require updates to your code. See the [usage guide] for help.

Updated

• Swift 4.1

Changed

• All callbacks now receive a Message object. The Payload can be accessed using message.payload

Added

• channel.join() can now take optional params to override the ones set while creating the Channel
• Timeouts when sending messages
• Rejoin timer which can be configured to attempt to rejoin given a function. Defaults to 1s, 2s, 5s, 10s and then retries every 10s
• Socket and Channel on callbacks are able to hold more than just a single callback

Thanks to @murphb52 and @ALucasVanDongen for helping with some of the development and testing of this release!

0.8.1

Fixed

• Initial params are not sent through when opening a channel

0.8.0

Updated

• Starscream to 3.0.4
• Swift 4
• Mirror Phoenix.js more closely