)!\n var workItemSetCount: Int = 0\n var workItemDidGetSet: Bool { return workItemSetCount > 0 }\n override var workItem: DispatchWorkItem? {\n didSet { workItemSetCount += 1 }\n }\n override var tries: Int {\n get { return underlyingTries }\n set(value) { underlyingTries = value }\n }\n var underlyingTries: (Int)!\n override var queue: TimerQueue {\n get { return underlyingQueue }\n set(value) { underlyingQueue = value }\n }\n var underlyingQueue: (TimerQueue)!\n\n\n //MARK: - reset\n\n var resetCallsCount = 0\n var resetCalled: Bool {\n return resetCallsCount > 0\n }\n var resetClosure: (() -> Void)?\n\n override func reset() {\n resetCallsCount += 1\n resetClosure?()\n }\n\n\n //MARK: - scheduleTimeout\n\n var scheduleTimeoutCallsCount = 0\n var scheduleTimeoutCalled: Bool {\n return scheduleTimeoutCallsCount > 0\n }\n var scheduleTimeoutClosure: (() -> Void)?\n\n override func scheduleTimeout() {\n scheduleTimeoutCallsCount += 1\n scheduleTimeoutClosure?()\n }\n\n\n}\n"
},
{
"path": "Tests/Mocks/MockableProtocol.generated.swift",
"content": "// Generated using Sourcery 1.0.2 — https://github.com/krzysztofzablocki/Sourcery\n// DO NOT EDIT\n\n// swiftlint:disable line_length\n// swiftlint:disable variable_name\n\nimport Foundation\n#if os(iOS) || os(tvOS) || os(watchOS)\nimport UIKit\n#elseif os(OSX)\nimport AppKit\n#endif\n\n@testable import SwiftPhoenixClient\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nclass PhoenixTransportMock: PhoenixTransport {\n var readyState: PhoenixTransportReadyState {\n get { return underlyingReadyState }\n set(value) { underlyingReadyState = value }\n }\n var underlyingReadyState: PhoenixTransportReadyState!\n var delegate: PhoenixTransportDelegate?\n\n //MARK: - connect\n\n var connectCallsCount = 0\n var connectCalled: Bool {\n return connectCallsCount > 0\n }\n var connectClosure: (() -> Void)?\n\n func connect() {\n connectCallsCount += 1\n connectClosure?()\n }\n\n //MARK: - disconnect\n\n var disconnectCodeReasonCallsCount = 0\n var disconnectCodeReasonCalled: Bool {\n return disconnectCodeReasonCallsCount > 0\n }\n var disconnectCodeReasonReceivedArguments: (code: Int, reason: String?)?\n var disconnectCodeReasonReceivedInvocations: [(code: Int, reason: String?)] = []\n var disconnectCodeReasonClosure: ((Int, String?) -> Void)?\n\n func disconnect(code: Int, reason: String?) {\n disconnectCodeReasonCallsCount += 1\n disconnectCodeReasonReceivedArguments = (code: code, reason: reason)\n disconnectCodeReasonReceivedInvocations.append((code: code, reason: reason))\n disconnectCodeReasonClosure?(code, reason)\n }\n\n //MARK: - send\n\n var sendDataCallsCount = 0\n var sendDataCalled: Bool {\n return sendDataCallsCount > 0\n }\n var sendDataReceivedData: Data?\n var sendDataReceivedInvocations: [Data] = []\n var sendDataClosure: ((Data) -> Void)?\n\n func send(data: Data) {\n sendDataCallsCount += 1\n sendDataReceivedData = data\n sendDataReceivedInvocations.append(data)\n sendDataClosure?(data)\n }\n\n}\n"
},
{
"path": "Tests/SwiftPhoenixClientTests/ChannelSpec.swift",
"content": "//\n// ChannelSpec.swift\n// SwiftPhoenixClient\n//\n// Created by Daniel Rees on 5/18/18.\n//\n\nimport Quick\nimport Nimble\n@testable import SwiftPhoenixClient\n\n\nclass ChannelSpec: QuickSpec {\n \n override func spec() {\n \n // Mocks\n var mockClient: PhoenixTransportMock!\n var mockSocket: SocketMock!\n \n // Constants\n let kDefaultRef = \"1\"\n let kDefaultTimeout: TimeInterval = 10.0\n \n // Clock\n var fakeClock: FakeTimerQueue!\n \n // UUT\n var channel: Channel!\n \n \n /// Utility method to easily filter the bindings for a channel by their event\n func getBindings(_ event: String) -> [Binding]? {\n return channel.syncBindingsDel.filter({ $0.event == event })\n }\n \n \n beforeEach {\n // Any TimeoutTimer that is created will receive the fake clock\n // when scheduling work items\n fakeClock = FakeTimerQueue()\n TimerQueue.main = fakeClock\n \n mockClient = PhoenixTransportMock()\n \n mockSocket = SocketMock(endPoint: \"/socket\", transport: { _ in mockClient })\n mockSocket.connection = mockClient\n mockSocket.timeout = kDefaultTimeout\n mockSocket.makeRefReturnValue = kDefaultRef\n mockSocket.reconnectAfter = { tries -> TimeInterval in\n return tries > 3 ? 10 : [1, 2, 5, 10][tries - 1]\n }\n \n mockSocket.rejoinAfter = Defaults.rejoinSteppedBackOff\n \n \n channel = Channel(topic: \"topic\", params: [\"one\": \"two\"], socket: mockSocket)\n mockSocket.channelParamsReturnValue = channel\n }\n \n afterEach {\n fakeClock.reset()\n }\n \n describe(\"constructor\") {\n it(\"sets defaults\", closure: {\n channel = Channel(topic: \"topic\", params: [\"one\": \"two\"], socket: mockSocket)\n \n expect(channel.state).to(equal(ChannelState.closed))\n expect(channel.topic).to(equal(\"topic\"))\n expect(channel.params[\"one\"] as? String).to(equal(\"two\"))\n expect(channel.socket === mockSocket).to(beTrue())\n expect(channel.timeout).to(equal(10))\n expect(channel.joinedOnce).to(beFalse())\n expect(channel.joinPush).toNot(beNil())\n expect(channel.pushBuffer).to(beEmpty())\n })\n \n it(\"sets up joinPush with literal params\", closure: {\n channel = Channel(topic: \"topic\", params: [\"one\": \"two\"], socket: mockSocket)\n let joinPush = channel.joinPush\n \n expect(joinPush?.channel === channel).to(beTrue())\n expect(joinPush?.payload[\"one\"] as? String).to(equal(\"two\"))\n expect(joinPush?.event).to(equal(\"phx_join\"))\n expect(joinPush?.timeout).to(equal(10))\n })\n \n it(\"should not introduce any retain cycles\", closure: {\n weak var weakChannel = Channel(topic: \"topic\",\n params: [\"one\": 2],\n socket: mockSocket)\n expect(weakChannel).to(beNil())\n })\n }\n \n describe(\"onMessage\") {\n it(\"returns message by default\", closure: {\n let message = channel.onMessage(Message(ref: \"original\"))\n expect(message.ref).to(equal(\"original\"))\n })\n \n it(\"can be overridden\", closure: {\n channel.onMessage = { message in\n return Message(ref: \"modified\")\n }\n \n let message = channel.onMessage(Message(ref: \"original\"))\n expect(message.ref).to(equal(\"modified\"))\n })\n }\n \n describe(\"updating join params\") {\n it(\"can update join params\", closure: {\n let params: Payload = [\"value\": 1]\n let change: Payload = [\"value\": 2]\n \n channel = Channel(topic: \"topic\", params: params, socket: mockSocket)\n let joinPush = channel.joinPush\n \n expect(joinPush?.channel === channel).to(beTrue())\n expect(joinPush?.payload[\"value\"] as? Int).to(equal(1))\n expect(joinPush?.event).to(equal(ChannelEvent.join))\n expect(joinPush?.timeout).to(equal(10))\n \n channel.params = change\n \n expect(joinPush?.channel === channel).to(beTrue())\n expect(joinPush?.payload[\"value\"] as? Int).to(equal(2))\n expect(channel?.params[\"value\"] as? Int).to(equal(2))\n expect(joinPush?.event).to(equal(ChannelEvent.join))\n expect(joinPush?.timeout).to(equal(10))\n })\n }\n \n \n describe(\"join\") {\n it(\"sets state to joining\", closure: {\n channel.join()\n expect(channel.state.rawValue).to(equal(\"joining\"))\n })\n \n it(\"sets joinedOnce to true\", closure: {\n expect(channel.joinedOnce).to(beFalse())\n \n channel.join()\n expect(channel.joinedOnce).to(beTrue())\n })\n \n it(\"throws if attempting to join multiple times\", closure: {\n channel.join()\n \n // Method is not marked to throw\n expect { channel.join() }.to(throwAssertion())\n })\n \n it(\"triggers socket push with channel params\", closure: {\n channel.join()\n \n expect(mockSocket.pushTopicEventPayloadRefJoinRefCalled).to(beTrue())\n \n let args = mockSocket.pushTopicEventPayloadRefJoinRefReceivedArguments\n expect(args?.topic).to(equal(\"topic\"))\n expect(args?.event).to(equal(\"phx_join\"))\n expect(args?.payload[\"one\"] as? String).to(equal(\"two\"))\n expect(args?.ref).to(equal(kDefaultRef))\n expect(args?.joinRef).to(equal(channel.joinRef))\n })\n \n it(\"can set timeout on joinPush\", closure: {\n let newTimeout: TimeInterval = 2.0\n let joinPush = channel.joinPush\n \n expect(joinPush?.timeout).to(equal(kDefaultTimeout))\n \n let _ = channel.join(timeout: newTimeout)\n expect(joinPush?.timeout).to(equal(newTimeout))\n })\n \n it(\"leaves existing duplicate topic on new join\") {\n let transport: ((URL) -> PhoenixTransport) = { _ in return mockClient }\n let spySocket = SocketSpy(endPoint: \"/socket\", transport: transport)\n let channel = spySocket.channel(\"topic\", params: [\"one\": \"two\"])\n \n mockClient.readyState = .open\n spySocket.onConnectionOpen()\n \n channel.join()\n .receive(\"ok\") { (message) in\n let newChannel = spySocket.channel(\"topic\")\n expect(channel.isJoined).to(beTrue())\n newChannel.join()\n \n expect(channel.isJoined).to(beFalse())\n }\n \n channel.joinPush.trigger(\"ok\", payload: [:])\n }\n }\n \n \n describe(\"timeout behavior\") {\n \n var spySocket: SocketSpy!\n var joinPush: Push!\n var timeout: TimeInterval!\n \n func receiveSocketOpen() {\n mockClient.readyState = .open\n spySocket.onConnectionOpen()\n }\n \n beforeEach {\n mockClient.readyState = .closed\n let transport: ((URL) -> PhoenixTransport) = { _ in return mockClient }\n spySocket = SocketSpy(endPoint: \"/socket\", transport: transport)\n channel = Channel(topic: \"topic\", params: [\"one\": \"two\"], socket: spySocket)\n \n joinPush = channel.joinPush\n timeout = joinPush.timeout\n }\n \n it(\"succeeds before timeout\", closure: {\n spySocket.connect()\n receiveSocketOpen()\n \n channel.join()\n expect(spySocket.pushCalled).to(beTrue())\n expect(channel.timeout).to(equal(10.0))\n\n fakeClock.tick(0.100)\n joinPush.trigger(\"ok\", payload: [:])\n expect(channel.state).to(equal(.joined))\n \n fakeClock.tick(timeout)\n expect(spySocket.pushCallCount).to(equal(1))\n })\n \n it(\"retries with backoff after timeout\", closure: {\n spySocket.connect()\n receiveSocketOpen()\n \n var timeoutCallCount = 0\n channel.join().receive(\"timeout\", callback: { (_) in\n timeoutCallCount += 1\n })\n \n expect(spySocket.pushCallCount).to(equal(1))\n expect(spySocket.pushArgs[1]?.event).to(equal(\"phx_join\"))\n expect(timeoutCallCount).to(equal(0))\n \n fakeClock.tick(timeout) // leave pushed to server\n expect(spySocket.pushCallCount).to(equal(2))\n expect(spySocket.pushArgs[2]?.event).to(equal(\"phx_leave\"))\n expect(timeoutCallCount).to(equal(1))\n \n fakeClock.tick(timeout + 1) // rejoin\n expect(spySocket.pushCallCount).to(equal(4))\n expect(spySocket.pushArgs[3]?.event).to(equal(\"phx_join\"))\n expect(spySocket.pushArgs[4]?.event).to(equal(\"phx_leave\"))\n expect(timeoutCallCount).to(equal(2))\n \n fakeClock.tick(10)\n joinPush.trigger(\"ok\", payload: [:])\n expect(spySocket.pushCallCount).to(equal(5))\n expect(spySocket.pushArgs[5]?.event).to(equal(\"phx_join\"))\n expect(channel.state).to(equal(.joined))\n })\n\n it(\"with socket and join delay\", closure: {\n channel.join()\n expect(spySocket.pushCallCount).to(equal(1))\n\n // Open the socket after a delay\n fakeClock.tick(9.0)\n expect(spySocket.pushCallCount).to(equal(1))\n \n // join request returns between timeouts\n fakeClock.tick(1.0)\n spySocket.connect()\n \n expect(channel.state).to(equal(.errored))\n receiveSocketOpen()\n joinPush.trigger(\"ok\", payload: [:])\n \n fakeClock.tick(1.0)\n expect(channel.state).to(equal(.joined))\n expect(spySocket.pushCallCount).to(equal(3))\n })\n\n it(\"with socket delay only\", closure: {\n channel.join()\n expect(channel.state).to(equal(.joining))\n \n // connect socket after a delay\n fakeClock.tick(6.0)\n spySocket.connect()\n \n // open Socket after delay\n fakeClock.tick(5.0)\n receiveSocketOpen()\n joinPush.trigger(\"ok\", payload: [:])\n \n joinPush.trigger(\"ok\", payload: [:])\n expect(channel.state).to(equal(.joined))\n })\n }\n \n describe(\"joinPush\") {\n var spySocket: SocketSpy!\n var joinPush: Push!\n \n beforeEach {\n mockClient.readyState = .open\n spySocket = SocketSpy(endPoint: \"/socket\",\n transport: { _ in return mockClient })\n spySocket.connect()\n \n channel = Channel(topic: \"topic\", params: [\"one\": \"two\"], socket: spySocket)\n joinPush = channel.joinPush\n \n channel.join()\n }\n \n func receivesOk() {\n fakeClock.tick(joinPush.timeout / 2)\n joinPush.trigger(\"ok\", payload: [\"a\": \"b\"])\n }\n \n func receivesTimeout() {\n fakeClock.tick(joinPush.timeout * 2)\n }\n \n func receiveError() {\n fakeClock.tick(joinPush.timeout / 2)\n joinPush.trigger(\"error\", payload: [\"a\": \"b\"])\n }\n \n \n describe(\"receives 'ok'\", {\n it(\"sets channel state to joined\", closure: {\n expect(channel.state).toNot(equal(.joined))\n \n receivesOk()\n expect(channel.state).to(equal(.joined))\n })\n \n it(\"triggers receive(ok) callback after ok response\", closure: {\n var callbackCallCount: Int = 0\n joinPush.receive(\"ok\", callback: {_ in callbackCallCount += 1})\n \n receivesOk()\n expect(callbackCallCount).to(equal(1))\n })\n \n it(\"triggers receive('ok') callback if ok response already received\", closure: {\n receivesOk()\n \n var callbackCallCount: Int = 0\n joinPush.receive(\"ok\", callback: {_ in callbackCallCount += 1})\n \n expect(callbackCallCount).to(equal(1))\n })\n \n it(\"does not trigger other receive callbacks after ok response\", closure: {\n var callbackCallCount: Int = 0\n joinPush\n .receive(\"error\", callback: {_ in callbackCallCount += 1})\n .receive(\"timeout\", callback: {_ in callbackCallCount += 1})\n \n receivesOk()\n receivesTimeout()\n \n expect(callbackCallCount).to(equal(0))\n \n })\n \n it(\"clears timeoutTimer workItem\", closure: {\n expect(joinPush.timeoutWorkItem).toNot(beNil())\n \n receivesOk()\n expect(joinPush.timeoutWorkItem).to(beNil())\n })\n \n it(\"sets receivedMessage\", closure: {\n expect(joinPush.receivedMessage).to(beNil())\n \n receivesOk()\n expect(joinPush.receivedMessage).toNot(beNil())\n expect(joinPush.receivedMessage?.status).to(equal(\"ok\"))\n expect(joinPush.receivedMessage?.payload[\"a\"] as? String).to(equal(\"b\"))\n })\n \n it(\"removes channel binding\", closure: {\n var bindings = getBindings(\"chan_reply_3\")\n expect(bindings).to(haveCount(1))\n \n receivesOk()\n bindings = getBindings(\"chan_reply_3\")\n expect(bindings).to(haveCount(0))\n })\n \n it(\"sets channel state to joined\", closure: {\n receivesOk()\n expect(channel.state).to(equal(.joined))\n })\n \n it(\"resets channel rejoinTimer\", closure: {\n let mockRejoinTimer = TimeoutTimerMock()\n channel.rejoinTimer = mockRejoinTimer\n \n receivesOk()\n expect(mockRejoinTimer.resetCallsCount).to(equal(1))\n })\n \n it(\"sends and empties channel's buffered pushEvents\", closure: {\n let mockPush = PushMock(channel: channel, event: \"new:msg\")\n channel.pushBuffer.append(mockPush)\n \n receivesOk()\n expect(mockPush.sendCalled).to(beTrue())\n expect(channel.pushBuffer).to(haveCount(0))\n })\n })\n \n describe(\"receives 'timeout'\", {\n it(\"sets channel state to errored\", closure: {\n var timeoutReceived = false\n joinPush.receive(\"timeout\", callback: { (_) in\n timeoutReceived = true\n expect(channel.state).to(equal(.errored))\n })\n \n receivesTimeout()\n expect(timeoutReceived).to(beTrue())\n })\n \n it(\"triggers receive('timeout') callback after ok response\", closure: {\n var receiveTimeoutCallCount = 0\n joinPush.receive(\"timeout\", callback: { (_) in\n receiveTimeoutCallCount += 1\n })\n \n receivesTimeout()\n expect(receiveTimeoutCallCount).to(equal(1))\n })\n \n it(\"does not trigger other receive callbacks after timeout response\", closure: {\n var receiveOkCallCount = 0\n var receiveErrorCallCount = 0\n var timeoutReceived = false\n \n joinPush\n .receive(\"ok\") {_ in receiveOkCallCount += 1 }\n .receive(\"error\") {_ in receiveErrorCallCount += 1 }\n .receive(\"timeout\", callback: { (_) in\n expect(receiveOkCallCount).to(equal(0))\n expect(receiveErrorCallCount).to(equal(0))\n timeoutReceived = true\n })\n \n receivesTimeout()\n receivesOk()\n \n expect(timeoutReceived).to(beTrue())\n })\n \n it(\"schedules rejoinTimer timeout\", closure: {\n let mockRejoinTimer = TimeoutTimerMock()\n channel.rejoinTimer = mockRejoinTimer\n \n receivesTimeout()\n expect(mockRejoinTimer.scheduleTimeoutCalled).to(beTrue())\n })\n })\n \n describe(\"receives `error`\", {\n it(\"triggers receive('error') callback after error response\", closure: {\n expect(channel.state).to(equal(.joining))\n\n var errorCallsCount = 0\n joinPush.receive(\"error\") { (_) in errorCallsCount += 1 }\n \n receiveError()\n joinPush.trigger(\"error\", payload: [:])\n expect(errorCallsCount).to(equal(1))\n })\n \n it(\"triggers receive('error') callback if error response already received\", closure: {\n receiveError()\n \n var errorCallsCount = 0\n joinPush.receive(\"error\") { (_) in errorCallsCount += 1 }\n \n expect(errorCallsCount).to(equal(1))\n })\n \n it(\"does not trigger other receive callbacks after ok response\", closure: {\n var receiveOkCallCount = 0\n var receiveTimeoutCallCount = 0\n var receiveErrorCallCount = 0\n joinPush\n .receive(\"ok\") {_ in receiveOkCallCount += 1 }\n .receive(\"error\", callback: { (_) in\n receiveErrorCallCount += 1\n channel.leave()\n })\n .receive(\"timeout\") {_ in receiveTimeoutCallCount += 1 }\n \n receiveError()\n receivesTimeout()\n \n expect(receiveErrorCallCount).to(equal(1))\n expect(receiveOkCallCount).to(equal(0))\n expect(receiveTimeoutCallCount).to(equal(0))\n })\n \n it(\"clears timeoutTimer workItem\", closure: {\n expect(joinPush.timeoutWorkItem).toNot(beNil())\n \n receiveError()\n expect(joinPush.timeoutWorkItem).to(beNil())\n })\n \n it(\"sets receivedMessage\", closure: {\n expect(joinPush.receivedMessage).to(beNil())\n \n receiveError()\n expect(joinPush.receivedMessage).toNot(beNil())\n expect(joinPush.receivedMessage?.status).to(equal(\"error\"))\n expect(joinPush.receivedMessage?.payload[\"a\"] as? String).to(equal(\"b\"))\n })\n \n it(\"removes channel binding\", closure: {\n var bindings = getBindings(\"chan_reply_3\")\n expect(bindings).to(haveCount(1))\n \n receiveError()\n bindings = getBindings(\"chan_reply_3\")\n expect(bindings).to(haveCount(0))\n })\n \n it(\"does not sets channel state to joined\", closure: {\n receiveError()\n expect(channel.state).toNot(equal(.joined))\n })\n \n it(\"does not trigger channel's buffered pushEvents\", closure: {\n let mockPush = PushMock(channel: channel, event: \"new:msg\")\n channel.pushBuffer.append(mockPush)\n \n receiveError()\n expect(mockPush.sendCalled).to(beFalse())\n expect(channel.pushBuffer).to(haveCount(1))\n })\n })\n }\n \n describe(\"onError\") {\n \n var spySocket: SocketSpy!\n var joinPush: Push!\n \n beforeEach {\n mockClient.readyState = .open\n spySocket = SocketSpy(endPoint: \"/socket\",\n transport: { _ in return mockClient })\n spySocket.connect()\n \n channel = Channel(topic: \"topic\", params: [\"one\": \"two\"], socket: spySocket)\n joinPush = channel.joinPush\n \n channel.join()\n joinPush.trigger(\"ok\", payload: [:])\n }\n \n \n \n it(\"does not trigger redundant errors during backoff\", closure: {\n // Spy the channel's Join Push\n let mockPush = PushMock(channel: channel, event: \"event\")\n channel.joinPush = mockPush\n \n expect(mockPush.resendCalled).to(beFalse())\n channel.trigger(event: ChannelEvent.error)\n \n fakeClock.tick(1.0)\n expect(mockPush.resendCalled).to(beTrue())\n expect(mockPush.resendCallsCount).to(equal(1))\n\n channel.trigger(event: \"error\")\n fakeClock.tick(1.0)\n expect(mockPush.resendCallsCount).to(equal(1))\n })\n \n describe(\"while joining\") {\n \n var mockPush: PushMock!\n \n beforeEach {\n channel = Channel(topic: \"topic\", params: [\"one\": \"two\"], socket: mockSocket)\n \n // Spy the channel's Join Push\n mockPush = PushMock(channel: channel, event: \"event\")\n mockPush.ref = \"10\"\n channel.joinPush = mockPush\n channel.state = .joining\n }\n \n it(\"removes the joinPush message from send buffer\") {\n channel.trigger(event: ChannelEvent.error)\n expect(mockSocket.removeFromSendBufferRefCalled).to(beTrue())\n expect(mockSocket.removeFromSendBufferRefReceivedRef).to(equal(\"10\"))\n }\n \n it(\"resets the joinPush\") {\n channel.trigger(event: ChannelEvent.error)\n expect(mockPush.resetCalled).to(beTrue())\n }\n }\n \n it(\"sets channel state to .errored\", closure: {\n expect(channel.state).toNot(equal(.errored))\n \n channel.trigger(event: ChannelEvent.error)\n expect(channel.state).to(equal(.errored))\n })\n \n it(\"tries to rejoin with backoff\", closure: {\n let mockRejoinTimer = TimeoutTimerMock()\n channel.rejoinTimer = mockRejoinTimer\n \n channel.trigger(event: ChannelEvent.error)\n expect(mockRejoinTimer.scheduleTimeoutCalled).to(beTrue())\n })\n \n it(\"does not rejoin if channel leaving\", closure: {\n channel.state = .leaving\n \n let mockPush = PushMock(channel: channel, event: \"event\")\n channel.joinPush = mockPush\n \n spySocket.onConnectionError(TestError.stub, response: nil)\n \n fakeClock.tick(1.0)\n expect(mockPush.sendCallsCount).to(equal(0))\n \n fakeClock.tick(2.0)\n expect(mockPush.sendCallsCount).to(equal(0))\n \n expect(channel.state).to(equal(.leaving))\n })\n \n it(\"does nothing if channel is closed\", closure: {\n channel.state = .closed\n \n let mockPush = PushMock(channel: channel, event: \"event\")\n channel.joinPush = mockPush\n \n spySocket.onConnectionError(TestError.stub, response: nil)\n \n fakeClock.tick(1.0)\n expect(mockPush.sendCallsCount).to(equal(0))\n \n fakeClock.tick(2.0)\n expect(mockPush.sendCallsCount).to(equal(0))\n \n expect(channel.state).to(equal(.closed))\n })\n \n it(\"triggers additional callbacks\", closure: {\n var onErrorCallCount = 0\n channel.onError({ (_) in onErrorCallCount += 1 })\n joinPush.trigger(\"ok\", payload: [:])\n \n expect(channel.state).to(equal(.joined))\n expect(onErrorCallCount).to(equal(0))\n\n channel.trigger(event: ChannelEvent.error)\n expect(onErrorCallCount).to(equal(1))\n })\n }\n \n describe(\"onClose\") {\n \n beforeEach {\n mockClient.readyState = .open\n channel.join()\n }\n \n it(\"sets state to closed\", closure: {\n expect(channel.state).toNot(equal(.closed))\n channel.trigger(event: ChannelEvent.close)\n expect(channel.state).to(equal(.closed))\n })\n \n it(\"does not rejoin\", closure: {\n let mockJoinPush = PushMock(channel: channel, event: \"phx_join\")\n channel.joinPush = mockJoinPush\n \n channel.trigger(event: ChannelEvent.close)\n \n fakeClock.tick(1.0)\n expect(mockJoinPush.sendCalled).to(beFalse())\n \n fakeClock.tick(2.0)\n expect(mockJoinPush.sendCalled).to(beFalse())\n })\n \n it(\"resets the rejoin timer\", closure: {\n let mockRejoinTimer = TimeoutTimerMock()\n channel.rejoinTimer = mockRejoinTimer\n \n channel.trigger(event: ChannelEvent.close)\n expect(mockRejoinTimer.resetCalled).to(beTrue())\n })\n \n it(\"removes self from socket\", closure: {\n channel.trigger(event: ChannelEvent.close)\n expect(mockSocket.removeCalled).to(beTrue())\n \n let removedChannel = mockSocket.removeReceivedChannel\n expect(removedChannel === channel).to(beTrue())\n })\n \n it(\"triggers additional callbacks\", closure: {\n var onCloseCallCount = 0\n channel.onClose({ (_) in\n onCloseCallCount += 1\n })\n \n channel.trigger(event: ChannelEvent.close)\n expect(onCloseCallCount).to(equal(1))\n })\n }\n \n describe(\"canPush\") {\n it(\"returns true when socket connected and channel joined\", closure: {\n channel.state = .joined\n mockClient.readyState = .open\n expect(channel.canPush).to(beTrue())\n })\n \n it(\"otherwise returns false\", closure: {\n channel.state = .joined\n mockClient.readyState = .closed\n expect(channel.canPush).to(beFalse())\n \n channel.state = .joining\n mockClient.readyState = .open\n expect(channel.canPush).to(beFalse())\n \n channel.state = .joining\n mockClient.readyState = .closed\n expect(channel.canPush).to(beFalse())\n })\n }\n \n describe(\"on\") {\n beforeEach {\n mockSocket.makeRefClosure = nil\n mockSocket.makeRefReturnValue = kDefaultRef\n }\n \n it(\"sets up callback for event\", closure: {\n var onCallCount = 0\n \n channel.trigger(event: \"event\", ref: kDefaultRef)\n expect(onCallCount).to(equal(0))\n \n channel.on(\"event\", callback: { (_) in\n onCallCount += 1\n })\n \n channel.trigger(event: \"event\", ref: kDefaultRef)\n expect(onCallCount).to(equal(1))\n })\n \n it(\"other event callbacks are ignored\", closure: {\n var onCallCount = 0\n let ignoredOnCallCount = 0\n \n channel.trigger(event: \"event\", ref: kDefaultRef)\n expect(ignoredOnCallCount).to(equal(0))\n \n channel.on(\"event\", callback: { (_) in\n onCallCount += 1\n })\n \n channel.trigger(event: \"event\", ref: kDefaultRef)\n expect(ignoredOnCallCount).to(equal(0))\n })\n \n it(\"generates unique refs for callbacks \", closure: {\n let ref1 = channel.on(\"event1\", callback: { _ in })\n let ref2 = channel.on(\"event2\", callback: { _ in })\n expect(ref1).toNot(equal(ref2))\n expect(ref1 + 1).to(equal(ref2))\n \n })\n }\n \n describe(\"off\") {\n beforeEach {\n mockSocket.makeRefClosure = nil\n mockSocket.makeRefReturnValue = kDefaultRef\n }\n \n it(\"removes all callbacks for event\", closure: {\n var callCount1 = 0\n var callCount2 = 0\n var callCount3 = 0\n \n channel.on(\"event\", callback: { _ in callCount1 += 1})\n channel.on(\"event\", callback: { _ in callCount2 += 1})\n channel.on(\"other\", callback: { _ in callCount3 += 1})\n \n channel.off(\"event\")\n channel.trigger(event: \"event\", ref: kDefaultRef)\n channel.trigger(event: \"other\", ref: kDefaultRef)\n \n expect(callCount1).to(equal(0))\n expect(callCount2).to(equal(0))\n expect(callCount3).to(equal(1))\n })\n \n it(\"removes callback by ref\", closure: {\n var callCount1 = 0\n var callCount2 = 0\n \n let ref1 = channel.on(\"event\", callback: { _ in callCount1 += 1})\n let _ = channel.on(\"event\", callback: { _ in callCount2 += 1})\n \n channel.off(\"event\", ref: ref1)\n channel.trigger(event: \"event\", ref: kDefaultRef)\n \n expect(callCount1).to(equal(0))\n expect(callCount2).to(equal(1))\n })\n }\n \n describe(\"push\") {\n \n beforeEach {\n mockSocket.makeRefClosure = nil\n mockSocket.makeRefReturnValue = kDefaultRef\n mockClient.readyState = .open\n }\n \n it(\"sends push event when successfully joined\", closure: {\n channel.join().trigger(\"ok\", payload: [:])\n channel.push(\"event\", payload: [\"foo\": \"bar\"])\n \n expect(mockSocket.pushTopicEventPayloadRefJoinRefCalled).to(beTrue())\n let args = mockSocket.pushTopicEventPayloadRefJoinRefReceivedArguments\n expect(args?.topic).to(equal(\"topic\"))\n expect(args?.event).to(equal(\"event\"))\n expect(args?.payload[\"foo\"] as? String).to(equal(\"bar\"))\n expect(args?.joinRef).to(equal(channel.joinRef))\n expect(args?.ref).to(equal(kDefaultRef))\n })\n \n it(\"enqueues push event to be sent once join has succeeded\", closure: {\n let joinPush = channel.join()\n channel.push(\"event\", payload: [\"foo\": \"bar\"])\n \n let args = mockSocket.pushTopicEventPayloadRefJoinRefReceivedArguments\n expect(args?.payload[\"foo\"]).to(beNil())\n \n fakeClock.tick(channel.timeout / 2)\n joinPush.trigger(\"ok\", payload: [:])\n \n expect(mockSocket.pushTopicEventPayloadRefJoinRefCalled).to(beTrue())\n let args2 = mockSocket.pushTopicEventPayloadRefJoinRefReceivedArguments\n expect(args2?.payload[\"foo\"] as? String).to(equal(\"bar\"))\n })\n \n it(\"does not push if channel join times out\", closure: {\n let joinPush = channel.join()\n channel.push(\"event\", payload: [\"foo\": \"bar\"])\n \n let args = mockSocket.pushTopicEventPayloadRefJoinRefReceivedArguments\n expect(args?.payload[\"foo\"]).to(beNil())\n \n fakeClock.tick(channel.timeout * 2)\n joinPush.trigger(\"ok\", payload: [:])\n \n expect(mockSocket.pushTopicEventPayloadRefJoinRefCalled).to(beTrue())\n let args2 = mockSocket.pushTopicEventPayloadRefJoinRefReceivedArguments\n expect(args2?.payload[\"foo\"]).to(beNil())\n })\n \n it(\"uses channel timeout by default\", closure: {\n channel.join().trigger(\"ok\", payload: [:])\n \n var timeoutCallsCount = 0\n channel\n .push(\"event\", payload: [\"foo\": \"bar\"])\n .receive(\"timeout\", callback: { (_) in\n timeoutCallsCount += 1\n })\n \n fakeClock.tick(channel.timeout / 2)\n expect(timeoutCallsCount).to(equal(0))\n \n fakeClock.tick(channel.timeout)\n expect(timeoutCallsCount).to(equal(1))\n })\n \n it(\"accepts timeout arg\", closure: {\n channel.join().trigger(\"ok\", payload: [:])\n \n var timeoutCallsCount = 0\n channel\n .push(\"event\", payload: [\"foo\": \"bar\"], timeout: channel.timeout * 2)\n .receive(\"timeout\", callback: { (_) in\n timeoutCallsCount += 1\n })\n \n fakeClock.tick(channel.timeout)\n expect(timeoutCallsCount).to(equal(0))\n \n fakeClock.tick(channel.timeout * 2)\n expect(timeoutCallsCount).to(equal(1))\n })\n \n it(\"does not time out after receiving 'ok'\", closure: {\n channel.join().trigger(\"ok\", payload: [:])\n \n var timeoutCallsCount = 0\n let push = channel.push(\"event\", payload: [\"foo\": \"bar\"])\n push.receive(\"timeout\", callback: { (_) in\n timeoutCallsCount += 1\n })\n \n fakeClock.tick(channel.timeout / 2)\n expect(timeoutCallsCount).to(equal(0))\n \n push.trigger(\"ok\", payload: [:])\n \n fakeClock.tick(channel.timeout)\n expect(timeoutCallsCount).to(equal(0))\n })\n \n it(\"throws if channel has not been joined\", closure: {\n expect { channel.push(\"event\", payload: [:]) }.to(throwAssertion())\n })\n }\n \n describe(\"leave\") {\n beforeEach {\n mockClient.readyState = .open\n channel.join().trigger(\"ok\", payload: [:])\n }\n \n it(\"unsubscribes from server events\", closure: {\n mockSocket.makeRefClosure = nil\n mockSocket.makeRefReturnValue = kDefaultRef\n \n let joinRef = channel.joinRef\n channel.leave()\n \n expect(mockSocket.pushTopicEventPayloadRefJoinRefCalled).to(beTrue())\n let args = mockSocket.pushTopicEventPayloadRefJoinRefReceivedArguments\n expect(args?.topic).to(equal(\"topic\"))\n expect(args?.event).to(equal(\"phx_leave\"))\n expect(args?.payload).to(beEmpty())\n expect(args?.joinRef).to(equal(joinRef))\n expect(args?.ref).to(equal(kDefaultRef))\n })\n \n it(\"closes channel on 'ok' from server\", closure: {\n let socket = Socket(endPoint: \"/socket\", transport: { _ in return mockClient })\n \n let channel = socket.channel(\"topic\", params: [\"one\": \"two\"])\n channel.join().trigger(\"ok\", payload: [:])\n \n let anotherChannel = socket.channel(\"another\", params: [\"three\": \"four\"])\n \n expect(socket.channels).to(haveCount(2))\n \n channel.leave().trigger(\"ok\", payload: [:])\n expect(socket.channels).to(haveCount(1))\n expect(socket.channels.first === anotherChannel).to(beTrue())\n })\n }\n \n \n describe(\"isMemeber\") {\n it(\"returns false if the message topic does not match the channel\") {\n let message = Message(topic: \"other\")\n expect(channel.isMember(message)).to(beFalse())\n }\n\n it(\"returns true if topics match but the message doesn't have a join ref\") {\n let message = Message(topic: \"topic\", event: ChannelEvent.close, joinRef: nil)\n expect(channel.isMember(message)).to(beTrue())\n }\n \n it(\"returns true if topics and join refs match\") {\n channel.joinPush.ref = \"2\"\n let message = Message(topic: \"topic\", event: ChannelEvent.close, joinRef: \"2\")\n expect(channel.isMember(message)).to(beTrue())\n }\n \n it(\"returns true if topics and join refs match but event is not lifecycle\") {\n channel.joinPush.ref = \"2\"\n let message = Message(topic: \"topic\", event: \"event\", joinRef: \"2\")\n expect(channel.isMember(message)).to(beTrue())\n }\n \n it(\"returns false topics match and is a lifecycle event but join refs do not match \") {\n channel.joinPush.ref = \"2\"\n let message = Message(topic: \"topic\", event: ChannelEvent.close, joinRef: \"1\")\n expect(channel.isMember(message)).to(beFalse())\n }\n }\n \n describe(\"isClosed\") {\n it(\"returns true if state is .closed\", closure: {\n channel.state = .joined\n expect(channel.isClosed).to(beFalse())\n \n channel.state = .closed\n expect(channel.isClosed).to(beTrue())\n })\n }\n \n describe(\"isErrored\") {\n it(\"returns true if state is .errored\", closure: {\n channel.state = .joined\n expect(channel.isErrored).to(beFalse())\n \n channel.state = .errored\n expect(channel.isErrored).to(beTrue())\n })\n }\n \n describe(\"isJoined\") {\n it(\"returns true if state is .joined\", closure: {\n channel.state = .leaving\n expect(channel.isJoined).to(beFalse())\n \n channel.state = .joined\n expect(channel.isJoined).to(beTrue())\n })\n }\n \n describe(\"isJoining\") {\n it(\"returns true if state is .joining\", closure: {\n channel.state = .joined\n expect(channel.isJoining).to(beFalse())\n \n channel.state = .joining\n expect(channel.isJoining).to(beTrue())\n })\n }\n \n describe(\"isLeaving\") {\n it(\"returns true if state is .leaving\", closure: {\n channel.state = .joined\n expect(channel.isLeaving).to(beFalse())\n \n channel.state = .leaving\n expect(channel.isLeaving).to(beTrue())\n })\n }\n \n }\n}\n"
},
{
"path": "Tests/SwiftPhoenixClientTests/DefaultSerializerSpec.swift",
"content": "//\n// DefaultSerializerSpec.swift\n// SwiftPhoenixClient\n//\n// Created by Daniel Rees on 1/17/19.\n//\n\nimport Quick\nimport Nimble\n@testable import SwiftPhoenixClient\n\nclass DefaultSerializerSpec: QuickSpec {\n \n override func spec() {\n describe(\"encode and decode message\") {\n it(\"converts dictionary to Data and back to Message\", closure: {\n let body: [Any] = [\"join_ref\", \"ref\", \"topic\", \"event\", [\"user_id\": \"abc123\"]]\n let data = Defaults.encode(body)\n expect(String(data: data, encoding: .utf8)).to(equal(\"[\\\"join_ref\\\",\\\"ref\\\",\\\"topic\\\",\\\"event\\\",{\\\"user_id\\\":\\\"abc123\\\"}]\"))\n \n let json = Defaults.decode(data) as? [Any]\n \n let message = Message(json: json!)\n expect(message?.ref).to(equal(\"ref\"))\n expect(message?.joinRef).to(equal(\"join_ref\"))\n expect(message?.topic).to(equal(\"topic\"))\n expect(message?.event).to(equal(\"event\"))\n expect(message?.payload[\"user_id\"] as? String).to(equal(\"abc123\"))\n })\n }\n }\n}\n\n"
},
{
"path": "Tests/SwiftPhoenixClientTests/HeartbeatTimerSpec.swift",
"content": "//\n// HeartbeatTimerSpec.swift\n// SwiftPhoenixClientTests\n//\n// Created by Daniel Rees on 8/24/21.\n// Copyright © 2021 SwiftPhoenixClient. All rights reserved.\n//\n\nimport Quick\nimport Nimble\n@testable import SwiftPhoenixClient\n\nclass HeartbeatTimerSpec: QuickSpec {\n \n override func spec() {\n \n let queue = DispatchQueue(label: \"heartbeat.timer.spec\")\n var timer: HeartbeatTimer!\n \n \n beforeEach {\n timer = HeartbeatTimer(timeInterval: 10, queue: queue)\n }\n \n describe(\"isValid\") {\n it(\"returns false if is not started\") {\n expect(timer.isValid).to(beFalse())\n }\n \n it(\"returns true if the timer has started\") {\n timer.start { /* no-op */ }\n expect(timer.isValid).to(beTrue())\n }\n \n it(\"returns false if timer has been stopped\") {\n timer.start { /* no-op */ }\n timer.stop()\n expect(timer.isValid).to(beFalse())\n }\n }\n \n describe(\"fire\") {\n it(\"calls the event handler\") {\n var timerCalled = 0\n timer.start { timerCalled += 1 }\n expect(timerCalled).to(equal(0))\n \n timer.fire()\n expect(timerCalled).to(equal(1))\n }\n \n it(\"does not call event handler if stopped\") {\n var timerCalled = 0\n timer.start { timerCalled += 1 }\n expect(timerCalled).to(equal(0))\n \n timer.stop()\n timer.fire()\n expect(timerCalled).to(equal(0))\n }\n }\n \n describe(\"equatable\") {\n it(\"equates different timers correctly\", closure: {\n let timerA = HeartbeatTimer(timeInterval: 10, queue: queue)\n let timerB = HeartbeatTimer(timeInterval: 10, queue: queue)\n \n expect(timerA).to(equal(timerA))\n expect(timerA).toNot(equal(timerB))\n \n })\n }\n }\n}\n"
},
{
"path": "Tests/SwiftPhoenixClientTests/MessageSpec.swift",
"content": "//\n// MessageSpec.swift\n// SwiftPhoenixClientTests\n//\n// Created by Daniel Rees on 10/27/21.\n// Copyright © 2021 SwiftPhoenixClient. All rights reserved.\n//\n\nimport Quick\nimport Nimble\n@testable import SwiftPhoenixClient\n\n\nclass MessageSpec: QuickSpec {\n \n override func spec() {\n describe(\"json parsing\") {\n \n it(\"parses a normal message\") {\n let json: [Any] = [\"2\", \"6\", \"my-topic\", \"update\", [\"user\": \"James S.\", \"message\": \"This is a test\"]]\n \n let message = Message(json: json)\n expect(message?.ref).to(equal(\"6\"))\n expect(message?.joinRef).to(equal(\"2\"))\n expect(message?.topic).to(equal(\"my-topic\"))\n expect(message?.event).to(equal(\"update\"))\n expect(message?.payload[\"user\"] as? String).to(equal(\"James S.\"))\n expect(message?.payload[\"message\"] as? String).to(equal(\"This is a test\"))\n expect(message?.status).to(beNil())\n }\n \n it(\"parses a reply\") {\n let json: [Any] = [\"2\", \"6\", \"my-topic\", \"phx_reply\", [\"response\": [\"user\": \"James S.\", \"message\": \"This is a test\"], \"status\": \"ok\"]]\n \n let message = Message(json: json)\n expect(message?.ref).to(equal(\"6\"))\n expect(message?.joinRef).to(equal(\"2\"))\n expect(message?.topic).to(equal(\"my-topic\"))\n expect(message?.event).to(equal(\"phx_reply\"))\n expect(message?.payload[\"user\"] as? String).to(equal(\"James S.\"))\n expect(message?.payload[\"message\"] as? String).to(equal(\"This is a test\"))\n expect(message?.status).to(equal(\"ok\"))\n }\n }\n }\n}\n"
},
{
"path": "Tests/SwiftPhoenixClientTests/PresenceSpec.swift",
"content": "//\n// PresenceSpec.swift\n// SwiftPhoenixClient\n//\n// Created by Simon Bergström on 2018-10-03.\n//\n\nimport Quick\nimport Nimble\n@testable import SwiftPhoenixClient\n\nclass PresenceSpec: QuickSpec {\n \n override func spec() {\n \n /// Fixtures\n let fixJoins: Presence.State = [\"u1\": [\"metas\": [[\"id\":1, \"phx_ref\": \"1.2\"]]]]\n let fixLeaves: Presence.State = [\"u2\": [\"metas\": [[\"id\":2, \"phx_ref\": \"2\"]]]]\n let fixState: Presence.State = [\n \"u1\": [\"metas\": [[\"id\":1, \"phx_ref\": \"1\"]]],\n \"u2\": [\"metas\": [[\"id\":2, \"phx_ref\": \"2\"]]],\n \"u3\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"]]]\n ]\n \n let listByFirst: (_ key: String, _ presence: Presence.Map) -> Presence.Meta\n = { key, pres in\n return pres[\"metas\"]!.first!\n }\n \n /// Mocks\n var mockSocket: SocketMock!\n var channel: Channel!\n \n /// UUT\n var presence: Presence!\n \n beforeEach {\n let mockTransport = PhoenixTransportMock()\n mockSocket = SocketMock(endPoint: \"/socket\", transport: { _ in mockTransport })\n mockSocket.timeout = 10.0\n mockSocket.makeRefReturnValue = \"1\"\n mockSocket.reconnectAfter = { _ in return 1 }\n \n channel = Channel(topic: \"topic\", params: [:], socket: mockSocket)\n channel.joinPush.ref = \"1\"\n \n presence = Presence(channel: channel)\n }\n \n \n describe(\"init\") {\n \n it(\"sets defaults\", closure: {\n expect(presence.state).to(beEmpty())\n expect(presence.pendingDiffs).to(beEmpty())\n expect(presence.channel === channel).to(beTrue())\n expect(presence.joinRef).to(beNil())\n })\n \n it(\"binds to channel with default options\", closure: {\n expect(presence.channel?.getBindings(\"presence_state\")).to(haveCount(1))\n expect(presence.channel?.getBindings(\"presence_diff\")).to(haveCount(1))\n })\n \n it(\"binds to channel with custom options \", closure: {\n let channel = Channel(topic: \"topic\", socket: mockSocket)\n let customOptions\n = Presence.Options(events: [.state: \"custom_state\",\n .diff: \"custom_diff\"])\n let p = Presence(channel: channel, opts: customOptions)\n \n expect(p.channel?.getBindings(\"presence_state\")).to(beEmpty())\n expect(p.channel?.getBindings(\"presence_diff\")).to(beEmpty())\n expect(p.channel?.getBindings(\"custom_state\")).to(haveCount(1))\n expect(p.channel?.getBindings(\"custom_diff\")).to(haveCount(1))\n })\n \n it(\"syncs state and diffs\", closure: {\n let user1: Presence.Map = [\"metas\": [[\"id\": 1, \"phx_ref\": \"1\"]]]\n let user2: Presence.Map = [\"metas\": [[\"id\": 2, \"phx_ref\": \"2\"]]]\n let newState: Presence.State = [\"u1\": user1, \"u2\": user2]\n \n \n channel.trigger(event: \"presence_state\",\n payload: newState,\n ref: \"1\")\n let s = presence.list(by: listByFirst)\n expect(s).to(haveCount(2))\n // can't check values because maps are lazy\n // expect(s[0][\"id\"] as? Int).to(equal(1))\n // expect(s[0][\"phx_ref\"] as? String).to(equal(\"1\"))\n //\n // expect(s[1][\"id\"] as? Int).to(equal(2))\n // expect(s[1][\"phx_ref\"] as? String).to(equal(\"2\"))\n \n channel.trigger(event: \"presence_diff\",\n payload: [\"joins\": [:], \"leaves\": [\"u1\": user1]],\n ref: \"2\")\n \n let l = presence.list(by: listByFirst)\n expect(l).to(haveCount(1))\n expect(l[0][\"id\"] as? Int).to(equal(2))\n expect(l[0][\"phx_ref\"] as? String).to(equal(\"2\"))\n })\n \n it(\"applies pending diff if state is not yet synced\", closure: {\n var onJoins: [(id: String, current: Presence.Map?, new: Presence.Map)] = []\n var onLeaves: [(id: String, current: Presence.Map, left: Presence.Map)] = []\n \n presence.onJoin({ (key, current, new) in\n onJoins.append((key, current, new))\n })\n \n presence.onLeave({ (key, current, left) in\n onLeaves.append((key, current, left))\n })\n \n let user1 = [\"metas\": [[\"id\": 1, \"phx_ref\": \"1\"]]]\n let user2 = [\"metas\": [[\"id\": 2, \"phx_ref\": \"2\"]]]\n let user3 = [\"metas\": [[\"id\": 3, \"phx_ref\": \"3\"]]]\n \n let newState = [\"u1\": user1, \"u2\": user2]\n let leaves = [\"u2\": user2]\n \n let payload1 = [\"joins\": [:], \"leaves\": leaves]\n channel.trigger(event: \"presence_diff\", payload: payload1, ref: \"\")\n \n // there is no state\n expect(presence.list(by: listByFirst)).to(beEmpty())\n \n // pending diffs 1\n expect(presence.pendingDiffs).to(haveCount(1))\n expect(presence.pendingDiffs[0][\"joins\"]).to(beEmpty())\n let t1 = transform(presence.pendingDiffs[0][\"leaves\"]!, and: leaves)\n expect(t1.lhs).to(equal(t1.rhs))\n \n \n channel.trigger(event: \"presence_state\", payload: newState, ref: \"\")\n expect(onLeaves).to(haveCount(1))\n expect(onLeaves[0].id).to(equal(\"u2\"))\n expect(onLeaves[0].current[\"metas\"]).to(beEmpty())\n expect(onLeaves[0].left[\"metas\"]?[0][\"id\"] as? Int).to(equal(2))\n \n \n let s = presence.list(by: listByFirst)\n expect(s).to(haveCount(1))\n expect(s[0][\"id\"] as? Int).to(equal(1))\n expect(s[0][\"phx_ref\"] as? String).to(equal(\"1\"))\n expect(presence.pendingDiffs).to(beEmpty())\n \n expect(onJoins).to(haveCount(2))\n // can't check values because maps are lazy\n // expect(onJoins[0].id).to(equal(\"u1\"))\n // expect(onJoins[0].current).to(beNil())\n // expect(onJoins[0].new[\"metas\"]?[0][\"id\"] as? Int).to(equal(1))\n //\n // expect(onJoins[1].id).to(equal(\"u2\"))\n // expect(onJoins[1].current).to(beNil())\n // expect(onJoins[1].new[\"metas\"]?[0][\"id\"] as? Int).to(equal(2))\n \n \n // disconnect then reconnect\n expect(presence.isPendingSyncState).to(beFalse())\n channel.joinPush.ref = \"2\"\n expect(presence.isPendingSyncState).to(beTrue())\n \n \n channel.trigger(event: \"presence_diff\",\n payload: [\"joins\": [:], \"leaves\": [\"u1\": user1]],\n ref: \"\")\n let d = presence.list(by: listByFirst)\n expect(d).to(haveCount(1))\n expect(d[0][\"id\"] as? Int).to(equal(1))\n expect(d[0][\"phx_ref\"] as? String).to(equal(\"1\"))\n \n channel.trigger(event: \"presence_state\",\n payload: [\"u1\": user1, \"u3\": user3],\n ref: \"\")\n let s2 = presence.list(by: listByFirst)\n expect(s2).to(haveCount(1))\n expect(s2[0][\"id\"] as? Int).to(equal(3))\n expect(s2[0][\"phx_ref\"] as? String).to(equal(\"3\"))\n \n })\n \n \n it(\"allows custom states\", closure: {\n let channel = Channel(topic: \"topic\", socket: mockSocket)\n channel.joinPush.ref = \"1\"\n let customOptions\n = Presence.Options(events: [.state: \"the_state\",\n .diff: \"the_diff\"])\n let presence = Presence(channel: channel, opts: customOptions)\n \n \n let user1: Presence.Map = [\"metas\": [[\"id\": 1, \"phx_ref\": \"1\"]]]\n channel.trigger(event: \"the_state\", payload: [\"user1\": user1], ref: \"\")\n \n let s = presence.list(by: listByFirst)\n expect(s).to(haveCount(1))\n expect(s[0][\"id\"] as? Int).to(equal(1))\n expect(s[0][\"phx_ref\"] as? String).to(equal(\"1\"))\n \n channel.trigger(event: \"the_diff\",\n payload: [\"joins\": [:], \"leaves\": [\"user1\": user1]],\n ref: \"2\")\n \n expect(presence.list(by: listByFirst)).to(beEmpty())\n })\n }\n \n \n describe(\"syncState\") {\n it(\"syncs empty state\", closure: {\n let newState: Presence.State = [\"u1\": [\"metas\": [[\"id\":1, \"phx_ref\": \"1\"]]]]\n var state: Presence.State = [:]\n let stateBefore = state\n \n Presence.syncState(state, newState: newState)\n \n let t1 = transform(state, and: stateBefore)\n expect(t1.lhs).to(equal(t1.rhs))\n \n state = Presence.syncState(state, newState: newState)\n let t2 = transform(state, and: newState)\n expect(t2.lhs).to(equal(t2.rhs))\n })\n \n it(\"onJoins new presences and onLeave's left presences\", closure: {\n let newState = fixState\n var state = [\"u4\": [\"metas\": [[\"id\":4, \"phx_ref\": \"4\"]]]]\n var joined: Presence.Diff = [:]\n var left: Presence.Diff = [:]\n let onJoin: Presence.OnJoin = { key, current, newPres in\n var state: Presence.State = [\"newPres\": newPres]\n if let c = current {\n state[\"current\"] = c\n }\n \n // Diff = [String: Presence.State]\n joined[key] = state\n }\n \n let onLeave: Presence.OnLeave = { key, current, leftPres in\n // Diff = [String: Presence.State]\n left[key] = [\"current\": current, \"leftPres\": leftPres]\n }\n \n let stateBefore = state\n Presence.syncState(state, newState: newState,\n onJoin: onJoin, onLeave: onLeave)\n let t1 = transform(state, and: stateBefore)\n expect(t1.lhs).to(equal(t1.rhs))\n \n state = Presence.syncState(state, newState: newState,\n onJoin: onJoin, onLeave: onLeave)\n let t2 = transform(state, and: newState)\n expect(t2.lhs).to(equal(t2.rhs))\n \n // assert equality in joined\n let joinedExpectation: Presence.Diff = [\n \"u1\": [\"newPres\": [\"metas\": [[\"id\":1, \"phx_ref\": \"1\"]] ]],\n \"u2\": [\"newPres\": [\"metas\": [[\"id\":2, \"phx_ref\": \"2\"]] ]],\n \"u3\": [\"newPres\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"]] ]]\n ]\n let tJoin = transform(joined, and: joinedExpectation)\n expect(tJoin.lhs).to(equal(tJoin.rhs))\n \n // assert equality in left\n let leftExpectation: Presence.Diff = [\"u4\": [\n \"current\": [\"metas\": [] ],\n \"leftPres\": [\"metas\": [[\"id\":4, \"phx_ref\": \"4\"]] ]\n ] ]\n let tLeft = transform(left, and: leftExpectation)\n expect(tLeft.lhs).to(equal(tLeft.rhs))\n })\n \n \n it(\"onJoins only newly added metas\", closure: {\n var state = [\"u3\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"]]]]\n let newState = [\"u3\": [\n \"metas\": [[\"id\":3, \"phx_ref\": \"3\"], [\"id\":3, \"phx_ref\": \"3.new\"]]\n ]]\n \n var joined: Presence.Diff = [:]\n var left: Presence.Diff = [:]\n let onJoin: Presence.OnJoin = { key, current, newPres in\n var state: Presence.State = [\"newPres\": newPres]\n if let c = current {\n state[\"current\"] = c\n }\n \n // Diff = [String: Presence.State]\n joined[key] = state\n }\n \n let onLeave: Presence.OnLeave = { key, current, leftPres in\n // Diff = [String: Presence.State]\n left[key] = [\"current\": current, \"leftPres\": leftPres]\n }\n \n state = Presence.syncState(state, newState: newState,\n onJoin: onJoin, onLeave: onLeave)\n let t2 = transform(state, and: newState)\n expect(t2.lhs).to(equal(t2.rhs))\n \n // assert equality in joined\n let joinedExpectation: Presence.Diff = [\n \"u3\": [\"current\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"]] ],\n \"newPres\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3.new\"]] ]\n ]\n ]\n \n let tJoin = transform(joined, and: joinedExpectation)\n expect(tJoin.lhs).to(equal(tJoin.rhs))\n \n // assert equality in left\n expect(left).to(beEmpty())\n })\n \n it(\"onLeaves only newly removed metas\", closure: {\n let newState = [\"u3\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"]]]]\n var state = [\"u3\": [\n \"metas\": [[\"id\":3, \"phx_ref\": \"3\"], [\"id\":3, \"phx_ref\": \"3.left\"]]\n ]]\n \n var joined: Presence.Diff = [:]\n var left: Presence.Diff = [:]\n let onJoin: Presence.OnJoin = { key, current, newPres in\n var state: Presence.State = [\"newPres\": newPres]\n if let c = current {\n state[\"current\"] = c\n }\n \n // Diff = [String: Presence.State]\n joined[key] = state\n }\n \n let onLeave: Presence.OnLeave = { key, current, leftPres in\n // Diff = [String: Presence.State]\n left[key] = [\"current\": current, \"leftPres\": leftPres]\n }\n \n state = Presence.syncState(state, newState: newState,\n onJoin: onJoin, onLeave: onLeave)\n let t2 = transform(state, and: newState)\n expect(t2.lhs).to(equal(t2.rhs))\n \n // assert equality in joined\n let leftExpectation: Presence.Diff = [\n \"u3\": [\"current\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"]] ],\n \"leftPres\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3.left\"]] ]\n ]\n ]\n \n let tLeft = transform(left, and: leftExpectation)\n expect(tLeft.lhs).to(equal(tLeft.rhs))\n \n // assert equality in left\n expect(joined).to(beEmpty())\n })\n \n it(\"syncs both joined and left metas\", closure: {\n let newState = [\"u3\": [\n \"metas\": [[\"id\":3, \"phx_ref\": \"3\"], [\"id\":3, \"phx_ref\": \"3.new\"]]\n ]]\n var state = [\"u3\": [\n \"metas\": [[\"id\":3, \"phx_ref\": \"3\"], [\"id\":3, \"phx_ref\": \"3.left\"]]\n ]]\n \n var joined: Presence.Diff = [:]\n var left: Presence.Diff = [:]\n let onJoin: Presence.OnJoin = { key, current, newPres in\n var state: Presence.State = [\"newPres\": newPres]\n if let c = current {\n state[\"current\"] = c\n }\n \n // Diff = [String: Presence.State]\n joined[key] = state\n }\n \n let onLeave: Presence.OnLeave = { key, current, leftPres in\n // Diff = [String: Presence.State]\n left[key] = [\"current\": current, \"leftPres\": leftPres]\n }\n \n state = Presence.syncState(state, newState: newState,\n onJoin: onJoin, onLeave: onLeave)\n let t2 = transform(state, and: newState)\n expect(t2.lhs).to(equal(t2.rhs))\n \n // assert equality in joined\n let joinedExpectation: Presence.Diff = [\n \"u3\": [\"current\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"], [\"id\":3, \"phx_ref\": \"3.left\"]] ],\n \"newPres\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3.new\"]] ]\n ]\n ]\n \n let tJoin = transform(joined, and: joinedExpectation)\n expect(tJoin.lhs).to(equal(tJoin.rhs))\n \n // assert equality in left\n let leftExpectation: Presence.Diff = [\n \"u3\": [\"current\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"], [\"id\":3, \"phx_ref\": \"3.new\"]] ],\n \"leftPres\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3.left\"]] ]\n ]\n ]\n \n let tLeft = transform(left, and: leftExpectation)\n expect(tLeft.lhs).to(equal(tLeft.rhs))\n })\n }\n \n describe(\"syncDiff\") {\n it(\"syncs empty state\", closure: {\n let joins: Presence.State = [\"u1\": [\"metas\": [[\"id\":1, \"phx_ref\": \"1\"]]]]\n var state: Presence.State = [:]\n \n Presence.syncDiff(state, diff: [\"joins\": joins, \"leaves\": [:]])\n expect(state).to(beEmpty())\n \n state = Presence.syncDiff(state, diff: [\"joins\": joins, \"leaves\": [:]])\n let t1 = transform(state, and: joins)\n expect(t1.lhs).to(equal(t1.rhs))\n })\n \n it(\"removes presence when meta is empty and adds additional meta\", closure: {\n var state = fixState\n let diff: Presence.Diff = [\"joins\": fixJoins, \"leaves\": fixLeaves]\n state = Presence.syncDiff(state, diff: diff)\n \n let expectation: Presence.State = [\n \"u1\": [\"metas\": [\n [\"id\":1, \"phx_ref\": \"1\"],\n [\"id\":1, \"phx_ref\": \"1.2\"]]\n ],\n \"u3\": [\"metas\": [[\"id\":3, \"phx_ref\": \"3\"]] ]\n ]\n \n let t1 = transform(state, and: expectation)\n expect(t1.lhs).to(equal(t1.rhs))\n })\n \n it(\"removes meta while leaving key if other metas exist\", closure: {\n var state: Presence.State = [\n \"u1\": [\"metas\": [\n [\"id\":1, \"phx_ref\": \"1\"],\n [\"id\":1, \"phx_ref\": \"1.2\"]]\n ]]\n \n let leaves: Presence.State = [\"u1\": [\"metas\": [[\"id\":1, \"phx_ref\": \"1\"]]]]\n let diff: Presence.Diff = [\"joins\": [:], \"leaves\": leaves]\n state = Presence.syncDiff(state, diff: diff)\n })\n }\n }\n}\n"
},
{
"path": "Tests/SwiftPhoenixClientTests/SocketSpec.swift",
"content": "//\n// SocketSpec.swift\n// SwiftPhoenixClient\n//\n// Created by Daniel Rees on 2/10/18.\n//\n\nimport Quick\nimport Nimble\n@testable import SwiftPhoenixClient\n\n@available(iOS 13, *)\nclass SocketSpec: QuickSpec {\n \n let encode = Defaults.encode\n let decode = Defaults.decode\n \n override func spec() {\n \n describe(\"constructor\") {\n it(\"sets defaults\", closure: {\n let socket = Socket(\"wss://localhost:4000/socket\")\n \n expect(socket.channels).to(haveCount(0))\n expect(socket.sendBuffer).to(haveCount(0))\n expect(socket.ref).to(equal(0))\n expect(socket.endPoint).to(equal(\"wss://localhost:4000/socket\"))\n expect(socket.stateChangeCallbacks.open).to(beEmpty())\n expect(socket.stateChangeCallbacks.close).to(beEmpty())\n expect(socket.stateChangeCallbacks.error).to(beEmpty())\n expect(socket.stateChangeCallbacks.message).to(beEmpty())\n expect(socket.timeout).to(equal(Defaults.timeoutInterval))\n expect(socket.heartbeatInterval).to(equal(Defaults.heartbeatInterval))\n expect(socket.logger).to(beNil())\n expect(socket.reconnectAfter(1)).to(equal(0.010)) // 10ms\n expect(socket.reconnectAfter(2)).to(equal(0.050)) // 50ms\n expect(socket.reconnectAfter(3)).to(equal(0.100)) // 100ms\n expect(socket.reconnectAfter(4)).to(equal(0.150)) // 150ms\n expect(socket.reconnectAfter(5)).to(equal(0.200)) // 200ms\n expect(socket.reconnectAfter(6)).to(equal(0.250)) // 250ms\n expect(socket.reconnectAfter(7)).to(equal(0.500)) // 500ms\n expect(socket.reconnectAfter(8)).to(equal(1.000)) // 1_000ms (1s)\n expect(socket.reconnectAfter(9)).to(equal(2.000)) // 2_000ms (2s)\n expect(socket.reconnectAfter(10)).to(equal(5.00)) // 5_000ms (5s)\n expect(socket.reconnectAfter(11)).to(equal(5.00)) // 5_000ms (5s)\n })\n \n it(\"overrides some defaults\", closure: {\n let socket = Socket(\"wss://localhost:4000/socket\", paramsClosure: { [\"one\": 2] })\n socket.timeout = 40000\n socket.heartbeatInterval = 60000\n socket.logger = { _ in }\n socket.reconnectAfter = { _ in return 10 }\n \n expect(socket.timeout).to(equal(40000))\n expect(socket.heartbeatInterval).to(equal(60000))\n expect(socket.logger).toNot(beNil())\n expect(socket.reconnectAfter(1)).to(equal(10))\n expect(socket.reconnectAfter(2)).to(equal(10))\n })\n \n// it(\"sets queue for underlying transport\", closure: {\n// let socket = Socket(endPoint: \"wss://localhost:4000/socket\", transport: { (url) -> WebSocketClient in\n// let webSocket = WebSocket(url: url)\n// webSocket.callbackQueue = DispatchQueue(label: \"test_queue\")\n// return webSocket\n// })\n// socket.timeout = 40000\n// socket.heartbeatInterval = 60000\n// socket.logger = { _ in }\n// socket.reconnectAfter = { _ in return 10 }\n// socket.connect()\n// expect(socket.connection).to(beAKindOf(Transport.self))\n// expect((socket.connection as! WebSocket).callbackQueue.label).to(equal(\"test_queue\"))\n// })\n \n it(\"should construct a valid URL\", closure: {\n \n // test vsn\n expect(Socket(\"http://localhost:4000/socket/websocket\",\n paramsClosure: { [\"token\": \"abc123\"] },\n vsn: \"1.0.0\")\n .endPointUrl\n .absoluteString)\n .to(equal(\"http://localhost:4000/socket/websocket?vsn=1.0.0&token=abc123\"))\n \n // test params\n expect(Socket(\"http://localhost:4000/socket/websocket\",\n paramsClosure: { [\"token\": \"abc123\"] })\n .endPointUrl\n .absoluteString)\n .to(equal(\"http://localhost:4000/socket/websocket?vsn=2.0.0&token=abc123\"))\n \n expect(Socket(\"ws://localhost:4000/socket/websocket\",\n paramsClosure: { [\"token\": \"abc123\", \"user_id\": 1] })\n .endPointUrl\n .absoluteString)\n .to(satisfyAnyOf(\n // absoluteString does not seem to return a string with the params in a deterministic order\n equal(\"ws://localhost:4000/socket/websocket?vsn=2.0.0&token=abc123&user_id=1\"),\n equal(\"ws://localhost:4000/socket/websocket?vsn=2.0.0&user_id=1&token=abc123\")\n )\n )\n \n \n // test params with spaces\n expect(Socket(\"ws://localhost:4000/socket/websocket\",\n paramsClosure: { [\"token\": \"abc 123\", \"user_id\": 1] })\n .endPointUrl\n .absoluteString)\n .to(satisfyAnyOf(\n // absoluteString does not seem to return a string with the params in a deterministic order\n equal(\"ws://localhost:4000/socket/websocket?vsn=2.0.0&token=abc%20123&user_id=1\"),\n equal(\"ws://localhost:4000/socket/websocket?vsn=2.0.0&user_id=1&token=abc%20123\")\n )\n )\n })\n \n it(\"should not introduce any retain cycles\", closure: {\n // Must remain as a weak var in order to deallocate the socket. This tests that the\n // reconnect timer does not old on to the Socket causing a memory leak.\n weak var socket = Socket(\"http://localhost:4000/socket/websocket\")\n expect(socket).to(beNil())\n })\n }\n\n describe(\"params\") {\n it(\"changes dynamically with a closure\") {\n var authToken = \"abc123\"\n let socket = Socket(\"ws://localhost:4000/socket/websocket\", paramsClosure: { [\"token\": authToken] })\n \n expect(socket.params?[\"token\"] as? String).to(equal(\"abc123\"))\n authToken = \"xyz987\"\n expect(socket.params?[\"token\"] as? String).to(equal(\"xyz987\"))\n }\n }\n\n describe(\"websocketProtocol\") {\n it(\"returns wss when protocol is https\", closure: {\n let socket = Socket(\"https://example.com/\")\n expect(socket.websocketProtocol).to(equal(\"wss\"))\n })\n \n it(\"returns wss when protocol is wss\", closure: {\n let socket = Socket(\"wss://example.com/\")\n expect(socket.websocketProtocol).to(equal(\"wss\"))\n })\n \n it(\"returns ws when protocol is http\", closure: {\n let socket = Socket(\"http://example.com/\")\n expect(socket.websocketProtocol).to(equal(\"ws\"))\n })\n \n it(\"returns ws when protocol is ws\", closure: {\n let socket = Socket(\"ws://example.com/\")\n expect(socket.websocketProtocol).to(equal(\"ws\"))\n })\n \n it(\"returns empty if there is no scheme\", closure: {\n let socket = Socket(\"example.com/\")\n expect(socket.websocketProtocol).to(beEmpty())\n })\n }\n \n// describe(\"endPointUrl\") {\n// it(\"does nothing with the url\", closure: {\n// let socket = Socket(\"http://example.com/websocket\")\n// expect(socket.endPointUrl.absoluteString).to(equal(\"http://example.com/websocket\"))\n// })\n// \n// it(\"appends /websocket correctly\", closure: {\n// let socketA = Socket(\"wss://example.org/chat/\")\n// expect(socketA.endPointUrl.absoluteString).to(equal(\"wss://example.org/chat/websocket\"))\n// \n// let socketB = Socket(\"ws://example.org/chat\")\n// expect(socketB.endPointUrl.absoluteString).to(equal(\"ws://example.org/chat/websocket\"))\n// })\n// }\n \n describe(\"connect with Websocket\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n let mockWebSocketTransport: ((URL) -> PhoenixTransportMock) = { _ in return mockWebSocket }\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n socket = Socket(endPoint: \"/socket\", transport: mockWebSocketTransport)\n socket.skipHeartbeat = true\n }\n \n it(\"establishes websocket connection with endpoint\", closure: {\n socket.connect()\n \n expect(socket.connection).toNot(beNil())\n })\n \n it(\"set callbacks for connection\", closure: {\n var open = 0\n socket.onOpen { open += 1 }\n \n var close = 0\n socket.onClose { close += 1 }\n \n var lastError: (Error, URLResponse?)?\n socket.onError(callback: { (error) in lastError = error })\n \n var lastMessage: Message?\n socket.onMessage(callback: { (message) in lastMessage = message })\n \n mockWebSocket.readyState = .closed\n socket.connect()\n \n mockWebSocket.delegate?.onOpen()\n expect(open).to(equal(1))\n \n mockWebSocket.delegate?.onClose(code: 1000, reason: nil)\n expect(close).to(equal(1))\n \n mockWebSocket.delegate?.onError(error: TestError.stub, response: nil)\n expect(lastError).toNot(beNil())\n \n let data: [Any] = [\"2\", \"6\", \"topic\", \"event\", [\"response\": [\"go\": true], \"status\": \"ok\"]]\n let text = toWebSocketText(data: data)\n mockWebSocket.delegate?.onMessage(message: text)\n expect(lastMessage?.payload[\"go\"] as? Bool).to(beTrue())\n })\n \n it(\"removes callbacks\", closure: {\n var open = 0\n socket.onOpen { open += 1 }\n \n var close = 0\n socket.onClose { close += 1 }\n \n var lastError: (Error, URLResponse?)?\n socket.onError(callback: { (error) in lastError = error })\n \n var lastMessage: Message?\n socket.onMessage(callback: { (message) in lastMessage = message })\n \n mockWebSocket.readyState = .closed\n socket.releaseCallbacks()\n socket.connect()\n \n mockWebSocket.delegate?.onOpen()\n expect(open).to(equal(0))\n \n mockWebSocket.delegate?.onClose(code: 1000, reason: nil)\n expect(close).to(equal(0))\n \n mockWebSocket.delegate?.onError(error: TestError.stub, response: nil)\n expect(lastError).to(beNil())\n \n let data: [Any] = [\"2\", \"6\", \"topic\", \"event\", [\"response\": [\"go\": true], \"status\": \"ok\"]]\n let text = toWebSocketText(data: data)\n mockWebSocket.delegate?.onMessage(message: text)\n expect(lastMessage).to(beNil())\n })\n \n it(\"does not connect if already connected\", closure: {\n mockWebSocket.readyState = .open\n \n socket.connect()\n socket.connect()\n \n expect(mockWebSocket.connectCallsCount).to(equal(1))\n })\n }\n \n \n describe(\"disconnect\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n let mockWebSocketTransport: ((URL) -> PhoenixTransportMock) = { _ in return mockWebSocket }\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n socket = Socket(endPoint: \"/socket\", transport: mockWebSocketTransport)\n }\n \n it(\"removes existing connection\", closure: {\n socket.connect()\n socket.disconnect()\n \n expect(socket.connection).to(beNil())\n expect(mockWebSocket.disconnectCodeReasonReceivedArguments?.code)\n .to(equal(Socket.CloseCode.normal.rawValue))\n })\n \n it(\"flags the socket as closed cleanly\", closure: {\n expect(socket.closeStatus).to(equal(.unknown))\n \n socket.disconnect()\n expect(socket.closeStatus).to(equal(.clean))\n })\n \n it(\"calls callback\", closure: {\n var callCount = 0\n socket.connect()\n socket.disconnect(code: .goingAway) {\n callCount += 1\n }\n \n expect(mockWebSocket.disconnectCodeReasonCalled).to(beTrue())\n expect(mockWebSocket.disconnectCodeReasonReceivedArguments?.reason).to(beNil())\n expect(mockWebSocket.disconnectCodeReasonReceivedArguments?.code)\n .to(equal(Socket.CloseCode.goingAway.rawValue))\n expect(callCount).to(equal(1))\n \n })\n \n it(\"calls onClose for all state callbacks\", closure: {\n var callCount = 0\n socket.onClose {\n callCount += 1\n }\n \n socket.disconnect()\n expect(callCount).to(equal(1))\n \n })\n \n it(\"invalidates and invalidates the heartbeat timer\", closure: {\n var timerCalled = 0\n let queue = DispatchQueue(label: \"test.heartbeat\")\n let timer = HeartbeatTimer(timeInterval: 10, queue: queue)\n \n timer.start { timerCalled += 1 }\n\n socket.heartbeatTimer = timer\n \n socket.disconnect()\n expect(socket.heartbeatTimer?.isValid).to(beFalse())\n timer.fire()\n expect(timerCalled).to(equal(0))\n })\n \n it(\"does nothing if not connected\", closure: {\n socket.disconnect()\n expect(mockWebSocket.disconnectCodeReasonCalled).to(beFalse())\n })\n }\n \n \n describe(\"channel\") {\n var socket: Socket!\n \n beforeEach {\n socket = Socket(\"/socket\")\n }\n \n it(\"returns channel with given topic and params\", closure: {\n let channel = socket.channel(\"topic\", params: [\"one\": \"two\"])\n socket.ref = 1006\n \n // No deep equal, so hack it\n expect(channel.socket?.ref).to(equal(socket.ref))\n expect(channel.topic).to(equal(\"topic\"))\n expect(channel.params[\"one\"] as? String).to(equal(\"two\"))\n })\n \n it(\"adds channel to sockets channel list\", closure: {\n expect(socket.channels).to(beEmpty())\n \n let channel = socket.channel(\"topic\", params: [\"one\": \"two\"])\n \n expect(socket.channels).to(haveCount(1))\n expect(socket.channels[0].topic).to(equal(channel.topic))\n })\n }\n \n describe(\"remove\") {\n var socket: Socket!\n \n beforeEach {\n socket = Socket(\"/socket\")\n }\n \n it(\"removes given channel from channels\", closure: {\n let channel1 = socket.channel(\"topic-1\")\n let channel2 = socket.channel(\"topic-2\")\n \n channel1.joinPush.ref = \"1\"\n channel2.joinPush.ref = \"2\"\n \n socket.remove(channel1)\n expect(socket.channels).to(haveCount(1))\n expect(socket.channels[0].topic).to(equal(channel2.topic))\n })\n }\n \n \n describe(\"push\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n let mockWebSocketTransport: ((URL) -> PhoenixTransportMock) = { _ in return mockWebSocket }\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n socket = Socket(endPoint: \"/socket\", transport: mockWebSocketTransport)\n }\n \n it(\"sends data to connection when connected\", closure: {\n mockWebSocket.readyState = .open\n socket.connect()\n socket.push(topic: \"topic\", event: \"event\", payload: [\"one\": \"two\"], ref: \"6\", joinRef: \"2\")\n \n expect(mockWebSocket.sendDataCalled).to(beTrue())\n let json = self.decode(mockWebSocket.sendDataReceivedData!) as! [Any]\n expect(json[0] as? String).to(equal(\"2\"))\n expect(json[1] as? String).to(equal(\"6\"))\n expect(json[2] as? String).to(equal(\"topic\"))\n expect(json[3] as? String).to(equal(\"event\"))\n expect(json[4] as? [String: String]).to(equal([\"one\": \"two\"]))\n \n expect(String(data: mockWebSocket.sendDataReceivedData!, encoding: .utf8))\n .to(equal(\"[\\\"2\\\",\\\"6\\\",\\\"topic\\\",\\\"event\\\",{\\\"one\\\":\\\"two\\\"}]\"))\n })\n \n it(\"excludes ref information if not passed\", closure: {\n mockWebSocket.readyState = .open\n socket.connect()\n socket.push(topic: \"topic\", event: \"event\", payload: [\"one\": \"two\"])\n \n let json = self.decode(mockWebSocket.sendDataReceivedData!) as! [Any?]\n expect(json[0] as? String).to(beNil())\n expect(json[1] as? String).to(beNil())\n expect(json[2] as? String).to(equal(\"topic\"))\n expect(json[3] as? String).to(equal(\"event\"))\n expect(json[4] as? [String: String]).to(equal([\"one\": \"two\"]))\n \n expect(String(data: mockWebSocket.sendDataReceivedData!, encoding: .utf8))\n .to(equal(\"[null,null,\\\"topic\\\",\\\"event\\\",{\\\"one\\\":\\\"two\\\"}]\"))\n })\n \n it(\"buffers data when not connected\", closure: {\n mockWebSocket.readyState = .closed\n socket.connect()\n \n expect(socket.sendBuffer).to(beEmpty())\n \n socket.push(topic: \"topic1\", event: \"event1\", payload: [\"one\": \"two\"])\n expect(mockWebSocket.sendDataCalled).to(beFalse())\n expect(socket.sendBuffer).to(haveCount(1))\n \n socket.push(topic: \"topic2\", event: \"event2\", payload: [\"one\": \"two\"])\n expect(mockWebSocket.sendDataCalled).to(beFalse())\n expect(socket.sendBuffer).to(haveCount(2))\n \n socket.sendBuffer.forEach( { try? $0.callback() } )\n expect(mockWebSocket.sendDataCalled).to(beTrue())\n expect(mockWebSocket.sendDataCallsCount).to(equal(2))\n })\n }\n \n describe(\"makeRef\") {\n var socket: Socket!\n \n beforeEach {\n socket = Socket(\"/socket\")\n }\n \n it(\"returns next message ref\", closure: {\n expect(socket.ref).to(equal(0))\n expect(socket.makeRef()).to(equal(\"1\"))\n expect(socket.ref).to(equal(1))\n expect(socket.makeRef()).to(equal(\"2\"))\n expect(socket.ref).to(equal(2))\n })\n \n it(\"resets to 0 if it hits max int\", closure: {\n socket.ref = UInt64.max\n \n expect(socket.makeRef()).to(equal(\"0\"))\n expect(socket.ref).to(equal(0))\n })\n }\n \n describe(\"sendHeartbeat v1\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n socket = Socket(\"/socket\")\n socket.connection = mockWebSocket\n }\n \n it(\"closes socket when heartbeat is not ack'd within heartbeat window\", closure: {\n mockWebSocket.readyState = .open\n socket.sendHeartbeat()\n expect(mockWebSocket.disconnectCodeReasonCalled).to(beFalse())\n expect(socket.pendingHeartbeatRef).toNot(beNil())\n \n socket.sendHeartbeat()\n expect(mockWebSocket.disconnectCodeReasonCalled).to(beTrue())\n expect(socket.pendingHeartbeatRef).to(beNil())\n })\n \n it(\"pushes heartbeat data when connected\", closure: {\n mockWebSocket.readyState = .open\n \n socket.sendHeartbeat()\n \n expect(socket.pendingHeartbeatRef).to(equal(String(socket.ref)))\n expect(mockWebSocket.sendDataCalled).to(beTrue())\n \n let json = self.decode(mockWebSocket.sendDataReceivedData!) as? [Any?]\n expect(json?[0] as? String).to(beNil())\n expect(json?[1] as? String).to(equal(socket.pendingHeartbeatRef))\n expect(json?[2] as? String).to(equal(\"phoenix\"))\n expect(json?[3] as? String).to(equal(\"heartbeat\"))\n expect(json?[4] as? [String: String]).to(beEmpty())\n \n expect(String(data: mockWebSocket.sendDataReceivedData!, encoding: .utf8))\n .to(equal(\"[null,\\\"1\\\",\\\"phoenix\\\",\\\"heartbeat\\\",{}]\"))\n })\n \n it(\"does nothing when not connected\", closure: {\n mockWebSocket.readyState = .closed\n socket.sendHeartbeat()\n \n expect(mockWebSocket.disconnectCodeReasonCalled).to(beFalse())\n expect(mockWebSocket.sendDataCalled).to(beFalse())\n })\n }\n \n \n describe(\"flushSendBuffer\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n socket = Socket(\"/socket\")\n socket.connection = mockWebSocket\n }\n \n it(\"calls callbacks in buffer when connected\", closure: {\n var oneCalled = 0\n socket.sendBuffer.append((\"0\", { oneCalled += 1 }))\n var twoCalled = 0\n socket.sendBuffer.append((\"1\", { twoCalled += 1 }))\n let threeCalled = 0\n \n mockWebSocket.readyState = .open\n socket.flushSendBuffer()\n expect(oneCalled).to(equal(1))\n expect(twoCalled).to(equal(1))\n expect(threeCalled).to(equal(0))\n })\n \n it(\"empties send buffer\", closure: {\n socket.sendBuffer.append((nil, { }))\n mockWebSocket.readyState = .open\n socket.flushSendBuffer()\n \n expect(socket.sendBuffer).to(beEmpty())\n })\n }\n \n describe(\"removeFromSendBuffer\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n socket = Socket(\"/socket\")\n socket.connection = mockWebSocket\n }\n \n it(\"removes a callback with a matching ref\", closure: {\n var oneCalled = 0\n socket.sendBuffer.append((\"0\", { oneCalled += 1 }))\n var twoCalled = 0\n socket.sendBuffer.append((\"1\", { twoCalled += 1 }))\n let threeCalled = 0\n \n mockWebSocket.readyState = .open\n \n socket.removeFromSendBuffer(ref: \"0\")\n \n socket.flushSendBuffer()\n expect(oneCalled).to(equal(0))\n expect(twoCalled).to(equal(1))\n expect(threeCalled).to(equal(0))\n })\n }\n \n describe(\"onConnectionOpen\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n var mockTimeoutTimer: TimeoutTimerMock!\n let mockWebSocketTransport: ((URL) -> PhoenixTransportMock) = { _ in return mockWebSocket }\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n mockTimeoutTimer = TimeoutTimerMock()\n socket = Socket(endPoint: \"/socket\", transport: mockWebSocketTransport)\n socket.reconnectAfter = { _ in return 10 }\n socket.reconnectTimer = mockTimeoutTimer\n socket.skipHeartbeat = true\n \n mockWebSocket.readyState = .open\n socket.connect()\n }\n \n it(\"flushes the send buffer\", closure: {\n var oneCalled = 0\n socket.sendBuffer.append((\"0\", { oneCalled += 1 })) \n \n socket.onConnectionOpen()\n expect(oneCalled).to(equal(1))\n expect(socket.sendBuffer).to(beEmpty())\n })\n \n it(\"resets reconnectTimer\", closure: {\n socket.onConnectionOpen()\n expect(mockTimeoutTimer.resetCalled).to(beTrue())\n })\n \n it(\"triggers onOpen callbacks\", closure: {\n var oneCalled = 0\n socket.onOpen { oneCalled += 1 }\n var twoCalled = 0\n socket.onOpen { twoCalled += 1 }\n var threeCalled = 0\n socket.onClose { threeCalled += 1 }\n \n socket.onConnectionOpen()\n expect(oneCalled).to(equal(1))\n expect(twoCalled).to(equal(1))\n expect(threeCalled).to(equal(0))\n })\n }\n \n describe(\"resetHeartbeat\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n let mockWebSocketTransport: ((URL) -> PhoenixTransportMock) = { _ in return mockWebSocket }\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n socket = Socket(endPoint: \"/socket\", transport: mockWebSocketTransport)\n \n }\n \n it(\"clears any pending heartbeat\", closure: {\n socket.pendingHeartbeatRef = \"1\"\n socket.resetHeartbeat()\n \n expect(socket.pendingHeartbeatRef).to(beNil())\n })\n \n it(\"does not schedule heartbeat if skipHeartbeat == true\", closure: {\n socket.skipHeartbeat = true\n socket.resetHeartbeat()\n \n expect(socket.heartbeatTimer).to(beNil())\n })\n \n it(\"creates a timer and sends a heartbeat\", closure: {\n mockWebSocket.readyState = .open\n socket.connect()\n socket.heartbeatInterval = 1\n \n expect(socket.heartbeatTimer).to(beNil())\n socket.resetHeartbeat()\n \n expect(socket.heartbeatTimer).toNot(beNil())\n expect(socket.heartbeatTimer?.timeInterval).to(equal(1))\n \n // Fire the timer\n socket.heartbeatTimer?.fire()\n expect(mockWebSocket.sendDataCalled).to(beTrue())\n let json = self.decode(mockWebSocket.sendDataReceivedData!) as? [Any?]\n expect(json?[0] as? String).to(beNil())\n expect(json?[1] as? String).to(equal(String(socket.ref)))\n expect(json?[2] as? String).to(equal(\"phoenix\"))\n expect(json?[3] as? String).to(equal(ChannelEvent.heartbeat))\n expect(json?[4] as? [String: Any]).to(beEmpty())\n })\n \n it(\"should invalidate an old timer and create a new one\", closure: {\n mockWebSocket.readyState = .open\n let queue = DispatchQueue(label: \"test.heartbeat\")\n let timer = HeartbeatTimer(timeInterval: 1000, queue: queue)\n \n var timerCalled = 0\n timer.start { timerCalled += 1 }\n socket.heartbeatTimer = timer\n \n expect(timer.isValid).to(beTrue())\n socket.resetHeartbeat()\n \n expect(timer.isValid).to(beFalse())\n expect(socket.heartbeatTimer).toNot(equal(timer))\n })\n }\n \n describe(\"onConnectionClosed\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n var mockTimeoutTimer: TimeoutTimerMock!\n let mockWebSocketTransport: ((URL) -> PhoenixTransportMock) = { _ in return mockWebSocket }\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n mockTimeoutTimer = TimeoutTimerMock()\n socket = Socket(endPoint: \"/socket\", transport: mockWebSocketTransport)\n// socket.reconnectAfter = { _ in return 10 }\n socket.reconnectTimer = mockTimeoutTimer\n// socket.skipHeartbeat = true\n }\n \n it(\"schedules reconnectTimer timeout if normal close\", closure: {\n socket.onConnectionClosed(code: Socket.CloseCode.normal.rawValue, reason: nil)\n expect(mockTimeoutTimer.scheduleTimeoutCalled).to(beTrue())\n })\n \n \n it(\"does not schedule reconnectTimer timeout if normal close after explicit disconnect\", closure: {\n socket.disconnect()\n expect(mockTimeoutTimer.scheduleTimeoutCalled).to(beFalse())\n })\n \n it(\"schedules reconnectTimer timeout if not normal close\", closure: {\n socket.onConnectionClosed(code: 1001, reason: nil)\n expect(mockTimeoutTimer.scheduleTimeoutCalled).to(beTrue())\n })\n \n it(\"schedules reconnectTimer timeout if connection cannot be made after a previous clean disconnect\", closure: {\n socket.disconnect()\n socket.connect()\n \n socket.onConnectionClosed(code: 1001, reason: nil)\n expect(mockTimeoutTimer.scheduleTimeoutCalled).to(beTrue())\n })\n \n it(\"triggers channel error if joining\", closure: {\n let channel = socket.channel(\"topic\")\n var errorCalled = false\n channel.on(ChannelEvent.error, callback: { _ in\n errorCalled = true\n })\n \n channel.join()\n expect(channel.state).to(equal(.joining))\n\n socket.onConnectionClosed(code: 1001, reason: nil)\n expect(errorCalled).to(beTrue())\n })\n \n it(\"triggers channel error if joined\", closure: {\n let channel = socket.channel(\"topic\")\n var errorCalled = false\n channel.on(ChannelEvent.error, callback: { _ in\n errorCalled = true\n })\n \n channel.join().trigger(\"ok\", payload: [:])\n expect(channel.state).to(equal(.joined))\n \n socket.onConnectionClosed(code: 1001, reason: nil)\n expect(errorCalled).to(beTrue())\n })\n \n it(\"does not trigger channel error after leave\", closure: {\n let channel = socket.channel(\"topic\")\n var errorCalled = false\n channel.on(ChannelEvent.error, callback: { _ in\n errorCalled = true\n })\n \n channel.join().trigger(\"ok\", payload: [:])\n channel.leave()\n expect(channel.state).to(equal(.closed))\n \n socket.onConnectionClosed(code: 1001, reason: nil)\n expect(errorCalled).to(beFalse())\n })\n \n \n it(\"triggers onClose callbacks\", closure: {\n var oneCalled = 0\n socket.onClose { oneCalled += 1 }\n var twoCalled = 0\n socket.onClose { twoCalled += 1 }\n var threeCalled = 0\n socket.onOpen { threeCalled += 1 }\n \n socket.onConnectionClosed(code: 1000, reason: nil)\n expect(oneCalled).to(equal(1))\n expect(twoCalled).to(equal(1))\n expect(threeCalled).to(equal(0))\n })\n }\n \n describe(\"onConnectionError\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n var mockTimeoutTimer: TimeoutTimerMock!\n let mockWebSocketTransport: ((URL) -> PhoenixTransportMock) = { _ in return mockWebSocket }\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n mockTimeoutTimer = TimeoutTimerMock()\n socket = Socket(endPoint: \"/socket\", transport: mockWebSocketTransport)\n socket.reconnectAfter = { _ in return 10 }\n socket.reconnectTimer = mockTimeoutTimer\n socket.skipHeartbeat = true\n \n mockWebSocket.readyState = .open\n socket.connect()\n }\n \n it(\"triggers onClose callbacks\", closure: {\n var lastError: (Error, URLResponse?)?\n socket.onError(callback: { (error) in lastError = error })\n \n socket.onConnectionError(TestError.stub, response: nil)\n expect(lastError).toNot(beNil())\n })\n \n \n it(\"triggers channel error if joining\", closure: {\n let channel = socket.channel(\"topic\")\n var errorCalled = false\n channel.on(ChannelEvent.error, callback: { _ in\n errorCalled = true\n })\n \n channel.join()\n expect(channel.state).to(equal(.joining))\n \n socket.onConnectionError(TestError.stub, response: nil)\n expect(errorCalled).to(beTrue())\n })\n \n it(\"triggers channel error if joined\", closure: {\n let channel = socket.channel(\"topic\")\n var errorCalled = false\n channel.on(ChannelEvent.error, callback: { _ in\n errorCalled = true\n })\n \n channel.join().trigger(\"ok\", payload: [:])\n expect(channel.state).to(equal(.joined))\n \n socket.onConnectionError(TestError.stub, response: nil)\n expect(errorCalled).to(beTrue())\n })\n \n it(\"does not trigger channel error after leave\", closure: {\n let channel = socket.channel(\"topic\")\n var errorCalled = false\n channel.on(ChannelEvent.error, callback: { _ in\n errorCalled = true\n })\n \n channel.join().trigger(\"ok\", payload: [:])\n channel.leave()\n expect(channel.state).to(equal(.closed))\n \n socket.onConnectionError(TestError.stub, response: nil)\n expect(errorCalled).to(beFalse())\n })\n }\n \n describe(\"onConnectionMessage\") {\n // Mocks\n var mockWebSocket: PhoenixTransportMock!\n var mockTimeoutTimer: TimeoutTimerMock!\n let mockWebSocketTransport: ((URL) -> PhoenixTransportMock) = { _ in return mockWebSocket }\n \n // UUT\n var socket: Socket!\n \n beforeEach {\n mockWebSocket = PhoenixTransportMock()\n mockTimeoutTimer = TimeoutTimerMock()\n socket = Socket(endPoint: \"/socket\", transport: mockWebSocketTransport)\n socket.reconnectAfter = { _ in return 10 }\n socket.reconnectTimer = mockTimeoutTimer\n socket.skipHeartbeat = true\n \n mockWebSocket.readyState = .open\n socket.connect()\n }\n \n it(\"parses raw message and triggers channel event\", closure: {\n let targetChannel = socket.channel(\"topic\")\n let otherChannel = socket.channel(\"off-topic\")\n \n var targetMessage: Message?\n targetChannel.on(\"event\", callback: { (msg) in targetMessage = msg })\n \n var otherMessage: Message?\n otherChannel.on(\"event\", callback: { (msg) in otherMessage = msg })\n \n \n let data: [Any?] = [nil, nil, \"topic\", \"event\", [\"status\": \"ok\", \"response\": [\"one\": \"two\"]]]\n let rawMessage = toWebSocketText(data: data)\n \n socket.onConnectionMessage(rawMessage)\n expect(targetMessage?.topic).to(equal(\"topic\"))\n expect(targetMessage?.event).to(equal(\"event\"))\n expect(targetMessage?.payload[\"one\"] as? String).to(equal(\"two\"))\n expect(otherMessage).to(beNil())\n })\n \n it(\"triggers onMessage callbacks\", closure: {\n var message: Message?\n socket.onMessage(callback: { (msg) in message = msg })\n \n let data: [Any?] = [nil, nil, \"topic\", \"event\", [\"status\": \"ok\", \"response\": [\"one\": \"two\"]]]\n let rawMessage = toWebSocketText(data: data)\n \n socket.onConnectionMessage(rawMessage)\n expect(message?.topic).to(equal(\"topic\"))\n expect(message?.event).to(equal(\"event\"))\n expect(message?.payload[\"one\"] as? String).to(equal(\"two\"))\n })\n \n it(\"clears pending heartbeat\", closure: {\n socket.pendingHeartbeatRef = \"5\"\n let rawMessage = \"[null,\\\"5\\\",\\\"phoenix\\\",\\\"phx_reply\\\",{\\\"response\\\":{},\\\"status\\\":\\\"ok\\\"}]\"\n socket.onConnectionMessage(rawMessage)\n expect(socket.pendingHeartbeatRef).to(beNil())\n })\n }\n }\n}\n\n"
},
{
"path": "Tests/SwiftPhoenixClientTests/TimeoutTimerSpec.swift",
"content": "//\n// TimeoutTimerSpec.swift\n// SwiftPhoenixClientTests\n//\n// Created by Daniel Rees on 2/10/19.\n//\n\nimport Quick\nimport Nimble\n@testable import SwiftPhoenixClient\n\nclass TimeoutTimerSpec: QuickSpec {\n \n public func secondsBetweenDates(_ first: Date, _ second: Date) -> Double {\n var diff = first.timeIntervalSince1970 - second.timeIntervalSince1970\n diff = fabs(diff)\n return diff\n }\n \n \n override func spec() {\n \n let fakeClock = FakeTimerQueue()\n var timer: TimeoutTimer!\n \n \n beforeEach {\n fakeClock.reset()\n \n timer = TimeoutTimer()\n timer.queue = fakeClock\n }\n \n describe(\"retain cycles\") {\n it(\"does not hold any retain cycles\", closure: {\n// var weakTimer: TimeoutTimer? = TimeoutTimer()\n// \n// var weakTimerCalled: Bool = false\n// timer.callback.delegate(to: weakTimer!) { (_) in\n// weakTimerCalled = true\n// }\n// \n// timer.timerCalculation.delegate(to: weakTimer!) { _,_ in 1.0 }\n// \n// \n// timer.scheduleTimeout()\n// fakeClock.tick(600)\n// weakTimer = nil\n// \n// fakeClock.tick(600)\n// expect(timer.tries).to(equal(1))\n// expect(weakTimerCalled).to(beFalse())\n })\n }\n \n \n describe(\"scheduleTimeout\") {\n it(\"schedules timeouts, resets the timer, and schedules another timeout\", closure: {\n var callbackTimes: [Date] = []\n timer.callback.delegate(to: self) { (_) in\n callbackTimes.append(Date())\n }\n \n timer.timerCalculation.delegate(to: self) { (_, tries) -> TimeInterval in\n return tries > 2 ? 10.0 : [1.0, 2.0, 5.0][tries - 1]\n }\n \n timer.scheduleTimeout()\n fakeClock.tick(1100)\n expect(timer.tries).to(equal(1))\n \n timer.scheduleTimeout()\n fakeClock.tick(2100)\n expect(timer.tries).to(equal(2))\n \n timer.reset()\n timer.scheduleTimeout()\n fakeClock.tick(1100)\n expect(timer.tries).to(equal(1))\n })\n \n it(\"does not start timer if no interval is provided\", closure: {\n timer.scheduleTimeout()\n expect(timer.workItem).to(beNil())\n })\n }\n }\n}\n\n"
},
{
"path": "Tests/SwiftPhoenixClientTests/URLSessionTransportSpec.swift",
"content": "//\n// URLSessionTransportSpec.swift\n// SwiftPhoenixClientTests\n//\n// Created by Daniel Rees on 4/1/21.\n// Copyright © 2021 SwiftPhoenixClient. All rights reserved.\n//\n\nimport Quick\nimport Nimble\n@testable import SwiftPhoenixClient\n\nclass URLSessionTransportSpec: QuickSpec {\n \n override func spec() {\n \n describe(\"init\") {\n it(\"replaces http with ws protocols\") {\n if #available(iOS 13, *) {\n expect(\n URLSessionTransport(url: URL(string:\"http://localhost:4000/socket/websocket\")!)\n .url.absoluteString\n ).to(equal(\"ws://localhost:4000/socket/websocket\"))\n \n expect(\n URLSessionTransport(url: URL(string:\"https://localhost:4000/socket/websocket\")!)\n .url.absoluteString\n ).to(equal(\"wss://localhost:4000/socket/websocket\"))\n \n expect(\n URLSessionTransport(url: URL(string:\"ws://localhost:4000/socket/websocket\")!)\n .url.absoluteString\n ).to(equal(\"ws://localhost:4000/socket/websocket\"))\n \n expect(\n URLSessionTransport(url: URL(string:\"wss://localhost:4000/socket/websocket\")!)\n .url.absoluteString\n ).to(equal(\"wss://localhost:4000/socket/websocket\"))\n \n } else {\n // Fallback on earlier versions\n expect(\"wrong iOS version\").to(equal(\"You must run this test on an iOS 13 device\"))\n }\n }\n \n it(\"accepts an override for the configuration\") {\n if #available(iOS 13, *) {\n let configuration = URLSessionConfiguration.default\n expect(\n URLSessionTransport(url: URL(string:\"wss://localhost:4000\")!, configuration: configuration)\n .configuration\n ).to(equal(configuration))\n } else {\n // Fallback on earlier versions\n expect(\"wrong iOS version\").to(equal(\"You must run this test on an iOS 13 device\"))\n }\n }\n }\n }\n}\n\n"
},
{
"path": "docs/Classes/Channel.html",
"content": "\n\n \n Channel Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Channel \n \n
\n
public class Channel \n\n
\n
Undocumented
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
The topic of the Channel. e.g. “rooms:friends”
\n\n
\n
Declaration \n
\n
Swift
\n
public let topic : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The params sent when joining the channel
\n\n
\n
Declaration \n
\n
Swift
\n
public var params : Payload { get set } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Overridable message hook. Receives all events for specialized message\nhandling before dispatching to the channel callbacks.
\n\n
\nreturn: Must return the message, modified or unmodified \n \n\n
\n
Parameters \n
\n \n \n \n \n msg \n \n \n \n \n
The Message received by the client from the server
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Joins the channel
\n\n
\n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func join ( timeout : TimeInterval ? = nil ) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n timeout \n \n \n \n \n
Optional. Defaults to Channel’s timeout
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Hook into when the Channel is closed. Does not handle retain cycles.\nUse delegateOnClose(to:) for automatic handling of retain cycles.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nchannel . onClose () { [ weak self ] message in \n self ? . print ( \"Channel \\( message . topic ) has closed\" \n} \n\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func onClose ( _ callback : @escaping (( Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Channel closes
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Hook into when the Channel is closed. Automatically handles retain\ncycles. Use onClose() to handle yourself.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nchannel . delegateOnClose ( to : self ) { ( self , message ) in \n self . print ( \"Channel \\( message . topic ) has closed\" \n} \n\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func delegateOnClose < Target : AnyObject > ( to owner : Target , \n callback : @escaping (( Target , Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Channel closes
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Hook into when the Channel receives an Error. Does not handle retain\ncycles. Use delegateOnError(to:) for automatic handling of retain\ncycles.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nchannel . onError () { [ weak self ] ( message ) in \n self ? . print ( \"Channel \\( message . topic ) has errored\" \n} \n\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func onError ( _ callback : @escaping (( _ message : Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Channel closes
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Hook into when the Channel receives an Error. Automatically handles\nretain cycles. Use onError() to handle yourself.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nchannel . delegateOnError ( to : self ) { ( self , message ) in \n self . print ( \"Channel \\( message . topic ) has closed\" \n} \n\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func delegateOnError < Target : AnyObject > ( to owner : Target , \n callback : @escaping (( Target , Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Channel closes
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Subscribes on channel events. Does not handle retain cycles. Use\ndelegateOn(_:, to:) for automatic handling of retain cycles.
\n\n
Subscription returns a ref counter, which can be used later to\nunsubscribe the exact event listener
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nlet ref1 = channel . on ( \"event\" ) { [ weak self ] ( message ) in \n self ? . print ( \"do stuff\" ) \n} \nlet ref2 = channel . on ( \"event\" ) { [ weak self ] ( message ) in \n self ? . print ( \"do other stuff\" ) \n} \nchannel . off ( \"event\" , ref1 ) \n\n\n
Since unsubscription of ref1, “do stuff” won’t print, but “do other\nstuff” will keep on printing on the “event”
\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func on ( _ event : String , callback : @escaping (( Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n \n \n \n \n \n callback \n \n \n \n \n
Called with the event’s message
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Subscribes on channel events. Automatically handles retain cycles. Use\non() to handle yourself.
\n\n
Subscription returns a ref counter, which can be used later to\nunsubscribe the exact event listener
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nlet ref1 = channel . delegateOn ( \"event\" , to : self ) { ( self , message ) in \n self ? . print ( \"do stuff\" ) \n} \nlet ref2 = channel . delegateOn ( \"event\" , to : self ) { ( self , message ) in \n self ? . print ( \"do other stuff\" ) \n} \nchannel . off ( \"event\" , ref1 ) \n\n\n
Since unsubscription of ref1, “do stuff” won’t print, but “do other\nstuff” will keep on printing on the “event”
\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func delegateOn < Target : AnyObject > ( _ event : String , \n to owner : Target , \n callback : @escaping (( Target , Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n \n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called with the event’s message
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Unsubscribes from a channel event. If a ref is given, only the exact\nlistener will be removed. Else all listeners for the event will be\nremoved.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nlet ref1 = channel . on ( \"event\" ) { _ in print ( \"ref1 event\" } \nlet ref2 = channel . on ( \"event\" ) { _ in print ( \"ref2 event\" } \nlet ref3 = channel . on ( \"other_event\" ) { _ in print ( \"ref3 other\" } \nlet ref4 = channel . on ( \"other_event\" ) { _ in print ( \"ref4 other\" } \nchannel . off ( \"event\" , ref1 ) \nchannel . off ( \"other_event\" ) \n\n\n
After this, only “ref2 event” will be printed if the channel receives\n“event” and nothing is printed if the channel receives “other_event”.
\n\n
\nparamter ref: Ref counter returned when subscribing. Can be omitted \n \n\n
\n
Declaration \n
\n
Swift
\n
public func off ( _ event : String , ref : Int ? = nil ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n
Event to unsubscribe from
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Push a payload to the Channel
\n\n
Example:
\n
channel \n . push ( \"event\" , payload : [ \"message\" : \"hello\" ) \n . receive ( \"ok\" ) { _ in { print ( \"message sent\" ) } \n\n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func push ( _ event : String , \n payload : Payload , \n timeout : TimeInterval = Defaults . timeoutInterval ) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n \n \n \n \n \n payload \n \n \n \n \n \n \n \n \n \n timeout \n \n \n \n \n \n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Leaves the channel
\n\n
Unsubscribes from server events, and instructs channel to terminate on\n server
\n\n
Triggers onClose() hooks
\n\n
To receive leave acknowledgements, use the a receive\n hook to bind to the server ack, ie:
\n\n
Example:\n/\n channel.leave().receive(“ok”) { _ in { print(“left”) }
\n\n
\nreturn: Push that can add receive hooks \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func leave ( timeout : TimeInterval = Defaults . timeoutInterval ) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n timeout \n \n \n \n \n \n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Overridable message hook. Receives all events for specialized message\nhandling before dispatching to the channel callbacks.
\n\n
\nreturn: Must return the payload, modified or unmodified \n \n\n
\n
Declaration \n
\n
Swift
\n
public func onMessage ( callback : @escaping ( Message ) -> Message ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n
The event the message was for
\n
\n \n \n \n \n payload \n \n \n \n \n
The payload for the message
\n
\n \n \n \n \n ref \n \n \n \n \n
The reference of the message
\n
\n \n \n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the Channel has been closed \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isClosed : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the Channel experienced an error \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isErrored : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the channel has joined \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isJoined : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the channel has requested to join \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isJoining : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the channel has requested to leave \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isLeaving : Bool { get } \n\n
\n
\n
\n \n
\n \n \n \n
Defaults Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Defaults \n \n
\n
public class Defaults \n\n
\n
A collection of default values and behaviors used accross the Client
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Default timeout when sending messages
\n\n
\n
Declaration \n
\n
Swift
\n
public static let timeoutInterval : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default interval to send heartbeats on
\n\n
\n
Declaration \n
\n
Swift
\n
public static let heartbeatInterval : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default reconnect algorithm for the socket
\n\n
\n
Declaration \n
\n
Swift
\n
public static let reconnectSteppedBackOff : ( Int ) -> TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default rejoin algorithm for individual channels
\n\n
\n
Declaration \n
\n
Swift
\n
public static let rejoinSteppedBackOff : ( Int ) -> TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default encode function, utilizing JSONSerialization.data
\n\n
\n
Declaration \n
\n
Swift
\n
public static let encode : ([ String : Any ]) -> Data \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default decode function, utilizing JSONSerialization.jsonObject
\n\n
\n
Declaration \n
\n
Swift
\n
public static let decode : ( Data ) -> [ String : Any ]? \n\n
\n
\n
\n \n
\n \n \n \n
Message Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Message \n \n
\n
public class Message \n\n
\n
Data that is received from the Server.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Reference number. Empty if missing
\n\n
\n
Declaration \n
\n
Swift
\n
public let ref : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public let topic : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public let event : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public var payload : Payload \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Convenience accessor. Equivalent to getting the status as such:
\n
message . payload [ \"status\" ] \n\n\n
\n
Declaration \n
\n
Swift
\n
public var status : String ? { get } \n\n
\n
\n
\n \n
\n \n \n \n
Events Enumeration Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Events \n \n
\n
public enum Events : String \n\n
\n
Presense Events
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case state = \"state\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case diff = \"diff\" \n\n
\n
\n
\n \n
\n \n \n \n
Options Structure Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Options \n \n
\n
public struct Options \n\n
\n
Custom options that can be provided when creating Presence
\nExample: \nlet options = Options ( events : [ . state : \"my_state\" , . diff : \"my_diff\" ]) \nlet presence = Presence ( channel , opts : options ) \n \n \n \n
\n \n \n \n
\n
\n
\n \n
Default set of Options used when creating Presence. Uses the\nphoenix events “presence_state” and “presence_diff”
\n\n
\n
Declaration \n
\n
Swift
\n
public static let defaults : Presence . Options \n\n
\n
\n
\n \n
\n \n \n \n
Presence Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Presence \n \n
\n
public final class Presence \n\n
\n
The Presence object provides features for syncing presence information from\nthe server with the client and handling presences joining and leaving.
\nSyncing state from the server \n\nTo sync presence state from the server, first instantiate an object and pass\nyour channel in to track lifecycle events:
\nlet channel = socket . channel ( \"some:topic\" ) \nlet presence = Presence ( channel ) \nIf you have custom syncing state events, you can configure the Presence\nobject to use those instead.
\nlet options = Options ( events : [ . state : \"my_state\" , . diff : \"my_diff\" ]) \nlet presence = Presence ( channel , opts : options ) \nNext, use the presence.onSync callback to react to state changes from the\nserver. For example, to render the list of users every time the list\nchanges, you could write:
\npresence . onSync { renderUsers ( presence . list ()) } \nListing Presences \n\npresence.list is used to return a list of presence information based on the\nlocal state of metadata. By default, all presence metadata is returned, but\na listBy function can be supplied to allow the client to select which\nmetadata to use for a given presence. For example, you may have a user\nonline from different devices with a metadata status of “online”, but they\nhave set themselves to “away” on another device. In this case, the app may\nchoose to use the “away” status for what appears on the UI. The example\nbelow defines a listBy function which prioritizes the first metadata which\nwas registered for each user. This could be the first tab they opened, or\nthe first device they came online from:
\nlet listBy : ( String , Presence . Map ) -> Presence . Meta = { id , pres in \n let first = pres [ \"metas\" ] !. first ! \n first [ \"count\" ] = pres [ \"metas\" ] !. count \n first [ \"id\" ] = id \n return first \n} \nlet onlineUsers = presence . list ( by : listBy ) \n(NOTE: The underlying behavior is a map on the presence.state. You are\nmapping the state dictionary into whatever datastructure suites your needs)
\nHandling individual presence join and leave events \n\nThe presence.onJoin and presence.onLeave callbacks can be used to react to\nindividual presences joining and leaving the app. For example:
\nlet presence = Presence ( channel ) \npresence . onJoin { [ weak self ] ( key , current , newPres ) in \n if let cur = current { \n print ( \"user additional presence\" , cur ) \n } else { \n print ( \"user entered for the first time\" , newPres ) \n } \n} \n\npresence . onLeave { [ weak self ] ( key , current , leftPres ) in \n if current [ \"metas\" ]? . isEmpty == true { \n print ( \"user has left from all devices\" , leftPres ) \n } else { \n print ( \"user left from a device\" , current ) \n } \n} \n\npresence . onSync { renderUsers ( presence . list ()) } \n \n \n \n
\n
\n
\n
\n
\n
Enums and Structs
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Custom options that can be provided when creating Presence
\n
Example: \n
let options = Options ( events : [ . state : \"my_state\" , . diff : \"my_diff\" ]) \nlet presence = Presence ( channel , opts : options ) \n\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public struct Options \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public enum Events : String \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Meta details of a Presence. Just a dictionary of properties
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias Meta = [ String : Any ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
A mapping of a String to an array of Metas. e.g. {“metas”: [{id: 1}]}
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias Map = [ String : [ Meta ]] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
A mapping of a Presence state to a mapping of Metas
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias State = [ String : Map ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public typealias Diff = [ String : State ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Closure signature of OnJoin callbacks
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias OnJoin = ( _ key : String , _ current : Map ?, _ new : Map ) -> Void \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Closure signature for OnLeave callbacks
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias OnLeave = ( _ key : String , _ current : Map , _ left : Map ) -> Void \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
/ Closure signature for OnSync callbacks
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias OnSync = () -> Void \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
The state of the Presence
\n\n
\n
Declaration \n
\n
Swift
\n
private(set) public var state : State \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Pending join and leave diffs that need to be synced
\n\n
\n
Declaration \n
\n
Swift
\n
private(set) public var pendingDiffs : [ Diff ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The channel’s joinRef, set when state events occur
\n\n
\n
Declaration \n
\n
Swift
\n
private(set) public var joinRef : String ? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public var isPendingSyncState : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Callback to be informed of joins
\n\n
\n
Declaration \n
\n
Swift
\n
public var onJoin : OnJoin { get set } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Set the OnJoin callback
\n\n
\n
Declaration \n
\n
Swift
\n
public func onJoin ( _ callback : @escaping OnJoin ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Callback to be informed of leaves
\n\n
\n
Declaration \n
\n
Swift
\n
public var onLeave : OnLeave { get set } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Set the OnLeave callback
\n\n
\n
Declaration \n
\n
Swift
\n
public func onLeave ( _ callback : @escaping OnLeave ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Callback to be informed of synces
\n\n
\n
Declaration \n
\n
Swift
\n
public var onSync : OnSync { get set } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Set the OnSync callback
\n\n
\n
Declaration \n
\n
Swift
\n
public func onSync ( _ callback : @escaping OnSync ) \n\n
\n
\n
\n \n \n \n \n \n \n \n
\n
\n
\n \n
Returns the array of presences, with deault selected metadata.
\n\n
\n
Declaration \n
\n
Swift
\n
public func list () -> [ Map ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Returns the array of presences, with selected metadata
\n\n
\n
Declaration \n
\n
Swift
\n
public func list < T > ( by transformer : ( String , Map ) -> T ) -> [ T ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Filter the Presence state with a given function
\n\n
\n
Declaration \n
\n
Swift
\n
public func filter ( by filter : (( String , Map ) -> Bool )?) -> State \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
@discardableResult \npublic static func syncState ( _ currentState : State , \n newState : State , \n onJoin : OnJoin = { _ , _ , _ in }, \n onLeave : OnLeave = { _ , _ , _ in }) -> State \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
@discardableResult \npublic static func syncDiff ( _ currentState : State , \n diff : Diff , \n onJoin : OnJoin = { _ , _ , _ in }, \n onLeave : OnLeave = { _ , _ , _ in }) -> State \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static func filter ( _ presences : State , \n by filter : (( String , Map ) -> Bool )?) -> State \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static func listBy < T > ( _ presences : State , \n transformer : ( String , Map ) -> T ) -> [ T ] \n\n
\n
\n
\n \n
\n \n \n \n
Push Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Push \n \n Represnts pushing data to a Channel Socket
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
The channel sending the Push
\n\n
\n
Declaration \n
\n
Swift
\n
public weak var channel : Channel ? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The event, for example phx_join
\n\n
\n
Declaration \n
\n
Swift
\n
public let event : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The payload, for example [“user_id”: “abc123”]
\n\n
\n
Declaration \n
\n
Swift
\n
public var payload : Payload \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The push timeout. Default is 10.0 seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public var timeout : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Resets and sends the Push
\n\n
\n
Declaration \n
\n
Swift
\n
public func resend ( _ timeout : TimeInterval = Defaults . timeoutInterval ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n timeout \n \n \n \n \n
Optional. The push timeout. Default is 10.0s
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Sends the Push. If it has already timed out, then the call will\nbe ignored and return early. Use resend in this case.
\n\n
\n
Declaration \n
\n
Swift
\n
public func send () \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Receive a specific event when sending an Outbound message. Subscribing\nto status events with this method does not guarantees no retain cycles.\nYou should pass weak self in the capture list of the callback. You\ncan call `.delegateReceive(status:, to:, callback:) and the library will\nhandle it for you.
\n\n
Example:
\n
channel \n . send ( event : \"custom\" , payload : [ \"body\" : \"example\" ]) \n . receive ( \"error\" ) { [ weak self ] payload in \n print ( \"Error: \" , payload ) \n } \n\n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func receive ( _ status : String , \n callback : @escaping (( Message ) -> ())) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n status \n \n \n \n \n \n \n \n \n \n callback \n \n \n \n \n
Callback to fire when the status is recevied
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Receive a specific event when sending an Outbound message. Automatically\nprevents retain cycles. See manualReceive(status:, callback:) if you\nwant to handle this yourself.
\n\n
Example:
\n
channel \n . send ( event : \"custom\" , payload : [ \"body\" : \"example\" ]) \n . delegateReceive ( \"error\" , to : self ) { payload in \n print ( \"Error: \" , payload ) \n } \n\n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func delegateReceive < Target : AnyObject > ( _ status : String , \n to owner : Target , \n callback : @escaping (( Target , Message ) -> ())) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n status \n \n \n \n \n \n \n \n \n \n owner \n \n \n \n \n
The class that is calling .receive. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Callback to fire when the status is recevied
\n
\n \n \n
\n
\n
\n \n
\n \n \n \n
Socket Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Socket \n \n
\n
public class Socket \n
extension Socket : WebSocketDelegate \n\n
\n
Socket Connection \n\nA single connection is established to the server and\nchannels are multiplexed over the connection.\nConnect to the server using the Socket class:
\nlet socket = new Socket ( \"/socket\" , paramsClosure : { [ \"userToken\" : \"123\" ] }) \nsocket . connect () \nThe Socket constructor takes the mount point of the socket,\nthe authentication params, as well as options that can be found in\nthe Socket docs, such as configuring the heartbeat.
\n\n \n \n \n
\n
\n
\n
\n
\n
Public Attributes
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The string WebSocket endpoint (ie "ws://example.com/socket",\n"wss://example.com", etc.) That was passed to the Socket during\ninitialization. The URL endpoint will be modified by the Socket to\ninclude "/websocket" if missing.
\n\n
\n
Declaration \n
\n
Swift
\n
public let endPoint : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The fully qualified socket URL
\n\n
\n
Declaration \n
\n
Swift
\n
public private(set) var endPointUrl : URL \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Resolves to return the paramsClosure Socket was created with static params, then those will be\nreturned every time.
\n\n
\n
Declaration \n
\n
Swift
\n
public var params : Payload ? { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The optional params closure used to get params whhen connecting. Must\nbe set when initializaing the Socket.
\n\n
\n
\n \n \n \n
\n
\n
\n \n
Override to provide custom encoding of data before writing to the socket
\n\n
\n
Declaration \n
\n
Swift
\n
public var encode : ([ String : Any ]) -> Data \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Override to provide customd decoding of data read from the socket
\n\n
\n
Declaration \n
\n
Swift
\n
public var decode : ( Data ) -> [ String : Any ]? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Timeout to use when opening connections
\n\n
\n
Declaration \n
\n
Swift
\n
public var timeout : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Interval between sending a heartbeat
\n\n
\n
Declaration \n
\n
Swift
\n
public var heartbeatInterval : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Interval between socket reconnect attempts, in seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public var reconnectAfter : ( Int ) -> TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Interval between channel rejoin attempts, in seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public var rejoinAfter : ( Int ) -> TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The optional function to receive logs
\n\n
\n
Declaration \n
\n
Swift
\n
public var logger : (( String ) -> Void )? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Disables heartbeats from being sent. Default is false.
\n\n
\n
Declaration \n
\n
Swift
\n
public var skipHeartbeat : Bool \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Enable/Disable SSL certificate validation. Default is false. This\nmust be set before calling socket.connect() in order to be applied
\n\n
\n
Declaration \n
\n
Swift
\n
public var disableSSLCertValidation : Bool \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Configure custom SSL validation logic, eg. SSL pinning. This\nmust be set before calling socket.connect() in order to apply.
\n\n
\n
Declaration \n
\n
Swift
\n
public var security : SSLTrustValidator ? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Configure the encryption used by your client by setting the\nallowed cipher suites supported by your server. This must be\nset before calling socket.connect() in order to apply.
\n\n
\n
Declaration \n
\n
Swift
\n
public var enabledSSLCipherSuites : [ SSLCipherSuite ]? \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public convenience init ( _ endPoint : String , \n params : Payload ? = nil ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public convenience init ( _ endPoint : String , \n paramsClosure : PayloadClosure ?) \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: The socket protocol, wss or ws \n \n\n
\n
Declaration \n
\n
Swift
\n
public var websocketProtocol : String { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the socket is connected \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isConnected : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Connects the Socket. The params passed to the Socket on initialization\nwill be sent through the connection. If the Socket is already connected,\nthen this call will be ignored.
\n\n
\n
Declaration \n
\n
Swift
\n
public func connect () \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Disconnects the socket
\n\n
\nparamter callback: Optional. Called when disconnected \n \n\n
\n
Declaration \n
\n
Swift
\n
public func disconnect ( code : CloseCode = CloseCode . normal , \n callback : (() -> Void )? = nil ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n code \n \n \n \n \n
Optional. Closing status code
\n
\n \n \n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Register Socket State Callbacks
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection open events. Does not handle retain\ncycles. Use delegateOnOpen(to:) for automatic handling of retain cycles.
\n\n
Example:
\n
socket . onOpen () { [ weak self ] in \n self ? . print ( \"Socket Connection Open\" ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func onOpen ( callback : @escaping () -> Void ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket is opened
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection open events. Automatically handles\nretain cycles. Use onOpen() to handle yourself.
\n\n
Example:
\n
socket . delegateOnOpen ( to : self ) { self in \n self . print ( \"Socket Connection Open\" ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func delegateOnOpen < T : AnyObject > ( to owner : T , \n callback : @escaping (( T ) -> Void )) \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket is opened
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection close events. Does not handle retain\ncycles. Use delegateOnClose(_:) for automatic handling of retain cycles.
\n\n
Example:
\n
socket . onClose () { [ weak self ] in \n self ? . print ( \"Socket Connection Close\" ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func onClose ( callback : @escaping () -> Void ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket is closed
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection close events. Automatically handles\nretain cycles. Use onClose() to handle yourself.
\n\n
Example:
\n
socket . delegateOnClose ( self ) { self in \n self . print ( \"Socket Connection Close\" ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func delegateOnClose < T : AnyObject > ( to owner : T , \n callback : @escaping (( T ) -> Void )) \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket is closed
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection error events. Does not handle retain\ncycles. Use delegateOnError(to:) for automatic handling of retain cycles.
\n\n
Example:
\n
socket . onError () { [ weak self ] ( error ) in \n self ? . print ( \"Socket Connection Error\" , error ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func onError ( callback : @escaping ( Error ) -> Void ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket errors
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection error events. Automatically handles\nretain cycles. Use manualOnError() to handle yourself.
\n\n
Example:
\n
socket . delegateOnError ( to : self ) { ( self , error ) in \n self . print ( \"Socket Connection Error\" , error ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func delegateOnError < T : AnyObject > ( to owner : T , \n callback : @escaping (( T , Error ) -> Void )) \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket errors
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection message events. Does not handle\nretain cycles. Use delegateOnMessage(_to:) for automatic handling of\nretain cycles.
\n\n
Example:
\n
socket . onMessage () { [ weak self ] ( message ) in \n self ? . print ( \"Socket Connection Message\" , message ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func onMessage ( callback : @escaping ( Message ) -> Void ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket receives a message event
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection message events. Automatically handles\nretain cycles. Use onMessage() to handle yourself.
\n\n
Example:
\n
socket . delegateOnMessage ( self ) { ( self , message ) in \n self . print ( \"Socket Connection Message\" , message ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func delegateOnMessage < T : AnyObject > ( to owner : T , \n callback : @escaping (( T , Message ) -> Void )) \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket receives a message event
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Releases all stored callback hooks (onError, onOpen, onClose, etc.) You should\ncall this method when you are finished when the Socket in order to release\nany references held by the socket.
\n\n
\n
Declaration \n
\n
Swift
\n
public func releaseCallbacks () \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Channel Initialization
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Initialize a new Channel
\n\n
Example:
\n
let channel = socket . channel ( \"rooms\" , params : [ \"user_id\" : \"abc123\" ]) \n\n\n
\nreturn: A new channel \n \n\n
\n
Declaration \n
\n
Swift
\n
public func channel ( _ topic : String , \n params : [ String : Any ] = [:]) -> Channel \n\n
\n
\n
Parameters \n
\n \n \n \n \n topic \n \n \n \n \n
Topic of the channel
\n
\n \n \n \n \n params \n \n \n \n \n
Optional. Parameters for the channel
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Removes the Channel from the socket. This does not cause the channel to\ninform the server that it is leaving. You should call channel.leave()\nprior to removing the Channel.
\n\n
Example:
\n
channel . leave () \nsocket . remove ( channel ) \n\n\n
\n
Declaration \n
\n
Swift
\n
public func remove ( _ channel : Channel ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n channel \n \n \n \n \n \n \n \n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: the next message ref, accounting for overflows \n \n\n
\n
Declaration \n
\n
Swift
\n
public func makeRef () -> String \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
WebSocketDelegate
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func websocketDidConnect ( socket : WebSocketClient ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func websocketDidDisconnect ( socket : WebSocketClient , error : Error ?) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func websocketDidReceiveMessage ( socket : WebSocketClient , text : String ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func websocketDidReceiveData ( socket : WebSocketClient , data : Data ) \n\n
\n
\n
\n \n
\n \n \n \n
Classes Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Classes \n The following classes are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public class Channel \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Data that is received from the Server.
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public class Message \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The Presence object provides features for syncing presence information from\nthe server with the client and handling presences joining and leaving.
\n
Syncing state from the server \n\n
To sync presence state from the server, first instantiate an object and pass\nyour channel in to track lifecycle events:
\n
let channel = socket . channel ( \"some:topic\" ) \nlet presence = Presence ( channel ) \n\n\n
If you have custom syncing state events, you can configure the Presence\nobject to use those instead.
\n
let options = Options ( events : [ . state : \"my_state\" , . diff : \"my_diff\" ]) \nlet presence = Presence ( channel , opts : options ) \n\n\n
Next, use the presence.onSync callback to react to state changes from the\nserver. For example, to render the list of users every time the list\nchanges, you could write:
\n
presence . onSync { renderUsers ( presence . list ()) } \n\n
Listing Presences \n\n
presence.list is used to return a list of presence information based on the\nlocal state of metadata. By default, all presence metadata is returned, but\na listBy function can be supplied to allow the client to select which\nmetadata to use for a given presence. For example, you may have a user\nonline from different devices with a metadata status of “online”, but they\nhave set themselves to “away” on another device. In this case, the app may\nchoose to use the “away” status for what appears on the UI. The example\nbelow defines a listBy function which prioritizes the first metadata which\nwas registered for each user. This could be the first tab they opened, or\nthe first device they came online from:
\n
let listBy : ( String , Presence . Map ) -> Presence . Meta = { id , pres in \n let first = pres [ \"metas\" ] !. first ! \n first [ \"count\" ] = pres [ \"metas\" ] !. count \n first [ \"id\" ] = id \n return first \n} \nlet onlineUsers = presence . list ( by : listBy ) \n\n\n
(NOTE: The underlying behavior is a map on the presence.state. You are\nmapping the state dictionary into whatever datastructure suites your needs)
\n
Handling individual presence join and leave events \n\n
The presence.onJoin and presence.onLeave callbacks can be used to react to\nindividual presences joining and leaving the app. For example:
\n
let presence = Presence ( channel ) \npresence . onJoin { [ weak self ] ( key , current , newPres ) in \n if let cur = current { \n print ( \"user additional presence\" , cur ) \n } else { \n print ( \"user entered for the first time\" , newPres ) \n } \n} \n\npresence . onLeave { [ weak self ] ( key , current , leftPres ) in \n if current [ \"metas\" ]? . isEmpty == true { \n print ( \"user has left from all devices\" , leftPres ) \n } else { \n print ( \"user left from a device\" , current ) \n } \n} \n\npresence . onSync { renderUsers ( presence . list ()) } \n\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public final class Presence \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public class Push \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Socket Connection \n\n
A single connection is established to the server and\nchannels are multiplexed over the connection.\nConnect to the server using the Socket class:
\n
let socket = new Socket ( \"/socket\" , paramsClosure : { [ \"userToken\" : \"123\" ] }) \nsocket . connect () \n\n\n
The Socket constructor takes the mount point of the socket,\nthe authentication params, as well as options that can be found in\nthe Socket docs, such as configuring the heartbeat.
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public class Socket \n
extension Socket : WebSocketDelegate \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
A collection of default values and behaviors used accross the Client
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public class Defaults \n\n
\n
\n
\n \n
\n \n \n \n
ChannelState Enumeration Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n ChannelState \n \n
\n
public enum ChannelState : String \n\n
\n
Represents the multiple states that a Channel can be in\nthroughout it’s lifecycle.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case closed = \"closed\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case errored = \"errored\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case joined = \"joined\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case joining = \"joining\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case leaving = \"leaving\" \n\n
\n
\n
\n \n
\n \n \n \n
Enumerations Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Enumerations \n The following enumerations are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Represents the multiple states that a Channel can be in\nthroughout it’s lifecycle.
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public enum ChannelState : String \n\n
\n
\n
\n \n
\n \n \n \n
Global Variables Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Global Variables \n The following global variables are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Default timeout when making a connection set to 10 seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public let PHOENIX_DEFAULT_TIMEOUT : Int \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public let PHOENIX_TIMEOUT_INTERVAL : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default heartbeat interval set to 30 seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public let PHOENIX_DEFAULT_HEARTBEAT : Int \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default heartbeat interval set to 30.0 seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public let PHOENIX_HEARTBEAT_INTERVAL : TimeInterval \n\n
\n
\n
\n \n
\n \n \n \n
Serializer Protocol Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Serializer \n \n
\n
public protocol Serializer \n\n
\n
Provides customization when enoding and decoding data within the Socket
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Convert a message into Data to be sent over the Socket
\n\n
\n
Declaration \n
\n
Swift
\n
func encode ( _ message : [ String : Any ]) throws -> Data \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Convert data from the Socket into a Message
\n\n
\n
Declaration \n
\n
Swift
\n
func decode ( _ data : Data ) -> Message ? \n\n
\n
\n
\n \n
\n \n \n \n
Protocols Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Protocols \n The following protocols are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Provides customization when enoding and decoding data within the Socket
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public protocol Serializer \n\n
\n
\n
\n \n
\n \n \n \n
ChannelEvent Structure Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n ChannelEvent \n \n
\n
public struct ChannelEvent \n\n
\n
Represents the different events that can be sent through\na channel regarding a Channel’s lifecycle.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let heartbeat : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let join : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let leave : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let reply : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let error : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let close : String \n\n
\n
\n
\n \n
\n \n \n \n
Delegated Structure Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Delegated \n \n
\n
public struct Delegated < Input , Output > \n\n
\n
Provides a memory-safe way of passing callbacks around while not creating\nretain cycles. This file was copied from https://github.com/dreymonde/Delegated \ninstead of added as a dependency to reduce the number of packages that\nship with SwiftPhoenixClient
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public init () \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func delegate < Target : AnyObject > ( to target : Target , \n with callback : @escaping ( Target , Input ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func call ( _ input : Input ) -> Output ? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public var isDelegateSet : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func stronglyDelegate < Target : AnyObject > ( to target : Target , \n with callback : @escaping ( Target , Input ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func manuallyDelegate ( with callback : @escaping ( Input ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func removeDelegate () \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Available where Input == Void
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func delegate < Target : AnyObject > ( to target : Target , \n with callback : @escaping ( Target ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func stronglyDelegate < Target : AnyObject > ( to target : Target , \n with callback : @escaping ( Target ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func call () -> Output ? \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Available where Output == Void
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func call ( _ input : Input ) \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Available where Input == Void, Output == Void
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func call () \n\n
\n
\n
\n \n
\n \n \n \n
Structures Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Structures \n The following structures are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Represents the different events that can be sent through\na channel regarding a Channel’s lifecycle.
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public struct ChannelEvent \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Provides a memory-safe way of passing callbacks around while not creating\nretain cycles. This file was copied from https://github.com/dreymonde/Delegated \ninstead of added as a dependency to reduce the number of packages that\nship with SwiftPhoenixClient
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public struct Delegated < Input , Output > \n\n
\n
\n
\n \n
\n \n \n \n
Type Aliases Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Type Aliases \n The following type aliases are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Alias for a JSON dictionary [String: Any]
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias Payload = [ String : Any ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Alias for a function returning an optional JSON dictionary (Payload?)
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias PayloadClosure = () -> Payload ? \n\n
\n
\n
\n \n
\n \n \n \n
\n \n CFBundleIdentifier \n com.jazzy.swiftphoenixclient \n CFBundleName \n SwiftPhoenixClient \n DocSetPlatformFamily \n swiftphoenixclient \n isDashDocset \n dashIndexFilePath \n index.html \n isJavaScriptEnabled \n DashDocSetFamily \n dashtoc \n \n \n"
},
{
"path": "docs/docsets/SwiftPhoenixClient.docset/Contents/Resources/Documents/Classes/Channel.html",
"content": "\n\n \n Channel Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Channel \n \n
\n
public class Channel \n\n
\n
Undocumented
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
The topic of the Channel. e.g. “rooms:friends”
\n\n
\n
Declaration \n
\n
Swift
\n
public let topic : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The params sent when joining the channel
\n\n
\n
Declaration \n
\n
Swift
\n
public var params : Payload { get set } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Overridable message hook. Receives all events for specialized message\nhandling before dispatching to the channel callbacks.
\n\n
\nreturn: Must return the message, modified or unmodified \n \n\n
\n
Parameters \n
\n \n \n \n \n msg \n \n \n \n \n
The Message received by the client from the server
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Joins the channel
\n\n
\n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func join ( timeout : TimeInterval ? = nil ) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n timeout \n \n \n \n \n
Optional. Defaults to Channel’s timeout
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Hook into when the Channel is closed. Does not handle retain cycles.\nUse delegateOnClose(to:) for automatic handling of retain cycles.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nchannel . onClose () { [ weak self ] message in \n self ? . print ( \"Channel \\( message . topic ) has closed\" \n} \n\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func onClose ( _ callback : @escaping (( Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Channel closes
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Hook into when the Channel is closed. Automatically handles retain\ncycles. Use onClose() to handle yourself.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nchannel . delegateOnClose ( to : self ) { ( self , message ) in \n self . print ( \"Channel \\( message . topic ) has closed\" \n} \n\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func delegateOnClose < Target : AnyObject > ( to owner : Target , \n callback : @escaping (( Target , Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Channel closes
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Hook into when the Channel receives an Error. Does not handle retain\ncycles. Use delegateOnError(to:) for automatic handling of retain\ncycles.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nchannel . onError () { [ weak self ] ( message ) in \n self ? . print ( \"Channel \\( message . topic ) has errored\" \n} \n\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func onError ( _ callback : @escaping (( _ message : Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Channel closes
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Hook into when the Channel receives an Error. Automatically handles\nretain cycles. Use onError() to handle yourself.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nchannel . delegateOnError ( to : self ) { ( self , message ) in \n self . print ( \"Channel \\( message . topic ) has closed\" \n} \n\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func delegateOnError < Target : AnyObject > ( to owner : Target , \n callback : @escaping (( Target , Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Channel closes
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Subscribes on channel events. Does not handle retain cycles. Use\ndelegateOn(_:, to:) for automatic handling of retain cycles.
\n\n
Subscription returns a ref counter, which can be used later to\nunsubscribe the exact event listener
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nlet ref1 = channel . on ( \"event\" ) { [ weak self ] ( message ) in \n self ? . print ( \"do stuff\" ) \n} \nlet ref2 = channel . on ( \"event\" ) { [ weak self ] ( message ) in \n self ? . print ( \"do other stuff\" ) \n} \nchannel . off ( \"event\" , ref1 ) \n\n\n
Since unsubscription of ref1, “do stuff” won’t print, but “do other\nstuff” will keep on printing on the “event”
\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func on ( _ event : String , callback : @escaping (( Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n \n \n \n \n \n callback \n \n \n \n \n
Called with the event’s message
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Subscribes on channel events. Automatically handles retain cycles. Use\non() to handle yourself.
\n\n
Subscription returns a ref counter, which can be used later to\nunsubscribe the exact event listener
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nlet ref1 = channel . delegateOn ( \"event\" , to : self ) { ( self , message ) in \n self ? . print ( \"do stuff\" ) \n} \nlet ref2 = channel . delegateOn ( \"event\" , to : self ) { ( self , message ) in \n self ? . print ( \"do other stuff\" ) \n} \nchannel . off ( \"event\" , ref1 ) \n\n\n
Since unsubscription of ref1, “do stuff” won’t print, but “do other\nstuff” will keep on printing on the “event”
\n\n
\nreturn: Ref counter of the subscription. See func off() \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func delegateOn < Target : AnyObject > ( _ event : String , \n to owner : Target , \n callback : @escaping (( Target , Message ) -> Void )) -> Int \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n \n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called with the event’s message
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Unsubscribes from a channel event. If a ref is given, only the exact\nlistener will be removed. Else all listeners for the event will be\nremoved.
\n\n
Example:
\n
let channel = socket . channel ( \"topic\" ) \nlet ref1 = channel . on ( \"event\" ) { _ in print ( \"ref1 event\" } \nlet ref2 = channel . on ( \"event\" ) { _ in print ( \"ref2 event\" } \nlet ref3 = channel . on ( \"other_event\" ) { _ in print ( \"ref3 other\" } \nlet ref4 = channel . on ( \"other_event\" ) { _ in print ( \"ref4 other\" } \nchannel . off ( \"event\" , ref1 ) \nchannel . off ( \"other_event\" ) \n\n\n
After this, only “ref2 event” will be printed if the channel receives\n“event” and nothing is printed if the channel receives “other_event”.
\n\n
\nparamter ref: Ref counter returned when subscribing. Can be omitted \n \n\n
\n
Declaration \n
\n
Swift
\n
public func off ( _ event : String , ref : Int ? = nil ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n
Event to unsubscribe from
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Push a payload to the Channel
\n\n
Example:
\n
channel \n . push ( \"event\" , payload : [ \"message\" : \"hello\" ) \n . receive ( \"ok\" ) { _ in { print ( \"message sent\" ) } \n\n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func push ( _ event : String , \n payload : Payload , \n timeout : TimeInterval = Defaults . timeoutInterval ) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n \n \n \n \n \n payload \n \n \n \n \n \n \n \n \n \n timeout \n \n \n \n \n \n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Leaves the channel
\n\n
Unsubscribes from server events, and instructs channel to terminate on\n server
\n\n
Triggers onClose() hooks
\n\n
To receive leave acknowledgements, use the a receive\n hook to bind to the server ack, ie:
\n\n
Example:\n/\n channel.leave().receive(“ok”) { _ in { print(“left”) }
\n\n
\nreturn: Push that can add receive hooks \n \n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func leave ( timeout : TimeInterval = Defaults . timeoutInterval ) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n timeout \n \n \n \n \n \n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Overridable message hook. Receives all events for specialized message\nhandling before dispatching to the channel callbacks.
\n\n
\nreturn: Must return the payload, modified or unmodified \n \n\n
\n
Declaration \n
\n
Swift
\n
public func onMessage ( callback : @escaping ( Message ) -> Message ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n event \n \n \n \n \n
The event the message was for
\n
\n \n \n \n \n payload \n \n \n \n \n
The payload for the message
\n
\n \n \n \n \n ref \n \n \n \n \n
The reference of the message
\n
\n \n \n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the Channel has been closed \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isClosed : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the Channel experienced an error \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isErrored : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the channel has joined \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isJoined : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the channel has requested to join \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isJoining : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the channel has requested to leave \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isLeaving : Bool { get } \n\n
\n
\n
\n \n
\n \n \n \n
Defaults Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Defaults \n \n
\n
public class Defaults \n\n
\n
A collection of default values and behaviors used accross the Client
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Default timeout when sending messages
\n\n
\n
Declaration \n
\n
Swift
\n
public static let timeoutInterval : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default interval to send heartbeats on
\n\n
\n
Declaration \n
\n
Swift
\n
public static let heartbeatInterval : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default reconnect algorithm for the socket
\n\n
\n
Declaration \n
\n
Swift
\n
public static let reconnectSteppedBackOff : ( Int ) -> TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default rejoin algorithm for individual channels
\n\n
\n
Declaration \n
\n
Swift
\n
public static let rejoinSteppedBackOff : ( Int ) -> TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default encode function, utilizing JSONSerialization.data
\n\n
\n
Declaration \n
\n
Swift
\n
public static let encode : ([ String : Any ]) -> Data \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default decode function, utilizing JSONSerialization.jsonObject
\n\n
\n
Declaration \n
\n
Swift
\n
public static let decode : ( Data ) -> [ String : Any ]? \n\n
\n
\n
\n \n
\n \n \n \n
Message Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Message \n \n
\n
public class Message \n\n
\n
Data that is received from the Server.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Reference number. Empty if missing
\n\n
\n
Declaration \n
\n
Swift
\n
public let ref : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public let topic : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public let event : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public var payload : Payload \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Convenience accessor. Equivalent to getting the status as such:
\n
message . payload [ \"status\" ] \n\n\n
\n
Declaration \n
\n
Swift
\n
public var status : String ? { get } \n\n
\n
\n
\n \n
\n \n \n \n
Events Enumeration Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Events \n \n
\n
public enum Events : String \n\n
\n
Presense Events
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case state = \"state\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case diff = \"diff\" \n\n
\n
\n
\n \n
\n \n \n \n
Options Structure Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Options \n \n
\n
public struct Options \n\n
\n
Custom options that can be provided when creating Presence
\nExample: \nlet options = Options ( events : [ . state : \"my_state\" , . diff : \"my_diff\" ]) \nlet presence = Presence ( channel , opts : options ) \n \n \n \n
\n \n \n \n
\n
\n
\n \n
Default set of Options used when creating Presence. Uses the\nphoenix events “presence_state” and “presence_diff”
\n\n
\n
Declaration \n
\n
Swift
\n
public static let defaults : Presence . Options \n\n
\n
\n
\n \n
\n \n \n \n
Presence Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Presence \n \n
\n
public final class Presence \n\n
\n
The Presence object provides features for syncing presence information from\nthe server with the client and handling presences joining and leaving.
\nSyncing state from the server \n\nTo sync presence state from the server, first instantiate an object and pass\nyour channel in to track lifecycle events:
\nlet channel = socket . channel ( \"some:topic\" ) \nlet presence = Presence ( channel ) \nIf you have custom syncing state events, you can configure the Presence\nobject to use those instead.
\nlet options = Options ( events : [ . state : \"my_state\" , . diff : \"my_diff\" ]) \nlet presence = Presence ( channel , opts : options ) \nNext, use the presence.onSync callback to react to state changes from the\nserver. For example, to render the list of users every time the list\nchanges, you could write:
\npresence . onSync { renderUsers ( presence . list ()) } \nListing Presences \n\npresence.list is used to return a list of presence information based on the\nlocal state of metadata. By default, all presence metadata is returned, but\na listBy function can be supplied to allow the client to select which\nmetadata to use for a given presence. For example, you may have a user\nonline from different devices with a metadata status of “online”, but they\nhave set themselves to “away” on another device. In this case, the app may\nchoose to use the “away” status for what appears on the UI. The example\nbelow defines a listBy function which prioritizes the first metadata which\nwas registered for each user. This could be the first tab they opened, or\nthe first device they came online from:
\nlet listBy : ( String , Presence . Map ) -> Presence . Meta = { id , pres in \n let first = pres [ \"metas\" ] !. first ! \n first [ \"count\" ] = pres [ \"metas\" ] !. count \n first [ \"id\" ] = id \n return first \n} \nlet onlineUsers = presence . list ( by : listBy ) \n(NOTE: The underlying behavior is a map on the presence.state. You are\nmapping the state dictionary into whatever datastructure suites your needs)
\nHandling individual presence join and leave events \n\nThe presence.onJoin and presence.onLeave callbacks can be used to react to\nindividual presences joining and leaving the app. For example:
\nlet presence = Presence ( channel ) \npresence . onJoin { [ weak self ] ( key , current , newPres ) in \n if let cur = current { \n print ( \"user additional presence\" , cur ) \n } else { \n print ( \"user entered for the first time\" , newPres ) \n } \n} \n\npresence . onLeave { [ weak self ] ( key , current , leftPres ) in \n if current [ \"metas\" ]? . isEmpty == true { \n print ( \"user has left from all devices\" , leftPres ) \n } else { \n print ( \"user left from a device\" , current ) \n } \n} \n\npresence . onSync { renderUsers ( presence . list ()) } \n \n \n \n
\n
\n
\n
\n
\n
Enums and Structs
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Custom options that can be provided when creating Presence
\n
Example: \n
let options = Options ( events : [ . state : \"my_state\" , . diff : \"my_diff\" ]) \nlet presence = Presence ( channel , opts : options ) \n\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public struct Options \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public enum Events : String \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Meta details of a Presence. Just a dictionary of properties
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias Meta = [ String : Any ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
A mapping of a String to an array of Metas. e.g. {“metas”: [{id: 1}]}
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias Map = [ String : [ Meta ]] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
A mapping of a Presence state to a mapping of Metas
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias State = [ String : Map ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public typealias Diff = [ String : State ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Closure signature of OnJoin callbacks
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias OnJoin = ( _ key : String , _ current : Map ?, _ new : Map ) -> Void \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Closure signature for OnLeave callbacks
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias OnLeave = ( _ key : String , _ current : Map , _ left : Map ) -> Void \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
/ Closure signature for OnSync callbacks
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias OnSync = () -> Void \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
The state of the Presence
\n\n
\n
Declaration \n
\n
Swift
\n
private(set) public var state : State \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Pending join and leave diffs that need to be synced
\n\n
\n
Declaration \n
\n
Swift
\n
private(set) public var pendingDiffs : [ Diff ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The channel’s joinRef, set when state events occur
\n\n
\n
Declaration \n
\n
Swift
\n
private(set) public var joinRef : String ? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public var isPendingSyncState : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Callback to be informed of joins
\n\n
\n
Declaration \n
\n
Swift
\n
public var onJoin : OnJoin { get set } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Set the OnJoin callback
\n\n
\n
Declaration \n
\n
Swift
\n
public func onJoin ( _ callback : @escaping OnJoin ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Callback to be informed of leaves
\n\n
\n
Declaration \n
\n
Swift
\n
public var onLeave : OnLeave { get set } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Set the OnLeave callback
\n\n
\n
Declaration \n
\n
Swift
\n
public func onLeave ( _ callback : @escaping OnLeave ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Callback to be informed of synces
\n\n
\n
Declaration \n
\n
Swift
\n
public var onSync : OnSync { get set } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Set the OnSync callback
\n\n
\n
Declaration \n
\n
Swift
\n
public func onSync ( _ callback : @escaping OnSync ) \n\n
\n
\n
\n \n \n \n \n \n \n \n
\n
\n
\n \n
Returns the array of presences, with deault selected metadata.
\n\n
\n
Declaration \n
\n
Swift
\n
public func list () -> [ Map ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Returns the array of presences, with selected metadata
\n\n
\n
Declaration \n
\n
Swift
\n
public func list < T > ( by transformer : ( String , Map ) -> T ) -> [ T ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Filter the Presence state with a given function
\n\n
\n
Declaration \n
\n
Swift
\n
public func filter ( by filter : (( String , Map ) -> Bool )?) -> State \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
@discardableResult \npublic static func syncState ( _ currentState : State , \n newState : State , \n onJoin : OnJoin = { _ , _ , _ in }, \n onLeave : OnLeave = { _ , _ , _ in }) -> State \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
@discardableResult \npublic static func syncDiff ( _ currentState : State , \n diff : Diff , \n onJoin : OnJoin = { _ , _ , _ in }, \n onLeave : OnLeave = { _ , _ , _ in }) -> State \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static func filter ( _ presences : State , \n by filter : (( String , Map ) -> Bool )?) -> State \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static func listBy < T > ( _ presences : State , \n transformer : ( String , Map ) -> T ) -> [ T ] \n\n
\n
\n
\n \n
\n \n \n \n
Push Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Push \n \n Represnts pushing data to a Channel Socket
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
The channel sending the Push
\n\n
\n
Declaration \n
\n
Swift
\n
public weak var channel : Channel ? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The event, for example phx_join
\n\n
\n
Declaration \n
\n
Swift
\n
public let event : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The payload, for example [“user_id”: “abc123”]
\n\n
\n
Declaration \n
\n
Swift
\n
public var payload : Payload \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The push timeout. Default is 10.0 seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public var timeout : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Resets and sends the Push
\n\n
\n
Declaration \n
\n
Swift
\n
public func resend ( _ timeout : TimeInterval = Defaults . timeoutInterval ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n timeout \n \n \n \n \n
Optional. The push timeout. Default is 10.0s
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Sends the Push. If it has already timed out, then the call will\nbe ignored and return early. Use resend in this case.
\n\n
\n
Declaration \n
\n
Swift
\n
public func send () \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Receive a specific event when sending an Outbound message. Subscribing\nto status events with this method does not guarantees no retain cycles.\nYou should pass weak self in the capture list of the callback. You\ncan call `.delegateReceive(status:, to:, callback:) and the library will\nhandle it for you.
\n\n
Example:
\n
channel \n . send ( event : \"custom\" , payload : [ \"body\" : \"example\" ]) \n . receive ( \"error\" ) { [ weak self ] payload in \n print ( \"Error: \" , payload ) \n } \n\n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func receive ( _ status : String , \n callback : @escaping (( Message ) -> ())) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n status \n \n \n \n \n \n \n \n \n \n callback \n \n \n \n \n
Callback to fire when the status is recevied
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Receive a specific event when sending an Outbound message. Automatically\nprevents retain cycles. See manualReceive(status:, callback:) if you\nwant to handle this yourself.
\n\n
Example:
\n
channel \n . send ( event : \"custom\" , payload : [ \"body\" : \"example\" ]) \n . delegateReceive ( \"error\" , to : self ) { payload in \n print ( \"Error: \" , payload ) \n } \n\n\n
\n
Declaration \n
\n
Swift
\n
@discardableResult \npublic func delegateReceive < Target : AnyObject > ( _ status : String , \n to owner : Target , \n callback : @escaping (( Target , Message ) -> ())) -> Push \n\n
\n
\n
Parameters \n
\n \n \n \n \n status \n \n \n \n \n \n \n \n \n \n owner \n \n \n \n \n
The class that is calling .receive. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Callback to fire when the status is recevied
\n
\n \n \n
\n
\n
\n \n
\n \n \n \n
Socket Class Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Socket \n \n
\n
public class Socket \n
extension Socket : WebSocketDelegate \n\n
\n
Socket Connection \n\nA single connection is established to the server and\nchannels are multiplexed over the connection.\nConnect to the server using the Socket class:
\nlet socket = new Socket ( \"/socket\" , paramsClosure : { [ \"userToken\" : \"123\" ] }) \nsocket . connect () \nThe Socket constructor takes the mount point of the socket,\nthe authentication params, as well as options that can be found in\nthe Socket docs, such as configuring the heartbeat.
\n\n \n \n \n
\n
\n
\n
\n
\n
Public Attributes
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The string WebSocket endpoint (ie "ws://example.com/socket",\n"wss://example.com", etc.) That was passed to the Socket during\ninitialization. The URL endpoint will be modified by the Socket to\ninclude "/websocket" if missing.
\n\n
\n
Declaration \n
\n
Swift
\n
public let endPoint : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The fully qualified socket URL
\n\n
\n
Declaration \n
\n
Swift
\n
public private(set) var endPointUrl : URL \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Resolves to return the paramsClosure Socket was created with static params, then those will be\nreturned every time.
\n\n
\n
Declaration \n
\n
Swift
\n
public var params : Payload ? { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The optional params closure used to get params whhen connecting. Must\nbe set when initializaing the Socket.
\n\n
\n
\n \n \n \n
\n
\n
\n \n
Override to provide custom encoding of data before writing to the socket
\n\n
\n
Declaration \n
\n
Swift
\n
public var encode : ([ String : Any ]) -> Data \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Override to provide customd decoding of data read from the socket
\n\n
\n
Declaration \n
\n
Swift
\n
public var decode : ( Data ) -> [ String : Any ]? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Timeout to use when opening connections
\n\n
\n
Declaration \n
\n
Swift
\n
public var timeout : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Interval between sending a heartbeat
\n\n
\n
Declaration \n
\n
Swift
\n
public var heartbeatInterval : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Interval between socket reconnect attempts, in seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public var reconnectAfter : ( Int ) -> TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Interval between channel rejoin attempts, in seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public var rejoinAfter : ( Int ) -> TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The optional function to receive logs
\n\n
\n
Declaration \n
\n
Swift
\n
public var logger : (( String ) -> Void )? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Disables heartbeats from being sent. Default is false.
\n\n
\n
Declaration \n
\n
Swift
\n
public var skipHeartbeat : Bool \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Enable/Disable SSL certificate validation. Default is false. This\nmust be set before calling socket.connect() in order to be applied
\n\n
\n
Declaration \n
\n
Swift
\n
public var disableSSLCertValidation : Bool \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Configure custom SSL validation logic, eg. SSL pinning. This\nmust be set before calling socket.connect() in order to apply.
\n\n
\n
Declaration \n
\n
Swift
\n
public var security : SSLTrustValidator ? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Configure the encryption used by your client by setting the\nallowed cipher suites supported by your server. This must be\nset before calling socket.connect() in order to apply.
\n\n
\n
Declaration \n
\n
Swift
\n
public var enabledSSLCipherSuites : [ SSLCipherSuite ]? \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public convenience init ( _ endPoint : String , \n params : Payload ? = nil ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public convenience init ( _ endPoint : String , \n paramsClosure : PayloadClosure ?) \n\n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: The socket protocol, wss or ws \n \n\n
\n
Declaration \n
\n
Swift
\n
public var websocketProtocol : String { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: True if the socket is connected \n \n\n
\n
Declaration \n
\n
Swift
\n
public var isConnected : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Connects the Socket. The params passed to the Socket on initialization\nwill be sent through the connection. If the Socket is already connected,\nthen this call will be ignored.
\n\n
\n
Declaration \n
\n
Swift
\n
public func connect () \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Disconnects the socket
\n\n
\nparamter callback: Optional. Called when disconnected \n \n\n
\n
Declaration \n
\n
Swift
\n
public func disconnect ( code : CloseCode = CloseCode . normal , \n callback : (() -> Void )? = nil ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n code \n \n \n \n \n
Optional. Closing status code
\n
\n \n \n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Register Socket State Callbacks
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection open events. Does not handle retain\ncycles. Use delegateOnOpen(to:) for automatic handling of retain cycles.
\n\n
Example:
\n
socket . onOpen () { [ weak self ] in \n self ? . print ( \"Socket Connection Open\" ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func onOpen ( callback : @escaping () -> Void ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket is opened
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection open events. Automatically handles\nretain cycles. Use onOpen() to handle yourself.
\n\n
Example:
\n
socket . delegateOnOpen ( to : self ) { self in \n self . print ( \"Socket Connection Open\" ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func delegateOnOpen < T : AnyObject > ( to owner : T , \n callback : @escaping (( T ) -> Void )) \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket is opened
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection close events. Does not handle retain\ncycles. Use delegateOnClose(_:) for automatic handling of retain cycles.
\n\n
Example:
\n
socket . onClose () { [ weak self ] in \n self ? . print ( \"Socket Connection Close\" ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func onClose ( callback : @escaping () -> Void ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket is closed
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection close events. Automatically handles\nretain cycles. Use onClose() to handle yourself.
\n\n
Example:
\n
socket . delegateOnClose ( self ) { self in \n self . print ( \"Socket Connection Close\" ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func delegateOnClose < T : AnyObject > ( to owner : T , \n callback : @escaping (( T ) -> Void )) \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket is closed
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection error events. Does not handle retain\ncycles. Use delegateOnError(to:) for automatic handling of retain cycles.
\n\n
Example:
\n
socket . onError () { [ weak self ] ( error ) in \n self ? . print ( \"Socket Connection Error\" , error ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func onError ( callback : @escaping ( Error ) -> Void ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket errors
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection error events. Automatically handles\nretain cycles. Use manualOnError() to handle yourself.
\n\n
Example:
\n
socket . delegateOnError ( to : self ) { ( self , error ) in \n self . print ( \"Socket Connection Error\" , error ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func delegateOnError < T : AnyObject > ( to owner : T , \n callback : @escaping (( T , Error ) -> Void )) \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket errors
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection message events. Does not handle\nretain cycles. Use delegateOnMessage(_to:) for automatic handling of\nretain cycles.
\n\n
Example:
\n
socket . onMessage () { [ weak self ] ( message ) in \n self ? . print ( \"Socket Connection Message\" , message ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func onMessage ( callback : @escaping ( Message ) -> Void ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket receives a message event
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Registers callbacks for connection message events. Automatically handles\nretain cycles. Use onMessage() to handle yourself.
\n\n
Example:
\n
socket . delegateOnMessage ( self ) { ( self , message ) in \n self . print ( \"Socket Connection Message\" , message ) \n} \n\n\n
\n
Declaration \n
\n
Swift
\n
public func delegateOnMessage < T : AnyObject > ( to owner : T , \n callback : @escaping (( T , Message ) -> Void )) \n\n
\n
\n
Parameters \n
\n \n \n \n \n owner \n \n \n \n \n
Class registering the callback. Usually self
\n
\n \n \n \n \n callback \n \n \n \n \n
Called when the Socket receives a message event
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Releases all stored callback hooks (onError, onOpen, onClose, etc.) You should\ncall this method when you are finished when the Socket in order to release\nany references held by the socket.
\n\n
\n
Declaration \n
\n
Swift
\n
public func releaseCallbacks () \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Channel Initialization
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Initialize a new Channel
\n\n
Example:
\n
let channel = socket . channel ( \"rooms\" , params : [ \"user_id\" : \"abc123\" ]) \n\n\n
\nreturn: A new channel \n \n\n
\n
Declaration \n
\n
Swift
\n
public func channel ( _ topic : String , \n params : [ String : Any ] = [:]) -> Channel \n\n
\n
\n
Parameters \n
\n \n \n \n \n topic \n \n \n \n \n
Topic of the channel
\n
\n \n \n \n \n params \n \n \n \n \n
Optional. Parameters for the channel
\n
\n \n \n
\n
\n
\n \n \n \n
\n
\n
\n \n
Removes the Channel from the socket. This does not cause the channel to\ninform the server that it is leaving. You should call channel.leave()\nprior to removing the Channel.
\n\n
Example:
\n
channel . leave () \nsocket . remove ( channel ) \n\n\n
\n
Declaration \n
\n
Swift
\n
public func remove ( _ channel : Channel ) \n\n
\n
\n
Parameters \n
\n \n \n \n \n channel \n \n \n \n \n \n \n \n
\n
\n
\n \n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
\nreturn: the next message ref, accounting for overflows \n \n\n
\n
Declaration \n
\n
Swift
\n
public func makeRef () -> String \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
WebSocketDelegate
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func websocketDidConnect ( socket : WebSocketClient ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func websocketDidDisconnect ( socket : WebSocketClient , error : Error ?) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func websocketDidReceiveMessage ( socket : WebSocketClient , text : String ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func websocketDidReceiveData ( socket : WebSocketClient , data : Data ) \n\n
\n
\n
\n \n
\n \n \n \n
Classes Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Classes \n The following classes are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public class Channel \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Data that is received from the Server.
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public class Message \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
The Presence object provides features for syncing presence information from\nthe server with the client and handling presences joining and leaving.
\n
Syncing state from the server \n\n
To sync presence state from the server, first instantiate an object and pass\nyour channel in to track lifecycle events:
\n
let channel = socket . channel ( \"some:topic\" ) \nlet presence = Presence ( channel ) \n\n\n
If you have custom syncing state events, you can configure the Presence\nobject to use those instead.
\n
let options = Options ( events : [ . state : \"my_state\" , . diff : \"my_diff\" ]) \nlet presence = Presence ( channel , opts : options ) \n\n\n
Next, use the presence.onSync callback to react to state changes from the\nserver. For example, to render the list of users every time the list\nchanges, you could write:
\n
presence . onSync { renderUsers ( presence . list ()) } \n\n
Listing Presences \n\n
presence.list is used to return a list of presence information based on the\nlocal state of metadata. By default, all presence metadata is returned, but\na listBy function can be supplied to allow the client to select which\nmetadata to use for a given presence. For example, you may have a user\nonline from different devices with a metadata status of “online”, but they\nhave set themselves to “away” on another device. In this case, the app may\nchoose to use the “away” status for what appears on the UI. The example\nbelow defines a listBy function which prioritizes the first metadata which\nwas registered for each user. This could be the first tab they opened, or\nthe first device they came online from:
\n
let listBy : ( String , Presence . Map ) -> Presence . Meta = { id , pres in \n let first = pres [ \"metas\" ] !. first ! \n first [ \"count\" ] = pres [ \"metas\" ] !. count \n first [ \"id\" ] = id \n return first \n} \nlet onlineUsers = presence . list ( by : listBy ) \n\n\n
(NOTE: The underlying behavior is a map on the presence.state. You are\nmapping the state dictionary into whatever datastructure suites your needs)
\n
Handling individual presence join and leave events \n\n
The presence.onJoin and presence.onLeave callbacks can be used to react to\nindividual presences joining and leaving the app. For example:
\n
let presence = Presence ( channel ) \npresence . onJoin { [ weak self ] ( key , current , newPres ) in \n if let cur = current { \n print ( \"user additional presence\" , cur ) \n } else { \n print ( \"user entered for the first time\" , newPres ) \n } \n} \n\npresence . onLeave { [ weak self ] ( key , current , leftPres ) in \n if current [ \"metas\" ]? . isEmpty == true { \n print ( \"user has left from all devices\" , leftPres ) \n } else { \n print ( \"user left from a device\" , current ) \n } \n} \n\npresence . onSync { renderUsers ( presence . list ()) } \n\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public final class Presence \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public class Push \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Socket Connection \n\n
A single connection is established to the server and\nchannels are multiplexed over the connection.\nConnect to the server using the Socket class:
\n
let socket = new Socket ( \"/socket\" , paramsClosure : { [ \"userToken\" : \"123\" ] }) \nsocket . connect () \n\n\n
The Socket constructor takes the mount point of the socket,\nthe authentication params, as well as options that can be found in\nthe Socket docs, such as configuring the heartbeat.
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public class Socket \n
extension Socket : WebSocketDelegate \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
A collection of default values and behaviors used accross the Client
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public class Defaults \n\n
\n
\n
\n \n
\n \n \n \n
ChannelState Enumeration Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n ChannelState \n \n
\n
public enum ChannelState : String \n\n
\n
Represents the multiple states that a Channel can be in\nthroughout it’s lifecycle.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case closed = \"closed\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case errored = \"errored\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case joined = \"joined\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case joining = \"joining\" \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
case leaving = \"leaving\" \n\n
\n
\n
\n \n
\n \n \n \n
Enumerations Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Enumerations \n The following enumerations are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Represents the multiple states that a Channel can be in\nthroughout it’s lifecycle.
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public enum ChannelState : String \n\n
\n
\n
\n \n
\n \n \n \n
Global Variables Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Global Variables \n The following global variables are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Default timeout when making a connection set to 10 seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public let PHOENIX_DEFAULT_TIMEOUT : Int \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public let PHOENIX_TIMEOUT_INTERVAL : TimeInterval \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default heartbeat interval set to 30 seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public let PHOENIX_DEFAULT_HEARTBEAT : Int \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Default heartbeat interval set to 30.0 seconds
\n\n
\n
Declaration \n
\n
Swift
\n
public let PHOENIX_HEARTBEAT_INTERVAL : TimeInterval \n\n
\n
\n
\n \n
\n \n \n \n
Serializer Protocol Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Serializer \n \n
\n
public protocol Serializer \n\n
\n
Provides customization when enoding and decoding data within the Socket
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Convert a message into Data to be sent over the Socket
\n\n
\n
Declaration \n
\n
Swift
\n
func encode ( _ message : [ String : Any ]) throws -> Data \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Convert data from the Socket into a Message
\n\n
\n
Declaration \n
\n
Swift
\n
func decode ( _ data : Data ) -> Message ? \n\n
\n
\n
\n \n
\n \n \n \n
Protocols Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Protocols \n The following protocols are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Provides customization when enoding and decoding data within the Socket
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public protocol Serializer \n\n
\n
\n
\n \n
\n \n \n \n
ChannelEvent Structure Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n ChannelEvent \n \n
\n
public struct ChannelEvent \n\n
\n
Represents the different events that can be sent through\na channel regarding a Channel’s lifecycle.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let heartbeat : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let join : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let leave : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let reply : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let error : String \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public static let close : String \n\n
\n
\n
\n \n
\n \n \n \n
Delegated Structure Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Delegated \n \n
\n
public struct Delegated < Input , Output > \n\n
\n
Provides a memory-safe way of passing callbacks around while not creating\nretain cycles. This file was copied from https://github.com/dreymonde/Delegated \ninstead of added as a dependency to reduce the number of packages that\nship with SwiftPhoenixClient
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public init () \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func delegate < Target : AnyObject > ( to target : Target , \n with callback : @escaping ( Target , Input ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func call ( _ input : Input ) -> Output ? \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public var isDelegateSet : Bool { get } \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func stronglyDelegate < Target : AnyObject > ( to target : Target , \n with callback : @escaping ( Target , Input ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func manuallyDelegate ( with callback : @escaping ( Input ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func removeDelegate () \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Available where Input == Void
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func delegate < Target : AnyObject > ( to target : Target , \n with callback : @escaping ( Target ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public mutating func stronglyDelegate < Target : AnyObject > ( to target : Target , \n with callback : @escaping ( Target ) -> Output ) \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func call () -> Output ? \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Available where Output == Void
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func call ( _ input : Input ) \n\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
Available where Input == Void, Output == Void
\n\n
\n
\n
\n \n \n \n
\n
\n
\n \n \n
Declaration \n
\n
Swift
\n
public func call () \n\n
\n
\n
\n \n
\n \n \n \n
Structures Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Structures \n The following structures are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Represents the different events that can be sent through\na channel regarding a Channel’s lifecycle.
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public struct ChannelEvent \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Provides a memory-safe way of passing callbacks around while not creating\nretain cycles. This file was copied from https://github.com/dreymonde/Delegated \ninstead of added as a dependency to reduce the number of packages that\nship with SwiftPhoenixClient
\n\n
See more \n
\n
Declaration \n
\n
Swift
\n
public struct Delegated < Input , Output > \n\n
\n
\n
\n \n
\n \n \n \n
Type Aliases Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n Type Aliases \n The following type aliases are available globally.
\n\n \n \n \n
\n \n \n \n
\n
\n
\n \n
Alias for a JSON dictionary [String: Any]
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias Payload = [ String : Any ] \n\n
\n
\n
\n \n \n \n
\n
\n
\n \n
Alias for a function returning an optional JSON dictionary (Payload?)
\n\n
\n
Declaration \n
\n
Swift
\n
public typealias PayloadClosure = () -> Payload ? \n\n
\n
\n
\n \n
\n \n \n \n
SwiftPhoenixClient Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n \n Swift Phoenix Client \n\n
\nAbout \n\nSwift Phoenix Client is an extension of Starscream websocket client library\nthat makes it easy to connect to Phoenix sockets in a similar manner to the\nphoenix.js client.
\n\nThe client is currently updated to mirror phoenix.js 1.4.
\nSwift Versions \n\nmaster currently supports Swift 5.0. You’ll need to set your target to = 1.0.1 if your project is using Swift 4.2
\n\n\n\nswift \nclient \n \n \n\n4.2 \n1.0.1 \n \n\n5.0 \n1.1.0 \n \n
\nInstallation \nCocoaPods \n\nYou can install SwiftPhoenix Client via CocoaPods by adding the following to your\nPodfile. Keep in mind that in order to use Swift Phoenix Client, the minimum iOS\ntarget must be ‘9.0’
\nplatform :ios, '9.0'\nuse_frameworks!\n\npod \"SwiftPhoenixClient\", '~> 1.0'\nand running pod install. From there you will need to add import SwiftPhoenixClient in any class you want it to be used.
\nCarthage \n\nIf you use Carthage to manage your dependencies, simply add\nSwiftPhoenixClient to your Cartfile:
\ngithub \"davidstump/SwiftPhoenixClient\" ~> 1.0\nSwiftPackageManager \n\nSwiftPackageManager is properly supported starting in SwiftPhoenixClient v1.2.0. You can add the following to your Package.swift
\n.package(url: \"https://github.com/davidstump/SwiftPhoenixClient.git\", .upToNextMajor(from: \"1.2.0\"))\nMake sure you have added SwiftPhoenixClient.framework, and Starscream.framework to the “Linked Frameworks and Libraries ” section of your target, and have included them in your Carthage framework copying build phase.
\nUsage \n\nUsing the Swift Phoenix Client is extremely easy (and familiar if have used the phoenix.s client).
\n\nSee the Usage Guide for details instructions. You can also check out the documentation
\nExample \n\nCheck out the ViewController in this repo for a brief example of a simple iOS chat application using the Phoenix Chat Example
\n\nAlso check out both the Swift and Elixir channels on IRC.
\nDevelopment \n\nCheck out the wiki page for getting started
\n\nTested with the Phoenix Chat Server example , upgraded to Phoenix 1.2.
\nThanks \n\nMany many thanks to Daniel Rees for his many contributions and continued maintenance of this project!
\nLicense \n\nSwiftPhoenixClient is available under the MIT license. See the LICENSE file for more info.
\n\n \n \n \n \n
Alias for a JSON dictionary [String: Any]
\"},\"Typealiases.html#/s:18SwiftPhoenixClient14PayloadClosurea\":{\"name\":\"PayloadClosure\",\"abstract\":\"Alias for a function returning an optional JSON dictionary (Payload?)
\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVACyxq_Gycfc\":{\"name\":\"init()\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV8delegate2to4withyqd___q_qd___xtctRld__ClF\":{\"name\":\"delegate(to:with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV4callyq_SgxF\":{\"name\":\"call(_:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV13isDelegateSetSbvp\":{\"name\":\"isDelegateSet\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV16stronglyDelegate2to4withyqd___q_qd___xtctRld__ClF\":{\"name\":\"stronglyDelegate(to:with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV16manuallyDelegate4withyq_xc_tF\":{\"name\":\"manuallyDelegate(with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV14removeDelegateyyF\":{\"name\":\"removeDelegate()\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRszrlE8delegate2to4withyqd___q_qd__ctRld__ClF\":{\"name\":\"delegate(to:with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRszrlE16stronglyDelegate2to4withyqd___q_qd__ctRld__ClF\":{\"name\":\"stronglyDelegate(to:with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRszrlE4callq_SgyF\":{\"name\":\"call()\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRs_rlE4callyyxF\":{\"name\":\"call(_:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRszytRs_rlE4callyyF\":{\"name\":\"call()\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV9heartbeatSSvpZ\":{\"name\":\"heartbeat\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV4joinSSvpZ\":{\"name\":\"join\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV5leaveSSvpZ\":{\"name\":\"leave\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV5replySSvpZ\":{\"name\":\"reply\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV5errorSSvpZ\":{\"name\":\"error\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV5closeSSvpZ\":{\"name\":\"close\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html\":{\"name\":\"ChannelEvent\",\"abstract\":\"Represents the different events that can be sent through\"},\"Structs/Delegated.html\":{\"name\":\"Delegated\",\"abstract\":\"
Provides a memory-safe way of passing callbacks around while not creating\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO6closedyA2CmF\":{\"name\":\"closed\",\"abstract\":\"
Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO7erroredyA2CmF\":{\"name\":\"errored\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO6joinedyA2CmF\":{\"name\":\"joined\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO7joiningyA2CmF\":{\"name\":\"joining\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO7leavingyA2CmF\":{\"name\":\"leaving\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html\":{\"name\":\"ChannelState\",\"abstract\":\"Represents the multiple states that a Channel can be in\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC15timeoutIntervalSdvpZ\":{\"name\":\"timeoutInterval\",\"abstract\":\"
Default timeout when sending messages
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC17heartbeatIntervalSdvpZ\":{\"name\":\"heartbeatInterval\",\"abstract\":\"Default interval to send heartbeats on
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC23reconnectSteppedBackOffySdSicvpZ\":{\"name\":\"reconnectSteppedBackOff\",\"abstract\":\"Default reconnect algorithm for the socket
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC20rejoinSteppedBackOffySdSicvpZ\":{\"name\":\"rejoinSteppedBackOff\",\"abstract\":\"Default rejoin algorithm for individual channels
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC6encodey10Foundation4DataVSDySSypGcvpZ\":{\"name\":\"encode\",\"abstract\":\"Default encode function, utilizing JSONSerialization.data
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC6decodeySDySSypGSg10Foundation4DataVcvpZ\":{\"name\":\"decode\",\"abstract\":\"Default decode function, utilizing JSONSerialization.jsonObject
\",\"parent_name\":\"Defaults\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC8endPointSSvp\":{\"name\":\"endPoint\",\"abstract\":\"The string WebSocket endpoint (ie "ws://example.com/socket",\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC11endPointUrl10Foundation3URLVvp\":{\"name\":\"endPointUrl\",\"abstract\":\"
The fully qualified socket URL
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6paramsSDySSypGSgvp\":{\"name\":\"params\",\"abstract\":\"Resolves to return the paramsClosure
The optional params closure used to get params whhen connecting. Must\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6encodey10Foundation4DataVSDySSypGcvp\":{\"name\":\"encode\",\"abstract\":\"
Override to provide custom encoding of data before writing to the socket
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6decodeySDySSypGSg10Foundation4DataVcvp\":{\"name\":\"decode\",\"abstract\":\"Override to provide customd decoding of data read from the socket
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7timeoutSdvp\":{\"name\":\"timeout\",\"abstract\":\"Timeout to use when opening connections
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC17heartbeatIntervalSdvp\":{\"name\":\"heartbeatInterval\",\"abstract\":\"Interval between sending a heartbeat
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC14reconnectAfterySdSicvp\":{\"name\":\"reconnectAfter\",\"abstract\":\"Interval between socket reconnect attempts, in seconds
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC11rejoinAfterySdSicvp\":{\"name\":\"rejoinAfter\",\"abstract\":\"Interval between channel rejoin attempts, in seconds
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6loggerySScSgvp\":{\"name\":\"logger\",\"abstract\":\"The optional function to receive logs
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC13skipHeartbeatSbvp\":{\"name\":\"skipHeartbeat\",\"abstract\":\"Disables heartbeats from being sent. Default is false.
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC24disableSSLCertValidationSbvp\":{\"name\":\"disableSSLCertValidation\",\"abstract\":\"Enable/Disable SSL certificate validation. Default is false. This\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC8security10Starscream17SSLTrustValidator_pSgvp\":{\"name\":\"security\",\"abstract\":\"
Configure custom SSL validation logic, eg. SSL pinning. This\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC22enabledSSLCipherSuitesSays6UInt16VGSgvp\":{\"name\":\"enabledSSLCipherSuites\",\"abstract\":\"
Configure the encryption used by your client by setting the\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC_6paramsACSS_SDySSypGSgtcfc\":{\"name\":\"init(_:params:)\",\"abstract\":\"
Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC_13paramsClosureACSS_SDySSypGSgycSgtcfc\":{\"name\":\"init(_:paramsClosure:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC17websocketProtocolSSvp\":{\"name\":\"websocketProtocol\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC11isConnectedSbvp\":{\"name\":\"isConnected\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7connectyyF\":{\"name\":\"connect()\",\"abstract\":\"Connects the Socket. The params passed to the Socket on initialization\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC10disconnect4code8callbacky10Starscream9CloseCodeO_yycSgtF\":{\"name\":\"disconnect(code:callback:)\",\"abstract\":\"
Disconnects the socket
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6onOpen8callbackyyyc_tF\":{\"name\":\"onOpen(callback:)\",\"abstract\":\"Registers callbacks for connection open events. Does not handle retain\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC14delegateOnOpen2to8callbackyx_yxctRlzClF\":{\"name\":\"delegateOnOpen(to:callback:)\",\"abstract\":\"
Registers callbacks for connection open events. Automatically handles\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7onClose8callbackyyyc_tF\":{\"name\":\"onClose(callback:)\",\"abstract\":\"
Registers callbacks for connection close events. Does not handle retain\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC15delegateOnClose2to8callbackyx_yxctRlzClF\":{\"name\":\"delegateOnClose(to:callback:)\",\"abstract\":\"
Registers callbacks for connection close events. Automatically handles\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7onError8callbackyys0F0_pc_tF\":{\"name\":\"onError(callback:)\",\"abstract\":\"
Registers callbacks for connection error events. Does not handle retain\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC15delegateOnError2to8callbackyx_yx_s0G0_ptctRlzClF\":{\"name\":\"delegateOnError(to:callback:)\",\"abstract\":\"
Registers callbacks for connection error events. Automatically handles\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC9onMessage8callbackyyAA0F0Cc_tF\":{\"name\":\"onMessage(callback:)\",\"abstract\":\"
Registers callbacks for connection message events. Does not handle\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC17delegateOnMessage2to8callbackyx_yx_AA0G0CtctRlzClF\":{\"name\":\"delegateOnMessage(to:callback:)\",\"abstract\":\"
Registers callbacks for connection message events. Automatically handles\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC16releaseCallbacksyyF\":{\"name\":\"releaseCallbacks()\",\"abstract\":\"
Releases all stored callback hooks (onError, onOpen, onClose, etc.) You should\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7channel_6paramsAA7ChannelCSS_SDySSypGtF\":{\"name\":\"channel(_:params:)\",\"abstract\":\"
Initialize a new Channel
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6removeyyAA7ChannelCF\":{\"name\":\"remove(_:)\",\"abstract\":\"Removes the Channel from the socket. This does not cause the channel to\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7makeRefSSyF\":{\"name\":\"makeRef()\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC19websocketDidConnect6sockety10Starscream03WebdC0_p_tF\":{\"name\":\"websocketDidConnect(socket:)\",\"abstract\":\"
Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC22websocketDidDisconnect6socket5errory10Starscream03WebdC0_p_s5Error_pSgtF\":{\"name\":\"websocketDidDisconnect(socket:error:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC26websocketDidReceiveMessage6socket4texty10Starscream03WebdC0_p_SStF\":{\"name\":\"websocketDidReceiveMessage(socket:text:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC23websocketDidReceiveData6socket4datay10Starscream03WebdC0_p_10Foundation0H0VtF\":{\"name\":\"websocketDidReceiveData(socket:data:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC7channelAA7ChannelCSgvp\":{\"name\":\"channel\",\"abstract\":\"The channel sending the Push
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC5eventSSvp\":{\"name\":\"event\",\"abstract\":\"The event, for example phx_join
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC7payloadSDySSypGvp\":{\"name\":\"payload\",\"abstract\":\"The payload, for example [“user_id”: “abc123”]
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC7timeoutSdvp\":{\"name\":\"timeout\",\"abstract\":\"The push timeout. Default is 10.0 seconds
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC6resendyySdF\":{\"name\":\"resend(_:)\",\"abstract\":\"Resets and sends the Push
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC4sendyyF\":{\"name\":\"send()\",\"abstract\":\"Sends the Push. If it has already timed out, then the call will\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC7receive_8callbackACSS_yAA7MessageCctF\":{\"name\":\"receive(_:callback:)\",\"abstract\":\"
Receive a specific event when sending an Outbound message. Subscribing\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC15delegateReceive_2to8callbackACSS_xyx_AA7MessageCtctRlzClF\":{\"name\":\"delegateReceive(_:to:callback:)\",\"abstract\":\"
Receive a specific event when sending an Outbound message. Automatically\",\"parent_name\":\"Push\"},\"Classes/Presence/Events.html#/s:18SwiftPhoenixClient8PresenceC6EventsO5stateyA2EmF\":{\"name\":\"state\",\"abstract\":\"
Undocumented
\",\"parent_name\":\"Events\"},\"Classes/Presence/Events.html#/s:18SwiftPhoenixClient8PresenceC6EventsO4diffyA2EmF\":{\"name\":\"diff\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Events\"},\"Classes/Presence/Options.html#/s:18SwiftPhoenixClient8PresenceC7OptionsV8defaultsAEvpZ\":{\"name\":\"defaults\",\"abstract\":\"Default set of Options used when creating Presence. Uses the\",\"parent_name\":\"Options\"},\"Classes/Presence/Options.html\":{\"name\":\"Options\",\"abstract\":\"
Custom options that can be provided when creating Presence
\",\"parent_name\":\"Presence\"},\"Classes/Presence/Events.html\":{\"name\":\"Events\",\"abstract\":\"Presense Events
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC4Metaa\":{\"name\":\"Meta\",\"abstract\":\"Meta details of a Presence. Just a dictionary of properties
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC3Mapa\":{\"name\":\"Map\",\"abstract\":\"A mapping of a String to an array of Metas. e.g. {“metas”: [{id: 1}]}
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC5Statea\":{\"name\":\"State\",\"abstract\":\"A mapping of a Presence state to a mapping of Metas
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC4Diffa\":{\"name\":\"Diff\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6OnJoina\":{\"name\":\"OnJoin\",\"abstract\":\"Closure signature of OnJoin callbacks
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7OnLeavea\":{\"name\":\"OnLeave\",\"abstract\":\"Closure signature for OnLeave callbacks
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6OnSynca\":{\"name\":\"OnSync\",\"abstract\":\"/ Closure signature for OnSync callbacks
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC5stateSDySSSDySSSaySDySSypGGGGvp\":{\"name\":\"state\",\"abstract\":\"The state of the Presence
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC12pendingDiffsSaySDySSSDySSSDySSSaySDySSypGGGGGGvp\":{\"name\":\"pendingDiffs\",\"abstract\":\"Pending join and leave diffs that need to be synced
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7joinRefSSSgvp\":{\"name\":\"joinRef\",\"abstract\":\"The channel’s joinRef, set when state events occur
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC18isPendingSyncStateSbvp\":{\"name\":\"isPendingSyncState\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6onJoinyySS_SDySSSaySDySSypGGGSgAGtcvp\":{\"name\":\"onJoin\",\"abstract\":\"Callback to be informed of joins
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6onJoinyyySS_SDySSSaySDySSypGGGSgAGtcF\":{\"name\":\"onJoin(_:)\",\"abstract\":\"Set the OnJoin callback
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7onLeaveyySS_SDySSSaySDySSypGGGAGtcvp\":{\"name\":\"onLeave\",\"abstract\":\"Callback to be informed of leaves
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7onLeaveyyySS_SDySSSaySDySSypGGGAGtcF\":{\"name\":\"onLeave(_:)\",\"abstract\":\"Set the OnLeave callback
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6onSyncyycvp\":{\"name\":\"onSync\",\"abstract\":\"Callback to be informed of synces
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6onSyncyyyycF\":{\"name\":\"onSync(_:)\",\"abstract\":\"Set the OnSync callback
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7channel4optsAcA7ChannelC_AC7OptionsVtcfc\":{\"name\":\"init(channel:opts:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC4listSaySDySSSaySDySSypGGGGyF\":{\"name\":\"list()\",\"abstract\":\"Returns the array of presences, with deault selected metadata.
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC4list2bySayxGxSS_SDySSSaySDySSypGGGtXE_tlF\":{\"name\":\"list(by:)\",\"abstract\":\"Returns the array of presences, with selected metadata
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6filter2bySDySSSDySSSaySDySSypGGGGSbSS_AHtcSg_tF\":{\"name\":\"filter(by:)\",\"abstract\":\"Filter the Presence state with a given function
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC9syncState_03newF06onJoin0H5LeaveSDySSSDySSSaySDySSypGGGGAK_AKySS_AJSgAJtXEySS_A2JtXEtFZ\":{\"name\":\"syncState(_:newState:onJoin:onLeave:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC8syncDiff_4diff6onJoin0H5LeaveSDySSSDySSSaySDySSypGGGGAK_SDySSAKGySS_AJSgAJtXEySS_A2JtXEtFZ\":{\"name\":\"syncDiff(_:diff:onJoin:onLeave:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6filter_2bySDySSSDySSSaySDySSypGGGGAI_SbSS_AHtcSgtFZ\":{\"name\":\"filter(_:by:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6listBy_11transformerSayxGSDySSSDySSSaySDySSypGGGG_xSS_AItXEtlFZ\":{\"name\":\"listBy(_:transformer:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC3refSSvp\":{\"name\":\"ref\",\"abstract\":\"Reference number. Empty if missing
\",\"parent_name\":\"Message\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC5topicSSvp\":{\"name\":\"topic\",\"abstract\":\"Message topic
\",\"parent_name\":\"Message\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC5eventSSvp\":{\"name\":\"event\",\"abstract\":\"Message event
\",\"parent_name\":\"Message\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC7payloadSDySSypGvp\":{\"name\":\"payload\",\"abstract\":\"Message payload
\",\"parent_name\":\"Message\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC6statusSSSgvp\":{\"name\":\"status\",\"abstract\":\"Convenience accessor. Equivalent to getting the status as such:
\",\"parent_name\":\"Message\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC5topicSSvp\":{\"name\":\"topic\",\"abstract\":\"The topic of the Channel. e.g. “rooms:friends”
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC6paramsSDySSypGvp\":{\"name\":\"params\",\"abstract\":\"The params sent when joining the channel
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9onMessageyAA0F0CAFcvp\":{\"name\":\"onMessage\",\"abstract\":\"Overridable message hook. Receives all events for specialized message\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC4join7timeoutAA4PushCSdSg_tF\":{\"name\":\"join(timeout:)\",\"abstract\":\"
Joins the channel
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC7onCloseySiyAA7MessageCcF\":{\"name\":\"onClose(_:)\",\"abstract\":\"Hook into when the Channel is closed. Does not handle retain cycles.\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC15delegateOnClose2to8callbackSix_yx_AA7MessageCtctRlzClF\":{\"name\":\"delegateOnClose(to:callback:)\",\"abstract\":\"
Hook into when the Channel is closed. Automatically handles retain\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC7onErrorySiyAA7MessageCcF\":{\"name\":\"onError(_:)\",\"abstract\":\"
Hook into when the Channel receives an Error. Does not handle retain\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC15delegateOnError2to8callbackSix_yx_AA7MessageCtctRlzClF\":{\"name\":\"delegateOnError(to:callback:)\",\"abstract\":\"
Hook into when the Channel receives an Error. Automatically handles\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC2on_8callbackSiSS_yAA7MessageCctF\":{\"name\":\"on(_:callback:)\",\"abstract\":\"
Subscribes on channel events. Does not handle retain cycles. Use\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC10delegateOn_2to8callbackSiSS_xyx_AA7MessageCtctRlzClF\":{\"name\":\"delegateOn(_:to:callback:)\",\"abstract\":\"
Subscribes on channel events. Automatically handles retain cycles. Use\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC3off_3refySS_SiSgtF\":{\"name\":\"off(_:ref:)\",\"abstract\":\"
Unsubscribes from a channel event. If a ref is given, only the exact\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC4push_7payload7timeoutAA4PushCSS_SDySSypGSdtF\":{\"name\":\"push(_:payload:timeout:)\",\"abstract\":\"
Push a payload to the Channel
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC5leave7timeoutAA4PushCSd_tF\":{\"name\":\"leave(timeout:)\",\"abstract\":\"Leaves the channel
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9onMessage8callbackyAA0F0CAGc_tF\":{\"name\":\"onMessage(callback:)\",\"abstract\":\"Overridable message hook. Receives all events for specialized message\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC8isClosedSbvp\":{\"name\":\"isClosed\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9isErroredSbvp\":{\"name\":\"isErrored\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC8isJoinedSbvp\":{\"name\":\"isJoined\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9isJoiningSbvp\":{\"name\":\"isJoining\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9isLeavingSbvp\":{\"name\":\"isLeaving\",\"parent_name\":\"Channel\"},\"Classes/Channel.html\":{\"name\":\"Channel\",\"abstract\":\"
Undocumented
\"},\"Classes/Message.html\":{\"name\":\"Message\",\"abstract\":\"Data that is received from the Server.
\"},\"Classes/Presence.html\":{\"name\":\"Presence\",\"abstract\":\"The Presence object provides features for syncing presence information from\"},\"Classes/Push.html\":{\"name\":\"Push\",\"abstract\":\"
Represnts pushing data to a Channel Socket
\"},\"Classes/Socket.html\":{\"name\":\"Socket\",\"abstract\":\"Socket Connection \"},\"Classes/Defaults.html\":{\"name\":\"Defaults\",\"abstract\":\"A collection of default values and behaviors used accross the Client
\"},\"Classes.html\":{\"name\":\"Classes\",\"abstract\":\"The following classes are available globally.
\"},\"Enums.html\":{\"name\":\"Enumerations\",\"abstract\":\"The following enumerations are available globally.
\"},\"Structs.html\":{\"name\":\"Structures\",\"abstract\":\"The following structures are available globally.
\"},\"Typealiases.html\":{\"name\":\"Type Aliases\",\"abstract\":\"The following type aliases are available globally.
\"}}"
},
{
"path": "docs/docsets/SwiftPhoenixClient.docset/Contents/Resources/Documents/undocumented.json",
"content": "{\n \"warnings\": [\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 118,\n \"symbol\": \"Presence.Events.state\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 119,\n \"symbol\": \"Presence.Events.diff\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 136,\n \"symbol\": \"Presence.Diff\",\n \"symbol_kind\": \"source.lang.swift.decl.typealias\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 173,\n \"symbol\": \"Presence.isPendingSyncState\",\n \"symbol_kind\": \"source.lang.swift.decl.var.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 212,\n \"symbol\": \"Presence.init(channel:opts:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 285,\n \"symbol\": \"Presence.syncState(_:newState:onJoin:onLeave:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 340,\n \"symbol\": \"Presence.syncDiff(_:diff:onJoin:onLeave:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 380,\n \"symbol\": \"Presence.filter(_:by:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Presence.swift\",\n \"line\": 386,\n \"symbol\": \"Presence.listBy(_:transformer:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Socket.swift\",\n \"line\": 143,\n \"symbol\": \"Socket.init(_:params:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Socket.swift\",\n \"line\": 663,\n \"symbol\": \"Socket.websocketDidConnect(socket:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Socket.swift\",\n \"line\": 667,\n \"symbol\": \"Socket.websocketDidDisconnect(socket:error:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Socket.swift\",\n \"line\": 672,\n \"symbol\": \"Socket.websocketDidReceiveMessage(socket:text:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Socket.swift\",\n \"line\": 676,\n \"symbol\": \"Socket.websocketDidReceiveData(socket:data:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 59,\n \"symbol\": \"ChannelState.closed\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 60,\n \"symbol\": \"ChannelState.errored\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 61,\n \"symbol\": \"ChannelState.joined\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 62,\n \"symbol\": \"ChannelState.joining\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 63,\n \"symbol\": \"ChannelState.leaving\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 69,\n \"symbol\": \"ChannelEvent.heartbeat\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 70,\n \"symbol\": \"ChannelEvent.join\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 71,\n \"symbol\": \"ChannelEvent.leave\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 72,\n \"symbol\": \"ChannelEvent.reply\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 73,\n \"symbol\": \"ChannelEvent.error\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Defaults.swift\",\n \"line\": 74,\n \"symbol\": \"ChannelEvent.close\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 31,\n \"symbol\": \"Delegated.init()\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 33,\n \"symbol\": \"Delegated.delegate(to:with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 43,\n \"symbol\": \"Delegated.call(_:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 47,\n \"symbol\": \"Delegated.isDelegateSet\",\n \"symbol_kind\": \"source.lang.swift.decl.var.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 55,\n \"symbol\": \"Delegated.stronglyDelegate(to:with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 62,\n \"symbol\": \"Delegated.manuallyDelegate(with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 66,\n \"symbol\": \"Delegated.removeDelegate()\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 74,\n \"symbol\": \"Delegated.delegate(to:with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 79,\n \"symbol\": \"Delegated.stronglyDelegate(to:with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 88,\n \"symbol\": \"Delegated.call()\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 96,\n \"symbol\": \"Delegated.call(_:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/client/Utilities/Delegated.swift\",\n \"line\": 104,\n \"symbol\": \"Delegated.call()\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n }\n ],\n \"source_directory\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient\"\n}"
},
{
"path": "docs/index.html",
"content": "\n\n \n SwiftPhoenixClient Reference \n \n
\n SwiftPhoenixClient Reference \n
\n
\n \n
\n \n \n \n Swift Phoenix Client \n\n
\nAbout \n\nSwift Phoenix Client is an extension of Starscream websocket client library\nthat makes it easy to connect to Phoenix sockets in a similar manner to the\nphoenix.js client.
\n\nThe client is currently updated to mirror phoenix.js 1.4.
\nSwift Versions \n\nmaster currently supports Swift 5.0. You’ll need to set your target to = 1.0.1 if your project is using Swift 4.2
\n\n\n\nswift \nclient \n \n \n\n4.2 \n1.0.1 \n \n\n5.0 \n1.1.0 \n \n
\nInstallation \nCocoaPods \n\nYou can install SwiftPhoenix Client via CocoaPods by adding the following to your\nPodfile. Keep in mind that in order to use Swift Phoenix Client, the minimum iOS\ntarget must be ‘9.0’
\nplatform :ios, '9.0'\nuse_frameworks!\n\npod \"SwiftPhoenixClient\", '~> 1.0'\nand running pod install. From there you will need to add import SwiftPhoenixClient in any class you want it to be used.
\nCarthage \n\nIf you use Carthage to manage your dependencies, simply add\nSwiftPhoenixClient to your Cartfile:
\ngithub \"davidstump/SwiftPhoenixClient\" ~> 1.0\nSwiftPackageManager \n\nSwiftPackageManager is properly supported starting in SwiftPhoenixClient v1.2.0. You can add the following to your Package.swift
\n.package(url: \"https://github.com/davidstump/SwiftPhoenixClient.git\", .upToNextMajor(from: \"1.2.0\"))\nMake sure you have added SwiftPhoenixClient.framework, and Starscream.framework to the “Linked Frameworks and Libraries ” section of your target, and have included them in your Carthage framework copying build phase.
\nUsage \n\nUsing the Swift Phoenix Client is extremely easy (and familiar if have used the phoenix.s client).
\n\nSee the Usage Guide for details instructions. You can also check out the documentation
\nExample \n\nCheck out the ViewController in this repo for a brief example of a simple iOS chat application using the Phoenix Chat Example
\n\nAlso check out both the Swift and Elixir channels on IRC.
\nDevelopment \n\nCheck out the wiki page for getting started
\n\nTested with the Phoenix Chat Server example , upgraded to Phoenix 1.2.
\nThanks \n\nMany many thanks to Daniel Rees for his many contributions and continued maintenance of this project!
\nLicense \n\nSwiftPhoenixClient is available under the MIT license. See the LICENSE file for more info.
\n\n \n \n \n \n
Alias for a JSON dictionary [String: Any]
\"},\"Typealiases.html#/s:18SwiftPhoenixClient14PayloadClosurea\":{\"name\":\"PayloadClosure\",\"abstract\":\"Alias for a function returning an optional JSON dictionary (Payload?)
\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVACyxq_Gycfc\":{\"name\":\"init()\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV8delegate2to4withyqd___q_qd___xtctRld__ClF\":{\"name\":\"delegate(to:with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV4callyq_SgxF\":{\"name\":\"call(_:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV13isDelegateSetSbvp\":{\"name\":\"isDelegateSet\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV16stronglyDelegate2to4withyqd___q_qd___xtctRld__ClF\":{\"name\":\"stronglyDelegate(to:with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV16manuallyDelegate4withyq_xc_tF\":{\"name\":\"manuallyDelegate(with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedV14removeDelegateyyF\":{\"name\":\"removeDelegate()\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRszrlE8delegate2to4withyqd___q_qd__ctRld__ClF\":{\"name\":\"delegate(to:with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRszrlE16stronglyDelegate2to4withyqd___q_qd__ctRld__ClF\":{\"name\":\"stronglyDelegate(to:with:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRszrlE4callq_SgyF\":{\"name\":\"call()\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRs_rlE4callyyxF\":{\"name\":\"call(_:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/Delegated.html#/s:18SwiftPhoenixClient9DelegatedVAAytRszytRs_rlE4callyyF\":{\"name\":\"call()\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Delegated\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV9heartbeatSSvpZ\":{\"name\":\"heartbeat\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV4joinSSvpZ\":{\"name\":\"join\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV5leaveSSvpZ\":{\"name\":\"leave\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV5replySSvpZ\":{\"name\":\"reply\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV5errorSSvpZ\":{\"name\":\"error\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html#/s:18SwiftPhoenixClient12ChannelEventV5closeSSvpZ\":{\"name\":\"close\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelEvent\"},\"Structs/ChannelEvent.html\":{\"name\":\"ChannelEvent\",\"abstract\":\"Represents the different events that can be sent through\"},\"Structs/Delegated.html\":{\"name\":\"Delegated\",\"abstract\":\"
Provides a memory-safe way of passing callbacks around while not creating\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO6closedyA2CmF\":{\"name\":\"closed\",\"abstract\":\"
Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO7erroredyA2CmF\":{\"name\":\"errored\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO6joinedyA2CmF\":{\"name\":\"joined\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO7joiningyA2CmF\":{\"name\":\"joining\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html#/s:18SwiftPhoenixClient12ChannelStateO7leavingyA2CmF\":{\"name\":\"leaving\",\"abstract\":\"Undocumented
\",\"parent_name\":\"ChannelState\"},\"Enums/ChannelState.html\":{\"name\":\"ChannelState\",\"abstract\":\"Represents the multiple states that a Channel can be in\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC15timeoutIntervalSdvpZ\":{\"name\":\"timeoutInterval\",\"abstract\":\"
Default timeout when sending messages
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC17heartbeatIntervalSdvpZ\":{\"name\":\"heartbeatInterval\",\"abstract\":\"Default interval to send heartbeats on
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC23reconnectSteppedBackOffySdSicvpZ\":{\"name\":\"reconnectSteppedBackOff\",\"abstract\":\"Default reconnect algorithm for the socket
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC20rejoinSteppedBackOffySdSicvpZ\":{\"name\":\"rejoinSteppedBackOff\",\"abstract\":\"Default rejoin algorithm for individual channels
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC6encodey10Foundation4DataVSDySSypGcvpZ\":{\"name\":\"encode\",\"abstract\":\"Default encode function, utilizing JSONSerialization.data
\",\"parent_name\":\"Defaults\"},\"Classes/Defaults.html#/s:18SwiftPhoenixClient8DefaultsC6decodeySDySSypGSg10Foundation4DataVcvpZ\":{\"name\":\"decode\",\"abstract\":\"Default decode function, utilizing JSONSerialization.jsonObject
\",\"parent_name\":\"Defaults\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC8endPointSSvp\":{\"name\":\"endPoint\",\"abstract\":\"The string WebSocket endpoint (ie "ws://example.com/socket",\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC11endPointUrl10Foundation3URLVvp\":{\"name\":\"endPointUrl\",\"abstract\":\"
The fully qualified socket URL
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6paramsSDySSypGSgvp\":{\"name\":\"params\",\"abstract\":\"Resolves to return the paramsClosure
The optional params closure used to get params whhen connecting. Must\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6encodey10Foundation4DataVSDySSypGcvp\":{\"name\":\"encode\",\"abstract\":\"
Override to provide custom encoding of data before writing to the socket
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6decodeySDySSypGSg10Foundation4DataVcvp\":{\"name\":\"decode\",\"abstract\":\"Override to provide customd decoding of data read from the socket
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7timeoutSdvp\":{\"name\":\"timeout\",\"abstract\":\"Timeout to use when opening connections
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC17heartbeatIntervalSdvp\":{\"name\":\"heartbeatInterval\",\"abstract\":\"Interval between sending a heartbeat
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC14reconnectAfterySdSicvp\":{\"name\":\"reconnectAfter\",\"abstract\":\"Interval between socket reconnect attempts, in seconds
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC11rejoinAfterySdSicvp\":{\"name\":\"rejoinAfter\",\"abstract\":\"Interval between channel rejoin attempts, in seconds
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6loggerySScSgvp\":{\"name\":\"logger\",\"abstract\":\"The optional function to receive logs
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC13skipHeartbeatSbvp\":{\"name\":\"skipHeartbeat\",\"abstract\":\"Disables heartbeats from being sent. Default is false.
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC24disableSSLCertValidationSbvp\":{\"name\":\"disableSSLCertValidation\",\"abstract\":\"Enable/Disable SSL certificate validation. Default is false. This\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC8security10Starscream17SSLTrustValidator_pSgvp\":{\"name\":\"security\",\"abstract\":\"
Configure custom SSL validation logic, eg. SSL pinning. This\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC22enabledSSLCipherSuitesSays6UInt16VGSgvp\":{\"name\":\"enabledSSLCipherSuites\",\"abstract\":\"
Configure the encryption used by your client by setting the\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC_6paramsACSS_SDySSypGSgtcfc\":{\"name\":\"init(_:params:)\",\"abstract\":\"
Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC_13paramsClosureACSS_SDySSypGSgycSgtcfc\":{\"name\":\"init(_:paramsClosure:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC17websocketProtocolSSvp\":{\"name\":\"websocketProtocol\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC11isConnectedSbvp\":{\"name\":\"isConnected\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7connectyyF\":{\"name\":\"connect()\",\"abstract\":\"Connects the Socket. The params passed to the Socket on initialization\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC10disconnect4code8callbacky10Starscream9CloseCodeO_yycSgtF\":{\"name\":\"disconnect(code:callback:)\",\"abstract\":\"
Disconnects the socket
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6onOpen8callbackyyyc_tF\":{\"name\":\"onOpen(callback:)\",\"abstract\":\"Registers callbacks for connection open events. Does not handle retain\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC14delegateOnOpen2to8callbackyx_yxctRlzClF\":{\"name\":\"delegateOnOpen(to:callback:)\",\"abstract\":\"
Registers callbacks for connection open events. Automatically handles\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7onClose8callbackyyyc_tF\":{\"name\":\"onClose(callback:)\",\"abstract\":\"
Registers callbacks for connection close events. Does not handle retain\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC15delegateOnClose2to8callbackyx_yxctRlzClF\":{\"name\":\"delegateOnClose(to:callback:)\",\"abstract\":\"
Registers callbacks for connection close events. Automatically handles\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7onError8callbackyys0F0_pc_tF\":{\"name\":\"onError(callback:)\",\"abstract\":\"
Registers callbacks for connection error events. Does not handle retain\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC15delegateOnError2to8callbackyx_yx_s0G0_ptctRlzClF\":{\"name\":\"delegateOnError(to:callback:)\",\"abstract\":\"
Registers callbacks for connection error events. Automatically handles\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC9onMessage8callbackyyAA0F0Cc_tF\":{\"name\":\"onMessage(callback:)\",\"abstract\":\"
Registers callbacks for connection message events. Does not handle\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC17delegateOnMessage2to8callbackyx_yx_AA0G0CtctRlzClF\":{\"name\":\"delegateOnMessage(to:callback:)\",\"abstract\":\"
Registers callbacks for connection message events. Automatically handles\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC16releaseCallbacksyyF\":{\"name\":\"releaseCallbacks()\",\"abstract\":\"
Releases all stored callback hooks (onError, onOpen, onClose, etc.) You should\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7channel_6paramsAA7ChannelCSS_SDySSypGtF\":{\"name\":\"channel(_:params:)\",\"abstract\":\"
Initialize a new Channel
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC6removeyyAA7ChannelCF\":{\"name\":\"remove(_:)\",\"abstract\":\"Removes the Channel from the socket. This does not cause the channel to\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC7makeRefSSyF\":{\"name\":\"makeRef()\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC19websocketDidConnect6sockety10Starscream03WebdC0_p_tF\":{\"name\":\"websocketDidConnect(socket:)\",\"abstract\":\"
Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC22websocketDidDisconnect6socket5errory10Starscream03WebdC0_p_s5Error_pSgtF\":{\"name\":\"websocketDidDisconnect(socket:error:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC26websocketDidReceiveMessage6socket4texty10Starscream03WebdC0_p_SStF\":{\"name\":\"websocketDidReceiveMessage(socket:text:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Socket.html#/s:18SwiftPhoenixClient6SocketC23websocketDidReceiveData6socket4datay10Starscream03WebdC0_p_10Foundation0H0VtF\":{\"name\":\"websocketDidReceiveData(socket:data:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Socket\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC7channelAA7ChannelCSgvp\":{\"name\":\"channel\",\"abstract\":\"The channel sending the Push
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC5eventSSvp\":{\"name\":\"event\",\"abstract\":\"The event, for example phx_join
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC7payloadSDySSypGvp\":{\"name\":\"payload\",\"abstract\":\"The payload, for example [“user_id”: “abc123”]
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC7timeoutSdvp\":{\"name\":\"timeout\",\"abstract\":\"The push timeout. Default is 10.0 seconds
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC6resendyySdF\":{\"name\":\"resend(_:)\",\"abstract\":\"Resets and sends the Push
\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC4sendyyF\":{\"name\":\"send()\",\"abstract\":\"Sends the Push. If it has already timed out, then the call will\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC7receive_8callbackACSS_yAA7MessageCctF\":{\"name\":\"receive(_:callback:)\",\"abstract\":\"
Receive a specific event when sending an Outbound message. Subscribing\",\"parent_name\":\"Push\"},\"Classes/Push.html#/s:18SwiftPhoenixClient4PushC15delegateReceive_2to8callbackACSS_xyx_AA7MessageCtctRlzClF\":{\"name\":\"delegateReceive(_:to:callback:)\",\"abstract\":\"
Receive a specific event when sending an Outbound message. Automatically\",\"parent_name\":\"Push\"},\"Classes/Presence/Events.html#/s:18SwiftPhoenixClient8PresenceC6EventsO5stateyA2EmF\":{\"name\":\"state\",\"abstract\":\"
Undocumented
\",\"parent_name\":\"Events\"},\"Classes/Presence/Events.html#/s:18SwiftPhoenixClient8PresenceC6EventsO4diffyA2EmF\":{\"name\":\"diff\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Events\"},\"Classes/Presence/Options.html#/s:18SwiftPhoenixClient8PresenceC7OptionsV8defaultsAEvpZ\":{\"name\":\"defaults\",\"abstract\":\"Default set of Options used when creating Presence. Uses the\",\"parent_name\":\"Options\"},\"Classes/Presence/Options.html\":{\"name\":\"Options\",\"abstract\":\"
Custom options that can be provided when creating Presence
\",\"parent_name\":\"Presence\"},\"Classes/Presence/Events.html\":{\"name\":\"Events\",\"abstract\":\"Presense Events
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC4Metaa\":{\"name\":\"Meta\",\"abstract\":\"Meta details of a Presence. Just a dictionary of properties
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC3Mapa\":{\"name\":\"Map\",\"abstract\":\"A mapping of a String to an array of Metas. e.g. {“metas”: [{id: 1}]}
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC5Statea\":{\"name\":\"State\",\"abstract\":\"A mapping of a Presence state to a mapping of Metas
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC4Diffa\":{\"name\":\"Diff\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6OnJoina\":{\"name\":\"OnJoin\",\"abstract\":\"Closure signature of OnJoin callbacks
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7OnLeavea\":{\"name\":\"OnLeave\",\"abstract\":\"Closure signature for OnLeave callbacks
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6OnSynca\":{\"name\":\"OnSync\",\"abstract\":\"/ Closure signature for OnSync callbacks
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC5stateSDySSSDySSSaySDySSypGGGGvp\":{\"name\":\"state\",\"abstract\":\"The state of the Presence
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC12pendingDiffsSaySDySSSDySSSDySSSaySDySSypGGGGGGvp\":{\"name\":\"pendingDiffs\",\"abstract\":\"Pending join and leave diffs that need to be synced
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7joinRefSSSgvp\":{\"name\":\"joinRef\",\"abstract\":\"The channel’s joinRef, set when state events occur
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC18isPendingSyncStateSbvp\":{\"name\":\"isPendingSyncState\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6onJoinyySS_SDySSSaySDySSypGGGSgAGtcvp\":{\"name\":\"onJoin\",\"abstract\":\"Callback to be informed of joins
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6onJoinyyySS_SDySSSaySDySSypGGGSgAGtcF\":{\"name\":\"onJoin(_:)\",\"abstract\":\"Set the OnJoin callback
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7onLeaveyySS_SDySSSaySDySSypGGGAGtcvp\":{\"name\":\"onLeave\",\"abstract\":\"Callback to be informed of leaves
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7onLeaveyyySS_SDySSSaySDySSypGGGAGtcF\":{\"name\":\"onLeave(_:)\",\"abstract\":\"Set the OnLeave callback
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6onSyncyycvp\":{\"name\":\"onSync\",\"abstract\":\"Callback to be informed of synces
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6onSyncyyyycF\":{\"name\":\"onSync(_:)\",\"abstract\":\"Set the OnSync callback
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC7channel4optsAcA7ChannelC_AC7OptionsVtcfc\":{\"name\":\"init(channel:opts:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC4listSaySDySSSaySDySSypGGGGyF\":{\"name\":\"list()\",\"abstract\":\"Returns the array of presences, with deault selected metadata.
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC4list2bySayxGxSS_SDySSSaySDySSypGGGtXE_tlF\":{\"name\":\"list(by:)\",\"abstract\":\"Returns the array of presences, with selected metadata
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6filter2bySDySSSDySSSaySDySSypGGGGSbSS_AHtcSg_tF\":{\"name\":\"filter(by:)\",\"abstract\":\"Filter the Presence state with a given function
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC9syncState_03newF06onJoin0H5LeaveSDySSSDySSSaySDySSypGGGGAK_AKySS_AJSgAJtXEySS_A2JtXEtFZ\":{\"name\":\"syncState(_:newState:onJoin:onLeave:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC8syncDiff_4diff6onJoin0H5LeaveSDySSSDySSSaySDySSypGGGGAK_SDySSAKGySS_AJSgAJtXEySS_A2JtXEtFZ\":{\"name\":\"syncDiff(_:diff:onJoin:onLeave:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6filter_2bySDySSSDySSSaySDySSypGGGGAI_SbSS_AHtcSgtFZ\":{\"name\":\"filter(_:by:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Presence.html#/s:18SwiftPhoenixClient8PresenceC6listBy_11transformerSayxGSDySSSDySSSaySDySSypGGGG_xSS_AItXEtlFZ\":{\"name\":\"listBy(_:transformer:)\",\"abstract\":\"Undocumented
\",\"parent_name\":\"Presence\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC3refSSvp\":{\"name\":\"ref\",\"abstract\":\"Reference number. Empty if missing
\",\"parent_name\":\"Message\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC5topicSSvp\":{\"name\":\"topic\",\"abstract\":\"Message topic
\",\"parent_name\":\"Message\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC5eventSSvp\":{\"name\":\"event\",\"abstract\":\"Message event
\",\"parent_name\":\"Message\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC7payloadSDySSypGvp\":{\"name\":\"payload\",\"abstract\":\"Message payload
\",\"parent_name\":\"Message\"},\"Classes/Message.html#/s:18SwiftPhoenixClient7MessageC6statusSSSgvp\":{\"name\":\"status\",\"abstract\":\"Convenience accessor. Equivalent to getting the status as such:
\",\"parent_name\":\"Message\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC5topicSSvp\":{\"name\":\"topic\",\"abstract\":\"The topic of the Channel. e.g. “rooms:friends”
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC6paramsSDySSypGvp\":{\"name\":\"params\",\"abstract\":\"The params sent when joining the channel
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9onMessageyAA0F0CAFcvp\":{\"name\":\"onMessage\",\"abstract\":\"Overridable message hook. Receives all events for specialized message\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC4join7timeoutAA4PushCSdSg_tF\":{\"name\":\"join(timeout:)\",\"abstract\":\"
Joins the channel
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC7onCloseySiyAA7MessageCcF\":{\"name\":\"onClose(_:)\",\"abstract\":\"Hook into when the Channel is closed. Does not handle retain cycles.\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC15delegateOnClose2to8callbackSix_yx_AA7MessageCtctRlzClF\":{\"name\":\"delegateOnClose(to:callback:)\",\"abstract\":\"
Hook into when the Channel is closed. Automatically handles retain\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC7onErrorySiyAA7MessageCcF\":{\"name\":\"onError(_:)\",\"abstract\":\"
Hook into when the Channel receives an Error. Does not handle retain\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC15delegateOnError2to8callbackSix_yx_AA7MessageCtctRlzClF\":{\"name\":\"delegateOnError(to:callback:)\",\"abstract\":\"
Hook into when the Channel receives an Error. Automatically handles\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC2on_8callbackSiSS_yAA7MessageCctF\":{\"name\":\"on(_:callback:)\",\"abstract\":\"
Subscribes on channel events. Does not handle retain cycles. Use\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC10delegateOn_2to8callbackSiSS_xyx_AA7MessageCtctRlzClF\":{\"name\":\"delegateOn(_:to:callback:)\",\"abstract\":\"
Subscribes on channel events. Automatically handles retain cycles. Use\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC3off_3refySS_SiSgtF\":{\"name\":\"off(_:ref:)\",\"abstract\":\"
Unsubscribes from a channel event. If a ref is given, only the exact\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC4push_7payload7timeoutAA4PushCSS_SDySSypGSdtF\":{\"name\":\"push(_:payload:timeout:)\",\"abstract\":\"
Push a payload to the Channel
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC5leave7timeoutAA4PushCSd_tF\":{\"name\":\"leave(timeout:)\",\"abstract\":\"Leaves the channel
\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9onMessage8callbackyAA0F0CAGc_tF\":{\"name\":\"onMessage(callback:)\",\"abstract\":\"Overridable message hook. Receives all events for specialized message\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC8isClosedSbvp\":{\"name\":\"isClosed\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9isErroredSbvp\":{\"name\":\"isErrored\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC8isJoinedSbvp\":{\"name\":\"isJoined\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9isJoiningSbvp\":{\"name\":\"isJoining\",\"parent_name\":\"Channel\"},\"Classes/Channel.html#/s:18SwiftPhoenixClient7ChannelC9isLeavingSbvp\":{\"name\":\"isLeaving\",\"parent_name\":\"Channel\"},\"Classes/Channel.html\":{\"name\":\"Channel\",\"abstract\":\"
Undocumented
\"},\"Classes/Message.html\":{\"name\":\"Message\",\"abstract\":\"Data that is received from the Server.
\"},\"Classes/Presence.html\":{\"name\":\"Presence\",\"abstract\":\"The Presence object provides features for syncing presence information from\"},\"Classes/Push.html\":{\"name\":\"Push\",\"abstract\":\"
Represnts pushing data to a Channel Socket
\"},\"Classes/Socket.html\":{\"name\":\"Socket\",\"abstract\":\"Socket Connection \"},\"Classes/Defaults.html\":{\"name\":\"Defaults\",\"abstract\":\"A collection of default values and behaviors used accross the Client
\"},\"Classes.html\":{\"name\":\"Classes\",\"abstract\":\"The following classes are available globally.
\"},\"Enums.html\":{\"name\":\"Enumerations\",\"abstract\":\"The following enumerations are available globally.
\"},\"Structs.html\":{\"name\":\"Structures\",\"abstract\":\"The following structures are available globally.
\"},\"Typealiases.html\":{\"name\":\"Type Aliases\",\"abstract\":\"The following type aliases are available globally.
\"}}"
},
{
"path": "docs/undocumented.json",
"content": "{\n \"warnings\": [\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Channel.swift\",\n \"line\": 61,\n \"symbol\": \"Channel\",\n \"symbol_kind\": \"source.lang.swift.decl.class\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Channel.swift\",\n \"line\": 601,\n \"symbol\": \"Channel\",\n \"symbol_kind\": \"source.lang.swift.decl.extension\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 118,\n \"symbol\": \"Presence.Events.state\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 119,\n \"symbol\": \"Presence.Events.diff\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 136,\n \"symbol\": \"Presence.Diff\",\n \"symbol_kind\": \"source.lang.swift.decl.typealias\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 173,\n \"symbol\": \"Presence.isPendingSyncState\",\n \"symbol_kind\": \"source.lang.swift.decl.var.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 212,\n \"symbol\": \"Presence.init(channel:opts:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 285,\n \"symbol\": \"Presence.syncState(_:newState:onJoin:onLeave:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 340,\n \"symbol\": \"Presence.syncDiff(_:diff:onJoin:onLeave:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 380,\n \"symbol\": \"Presence.filter(_:by:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Presence.swift\",\n \"line\": 386,\n \"symbol\": \"Presence.listBy(_:transformer:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Socket.swift\",\n \"line\": 161,\n \"symbol\": \"Socket.init(_:params:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Socket.swift\",\n \"line\": 168,\n \"symbol\": \"Socket.init(_:paramsClosure:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Socket.swift\",\n \"line\": 723,\n \"symbol\": \"Socket.websocketDidConnect(socket:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Socket.swift\",\n \"line\": 727,\n \"symbol\": \"Socket.websocketDidDisconnect(socket:error:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Socket.swift\",\n \"line\": 732,\n \"symbol\": \"Socket.websocketDidReceiveMessage(socket:text:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Socket.swift\",\n \"line\": 736,\n \"symbol\": \"Socket.websocketDidReceiveData(socket:data:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 66,\n \"symbol\": \"ChannelState.closed\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 67,\n \"symbol\": \"ChannelState.errored\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 68,\n \"symbol\": \"ChannelState.joined\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 69,\n \"symbol\": \"ChannelState.joining\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 70,\n \"symbol\": \"ChannelState.leaving\",\n \"symbol_kind\": \"source.lang.swift.decl.enumelement\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 76,\n \"symbol\": \"ChannelEvent.heartbeat\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 77,\n \"symbol\": \"ChannelEvent.join\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 78,\n \"symbol\": \"ChannelEvent.leave\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 79,\n \"symbol\": \"ChannelEvent.reply\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 80,\n \"symbol\": \"ChannelEvent.error\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Defaults.swift\",\n \"line\": 81,\n \"symbol\": \"ChannelEvent.close\",\n \"symbol_kind\": \"source.lang.swift.decl.var.static\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 31,\n \"symbol\": \"Delegated.init()\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 33,\n \"symbol\": \"Delegated.delegate(to:with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 43,\n \"symbol\": \"Delegated.call(_:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 47,\n \"symbol\": \"Delegated.isDelegateSet\",\n \"symbol_kind\": \"source.lang.swift.decl.var.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 55,\n \"symbol\": \"Delegated.stronglyDelegate(to:with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 62,\n \"symbol\": \"Delegated.manuallyDelegate(with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 66,\n \"symbol\": \"Delegated.removeDelegate()\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 74,\n \"symbol\": \"Delegated.delegate(to:with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 79,\n \"symbol\": \"Delegated.stronglyDelegate(to:with:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 88,\n \"symbol\": \"Delegated.call()\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 96,\n \"symbol\": \"Delegated.call(_:)\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n },\n {\n \"file\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient/Sources/Utilities/Delegated.swift\",\n \"line\": 104,\n \"symbol\": \"Delegated.call()\",\n \"symbol_kind\": \"source.lang.swift.decl.function.method.instance\",\n \"warning\": \"undocumented\"\n }\n ],\n \"source_directory\": \"/Users/drees/src/github/phoenix/SwiftPhoenixClient\"\n}"
},
{
"path": "fastlane/Appfile",
"content": "# app_identifier \"[[APP_IDENTIFIER]]\" # The bundle identifier of your app\n# apple_id \"[[APPLE_ID]]\" # Your Apple email address\n\n\n# For more information about the Appfile, see:\n# https://docs.fastlane.tools/advanced/#appfile\n"
},
{
"path": "fastlane/Fastfile",
"content": "# This file contains the fastlane.tools configuration\n# You can find the documentation at https://docs.fastlane.tools\n#\n# For a list of all available actions, check out\n#\n# https://docs.fastlane.tools/actions\n#\n\n# Uncomment the line if you want fastlane to automatically update itself\n# update_fastlane\n\ndefault_platform(:ios)\n\nplatform :ios do\n\n desc \"Runs tests for the project\"\n lane :test do \n execute_tests\n gather_coverage\n end\n\n\n # PRIVATE LANES\n private_lane :execute_tests do \n scan(\n scheme: \"SwiftPhoenixClient\",\n code_coverage: true\n )\n end\n\n private_lane :gather_coverage do \n slather(\n use_bundle_exec: true,\n cobertura_xml: true,\n travis: true\n )\n end\nend\n"
},
{
"path": "fastlane/README.md",
"content": "fastlane documentation\n================\n# Installation\n\nMake sure you have the latest version of the Xcode command line tools installed:\n\n```\nxcode-select --install\n```\n\nInstall _fastlane_ using\n```\n[sudo] gem install fastlane -NV\n```\nor alternatively using `brew cask install fastlane`\n\n# Available Actions\n## iOS\n### ios test\n```\nfastlane ios test\n```\nRuns tests for the project\n\n----\n\nThis README.md is auto-generated and will be re-generated every time [fastlane](https://fastlane.tools) is run.\nMore information about fastlane can be found on [fastlane.tools](https://fastlane.tools).\nThe documentation of fastlane can be found on [docs.fastlane.tools](https://docs.fastlane.tools).\n"
},
{
"path": "sourcery/MockableClass.stencil",
"content": "// swiftlint:disable line_length\n// swiftlint:disable variable_name\n\n@testable import SwiftPhoenixClient\n\n{% macro swiftifyMethodName name %}{{ name | replace:\"(\",\"_\" | replace:\")\",\"\" | replace:\":\",\"_\" | replace:\"`\",\"\" | snakeToCamelCase | lowerFirstWord }}{% endmacro %}\n\n{% macro methodThrowableErrorDeclaration method %}\n var {% call swiftifyMethodName method.selectorName %}ThrowableError: Error?\n{% endmacro %}\n\n\n{% macro argumentsBlock arguments %}{% filter removeNewlines:\"leading\" %}\n {% for argument in arguments %}\n {{argument.name}}{% if not forloop.last %}, {% endif %}\n {% endfor %}\n{% endfilter %}{% endmacro %}\n\n\n{% macro methodThrowableErrorUsage method %}\n if let error = {% call swiftifyMethodName method.selectorName %}ThrowableError {\n throw error\n }\n{% endmacro %}\n\n{% macro methodReceivedParameters method %}\n {%if method.parameters.count == 1 %}\n {% call swiftifyMethodName method.selectorName %}Received{% for param in method.parameters %}{{ param.name|upperFirstLetter }} = {{ param.name }}{% endfor %}\n {% else %}\n {% if not method.parameters.count == 0 %}\n {% call swiftifyMethodName method.selectorName %}ReceivedArguments = ({% for param in method.parameters %}{{ param.name }}: {{ param.name }}{% if not forloop.last%}, {% endif %}{% endfor %})\n {% endif %}\n {% endif %}\n{% endmacro %}\n\n\n\n{% macro methodClosureName method %}{% call swiftifyMethodName method.selectorName %}Closure{% endmacro %}\n\n{% macro methodClosureDeclaration method %}\n var {% call methodClosureName method %}: (({% for param in method.parameters %}{{ param.typeName }}{% if not forloop.last %}, {% endif %}{% endfor %}) {% if method.throws %}throws {% endif %}-> {% if method.isInitializer %}Void{% else %}{{ method.returnTypeName }}{% endif %})?\n{% endmacro %}\n\n{% macro methodClosureCallParameters method %}{% for param in method.parameters %}{{ param.name }}{% if not forloop.last %}, {% endif %}{% endfor %}{% endmacro %}\n\n{% macro mockMethod method %}\n //MARK: - {{ method.shortName }}\n\n {% if method.throws %}\n {% call methodThrowableErrorDeclaration method %}\n {% endif %}\n {% if not method.isInitializer %}\n var {% call swiftifyMethodName method.selectorName %}CallsCount = 0\n var {% call swiftifyMethodName method.selectorName %}Called: Bool {\n return {% call swiftifyMethodName method.selectorName %}CallsCount > 0\n }\n {% endif %}\n {% if method.parameters.count == 1 and method.isGeneric == false %}\n var {% call swiftifyMethodName method.selectorName %}Received{% for param in method.parameters %}{{ param.name|upperFirstLetter }}: {% if param.isClosure %}({% endif %}{{ param.typeName.unwrappedTypeName }}{% if param.isClosure %}){% endif %}?{% endfor %}\n {% else %}{% if not method.parameters.count == 0 and method.isGeneric == false %}\n var {% call swiftifyMethodName method.selectorName %}ReceivedArguments: ({% for param in method.parameters %}{{ param.name }}: {% if param.typeAttributes.escaping %}{{ param.unwrappedTypeName }}{% else %}{{ param.typeName }}{% endif %}{% if not forloop.last %}, {% endif %}{% endfor %})?\n {% endif %}{% endif %}\n {% if not method.returnTypeName.isVoid and not method.isInitializer %}\n var {% call swiftifyMethodName method.selectorName %}ReturnValue: {{ method.returnTypeName }}!\n {% endif %}\n {% if method.isGeneric == false %}\n {% call methodClosureDeclaration method %}\n {% endif %}\n\n{% if method.isInitializer or method.isDeinitializer %}\n {#{% if not method.isConvenienceInitializer %}\n override {{ method.name }} {\n super.{{ method.callName }}({% for param in method.parameters %}{{ param.name }}: {{ param.name }}{% ifnot forloop.last %}, {% endif %}{% endfor %})\n {% call methodReceivedParameters method %}\n {% call methodClosureName method %}?({% call methodClosureCallParameters method %})\n }\n {% endif %}#}\n{% else %}\n override func {{ method.name }}{% if method.throws %} throws{% endif %}{% if not method.returnTypeName.isVoid %} -> {{ method.returnTypeName }}{% endif %} {\n {% if method.throws %}\n {% call methodThrowableErrorUsage method %}\n {% endif %}\n {% call swiftifyMethodName method.selectorName %}CallsCount += 1\n {% if method.isGeneric == false %}\n {% call methodReceivedParameters method %}\n {% endif %}\n {% if method.returnTypeName.isVoid %}\n {% if method.isGeneric == false %}\n {% if method.throws %}try {% endif %}{% call methodClosureName method %}?({% call methodClosureCallParameters method %})\n {% endif %}\n {% else %}\n {% if method.isGeneric == true %}\n return {% call swiftifyMethodName method.selectorName %}ReturnValue\n {% else %}\n return {% if method.throws %}try {% endif %}{% call methodClosureName method %}.map({ {% if method.throws %}try {% endif %}$0({% call methodClosureCallParameters method %}) }) ?? {% call swiftifyMethodName method.selectorName %}ReturnValue\n {% endif %}\n {% endif %}\n }\n\n{% endif %}\n{% endmacro %}\n\n{% macro mockOptionalVariable variable %}\n {% if variable.writeAccess == \"\" %}\n var {% call underlyingMockedVariableName variable %}: {{ variable.typeName }}!\n override var {% call mockedVariableName variable %}: {{ variable.typeName }} {\n return {% call underlyingMockedVariableName variable %}\n }\n {% else %}\n var {{ variable.name }}SetCount: Int = 0\n var {{ variable.name }}DidGetSet: Bool { return {{ variable.name }}SetCount > 0 }\n override var {% call mockedVariableName variable %}: {{ variable.typeName }} {\n didSet { {{ variable.name }}SetCount += 1 }\n }\n {% endif %}\n{% endmacro %}\n\n{% macro mockNonOptionalArrayOrDictionaryVariable variable %}\n {# var {% call mockedVariableName variable %}: {{ variable.typeName }} = {% if variable.isArray %}[]{% elif variable.isDictionary %}[:]{% endif %} #}\n{% endmacro %}\n\n{% macro mockNonOptionalVariable variable %}\n override var {% call mockedVariableName variable %}: {{ variable.typeName }} {\n get { return {% call underlyingMockedVariableName variable %} }\n set(value) { {% call underlyingMockedVariableName variable %} = value }\n }\n var {% call underlyingMockedVariableName variable %}: ({{ variable.typeName }})!\n{% endmacro %}\n\n{% macro underlyingMockedVariableName variable %}underlying{{ variable.name|upperFirstLetter }}{% endmacro %}\n{% macro mockedVariableName variable %}{{ variable.name }}{% endmacro %}\n\n\n\n\n\n\n\n\n\n{% for type in types.classes where type.name == \"TimeoutTimer\" or type.name == \"Socket\" or type.name == \"Push\" or type.name == \"Channel\" %}\nclass {{ type.name }}Mock: {{ type.name }} {\n{# Generate all variable mocks #}\n{% for variable in type.allVariables|!definedInExtension where variable.readAccess != \"private\" and variable.isMutable %}\n {% if variable.isOptional %}{% call mockOptionalVariable variable %}{% elif variable.isArray or variable.isDictionary %}{% call mockNonOptionalArrayOrDictionaryVariable variable %}{% else %}{% call mockNonOptionalVariable variable %}{% endif %}\n{% endfor %}\n\n\n{% for method in type.allMethods|!definedInExtension where method.accessLevel != \"private\" and method.actualDefinedInTypeName.name != \"WebSocketDelegate\" %}\n {% call mockMethod method %}\n\n{% endfor %}\n}\n{% endfor %}\n"
},
{
"path": "sourcery/MockableProtocol.stencil",
"content": "// swiftlint:disable line_length\n// swiftlint:disable variable_name\n\nimport Foundation\n#if os(iOS) || os(tvOS) || os(watchOS)\nimport UIKit\n#elseif os(OSX)\nimport AppKit\n#endif\n\n@testable import SwiftPhoenixClient\n\n{% macro swiftifyMethodName name %}{{ name | replace:\"(\",\"_\" | replace:\")\",\"\" | replace:\":\",\"_\" | replace:\"`\",\"\" | snakeToCamelCase | lowerFirstWord }}{% endmacro %}\n\n{% macro methodThrowableErrorDeclaration method %}\n var {% call swiftifyMethodName method.selectorName %}ThrowableError: Error?\n{% endmacro %}\n\n{% macro methodThrowableErrorUsage method %}\n if let error = {% call swiftifyMethodName method.selectorName %}ThrowableError {\n throw error\n }\n{% endmacro %}\n\n{% macro methodReceivedParameters method %}\n {%if method.parameters.count == 1 %}\n {% call swiftifyMethodName method.selectorName %}Received{% for param in method.parameters %}{{ param.name|upperFirstLetter }} = {{ param.name }}{% endfor %}\n {% call swiftifyMethodName method.selectorName %}ReceivedInvocations.append({% for param in method.parameters %}{{ param.name }}){% endfor %}\n {% else %}\n {% if not method.parameters.count == 0 %}\n {% call swiftifyMethodName method.selectorName %}ReceivedArguments = ({% for param in method.parameters %}{{ param.name }}: {{ param.name }}{% if not forloop.last%}, {% endif %}{% endfor %})\n {% call swiftifyMethodName method.selectorName %}ReceivedInvocations.append(({% for param in method.parameters %}{{ param.name }}: {{ param.name }}{% if not forloop.last%}, {% endif %}{% endfor %}))\n {% endif %}\n {% endif %}\n{% endmacro %}\n\n{% macro methodClosureName method %}{% call swiftifyMethodName method.selectorName %}Closure{% endmacro %}\n\n{% macro closureReturnTypeName method %}{% if method.isOptionalReturnType %}{{ method.unwrappedReturnTypeName }}?{% else %}{{ method.returnTypeName }}{% endif %}{% endmacro %}\n\n{% macro methodClosureDeclaration method %}\n var {% call methodClosureName method %}: (({% for param in method.parameters %}{{ param.typeName }}{% if not forloop.last %}, {% endif %}{% endfor %}) {% if method.throws %}throws {% endif %}-> {% if method.isInitializer %}Void{% else %}{% call closureReturnTypeName method %}{% endif %})?\n{% endmacro %}\n\n{% macro methodClosureCallParameters method %}{% for param in method.parameters %}{{ param.name }}{% if not forloop.last %}, {% endif %}{% endfor %}{% endmacro %}\n\n{% macro mockMethod method %}\n //MARK: - {{ method.shortName }}\n\n {% if method.throws %}\n {% call methodThrowableErrorDeclaration method %}\n {% endif %}\n {% if not method.isInitializer %}\n var {% call swiftifyMethodName method.selectorName %}CallsCount = 0\n var {% call swiftifyMethodName method.selectorName %}Called: Bool {\n return {% call swiftifyMethodName method.selectorName %}CallsCount > 0\n }\n {% endif %}\n {% if method.parameters.count == 1 %}\n var {% call swiftifyMethodName method.selectorName %}Received{% for param in method.parameters %}{{ param.name|upperFirstLetter }}: {{ '(' if param.isClosure }}{{ param.typeName.unwrappedTypeName }}{{ ')' if param.isClosure }}?{% endfor %}\n var {% call swiftifyMethodName method.selectorName %}ReceivedInvocations{% for param in method.parameters %}: [{{ '(' if param.isClosure }}{{ param.typeName.unwrappedTypeName }}{{ ')' if param.isClosure }}{%if param.typeName.isOptional%}?{%endif%}]{% endfor %} = []\n {% elif not method.parameters.count == 0 %}\n var {% call swiftifyMethodName method.selectorName %}ReceivedArguments: ({% for param in method.parameters %}{{ param.name }}: {{ param.unwrappedTypeName if param.typeAttributes.escaping else param.typeName }}{{ ', ' if not forloop.last }}{% endfor %})?\n var {% call swiftifyMethodName method.selectorName %}ReceivedInvocations: [({% for param in method.parameters %}{{ param.name }}: {{ param.unwrappedTypeName if param.typeAttributes.escaping else param.typeName }}{{ ', ' if not forloop.last }}{% endfor %})] = []\n {% endif %}\n {% if not method.returnTypeName.isVoid and not method.isInitializer %}\n var {% call swiftifyMethodName method.selectorName %}ReturnValue: {{ '(' if method.returnTypeName.isClosure and not method.isOptionalReturnType }}{{ method.returnTypeName }}{{ ')' if method.returnTypeName.isClosure and not method.isOptionalReturnType }}{{ '!' if not method.isOptionalReturnType }}\n {% endif %}\n {% call methodClosureDeclaration method %}\n\n{% if method.isInitializer %}\n required {{ method.name }} {\n {% call methodReceivedParameters method %}\n {% call methodClosureName method %}?({% call methodClosureCallParameters method %})\n }\n{% else %}\n func {{ method.name }}{{ ' throws' if method.throws }}{% if not method.returnTypeName.isVoid %} -> {{ method.returnTypeName }}{% endif %} {\n {% if method.throws %}\n {% call methodThrowableErrorUsage method %}\n {% endif %}\n {% call swiftifyMethodName method.selectorName %}CallsCount += 1\n {% call methodReceivedParameters method %}\n {% if method.returnTypeName.isVoid %}\n {% if method.throws %}try {% endif %}{% call methodClosureName method %}?({% call methodClosureCallParameters method %})\n {% else %}\n return {{ 'try ' if method.throws }}{% call methodClosureName method %}.map({ {{ 'try ' if method.throws }}$0({% call methodClosureCallParameters method %}) }) ?? {% call swiftifyMethodName method.selectorName %}ReturnValue\n {% endif %}\n }\n\n{% endif %}\n{% endmacro %}\n\n{% macro mockOptionalVariable variable %}\n var {% call mockedVariableName variable %}: {{ variable.typeName }}\n{% endmacro %}\n\n{% macro mockNonOptionalArrayOrDictionaryVariable variable %}\n var {% call mockedVariableName variable %}: {{ variable.typeName }} = {% if variable.isArray %}[]{% elif variable.isDictionary %}[:]{% endif %}\n{% endmacro %}\n\n{% macro mockNonOptionalVariable variable %}\n var {% call mockedVariableName variable %}: {{ variable.typeName }} {\n get { return {% call underlyingMockedVariableName variable %} }\n set(value) { {% call underlyingMockedVariableName variable %} = value }\n }\n var {% call underlyingMockedVariableName variable %}: {{ variable.typeName }}!\n{% endmacro %}\n\n{% macro underlyingMockedVariableName variable %}underlying{{ variable.name|upperFirstLetter }}{% endmacro %}\n{% macro mockedVariableName variable %}{{ variable.name }}{% endmacro %}\n\n{% for type in types.protocols where type.based.AutoMockable or type|annotated:\"AutoMockable\" %}{% if type.name != \"AutoMockable\" %}\nclass {{ type.name }}Mock: {{ type.name }} {\n{% for variable in type.allVariables|!definedInExtension %}\n {% if variable.isOptional %}{% call mockOptionalVariable variable %}{% elif variable.isArray or variable.isDictionary %}{% call mockNonOptionalArrayOrDictionaryVariable variable %}{% else %}{% call mockNonOptionalVariable variable %}{% endif %}\n{% endfor %}\n\n{% for method in type.allMethods|!definedInExtension %}\n {% call mockMethod method %}\n{% endfor %}\n}\n{% endif %}{% endfor %}\n"
},
{
"path": "sourcery/MockableWebSocketClient.stencil",
"content": "// swiftlint:disable line_length\n// swiftlint:disable variable_name\n\nimport Starscream\n@testable import SwiftPhoenixClient\n\n{% macro swiftifyMethodName name %}{{ name | replace:\"(\",\"_\" | replace:\")\",\"\" | replace:\":\",\"_\" | replace:\"`\",\"\" | snakeToCamelCase | lowerFirstWord }}{% endmacro %}\n\n{% macro methodThrowableErrorDeclaration method %}\n var {% call swiftifyMethodName method.selectorName %}ThrowableError: Error?\n{% endmacro %}\n\n{% macro methodThrowableErrorUsage method %}\n if let error = {% call swiftifyMethodName method.selectorName %}ThrowableError {\n throw error\n }\n{% endmacro %}\n\n{% macro methodReceivedParameters method %}\n {%if method.parameters.count == 1 %}\n {% call swiftifyMethodName method.selectorName %}Received{% for param in method.parameters %}{{ param.name|upperFirstLetter }} = {{ param.name }}{% endfor %}\n {% else %}\n {% if not method.parameters.count == 0 %}\n {% call swiftifyMethodName method.selectorName %}ReceivedArguments = ({% for param in method.parameters %}{{ param.name }}: {{ param.name }}{% if not forloop.last%}, {% endif %}{% endfor %})\n {% endif %}\n {% endif %}\n{% endmacro %}\n\n{% macro methodClosureName method %}{% call swiftifyMethodName method.selectorName %}Closure{% endmacro %}\n\n{% macro methodClosureDeclaration method %}\n var {% call methodClosureName method %}: (({% for param in method.parameters %}{{ param.typeName }}{% if not forloop.last %}, {% endif %}{% endfor %}) {% if method.throws %}throws {% endif %}-> {% if method.isInitializer %}Void{% else %}{{ method.returnTypeName }}{% endif %})?\n{% endmacro %}\n\n{% macro methodClosureCallParameters method %}{% for param in method.parameters %}{{ param.name }}{% if not forloop.last %}, {% endif %}{% endfor %}{% endmacro %}\n\n{% macro mockMethod method %}\n //MARK: - {{ method.shortName }}\n\n {% if method.throws %}\n {% call methodThrowableErrorDeclaration method %}\n {% endif %}\n {% if not method.isInitializer %}\n var {% call swiftifyMethodName method.selectorName %}CallsCount = 0\n var {% call swiftifyMethodName method.selectorName %}Called: Bool {\n return {% call swiftifyMethodName method.selectorName %}CallsCount > 0\n }\n {% endif %}\n {% if method.parameters.count == 1 %}\n var {% call swiftifyMethodName method.selectorName %}Received{% for param in method.parameters %}{{ param.name|upperFirstLetter }}: {% if param.isClosure %}({% endif %}{{ param.typeName.unwrappedTypeName }}{% if param.isClosure %}){% endif %}?{% endfor %}\n {% else %}{% if not method.parameters.count == 0 %}\n var {% call swiftifyMethodName method.selectorName %}ReceivedArguments: ({% for param in method.parameters %}{{ param.name }}: {% if param.typeAttributes.escaping %}{{ param.unwrappedTypeName }}{% else %}{{ param.typeName }}{% endif %}{% if not forloop.last %}, {% endif %}{% endfor %})?\n {% endif %}{% endif %}\n {% if not method.returnTypeName.isVoid and not method.isInitializer %}\n var {% call swiftifyMethodName method.selectorName %}ReturnValue: {{ method.returnTypeName }}!\n {% endif %}\n {% call methodClosureDeclaration method %}\n\n{% if method.isInitializer %}\n required {{ method.name }} {\n {% call methodReceivedParameters method %}\n {% call methodClosureName method %}?({% call methodClosureCallParameters method %})\n }\n{% else %}\n func {{ method.name }}{% if method.throws %} throws{% endif %}{% if not method.returnTypeName.isVoid %} -> {{ method.returnTypeName }}{% endif %} {\n {% if method.throws %}\n {% call methodThrowableErrorUsage method %}\n {% endif %}\n {% call swiftifyMethodName method.selectorName %}CallsCount += 1\n {% call methodReceivedParameters method %}\n {% if method.returnTypeName.isVoid %}\n {% if method.throws %}try {% endif %}{% call methodClosureName method %}?({% call methodClosureCallParameters method %})\n {% else %}\n return {% if method.throws %}try {% endif %}{% call methodClosureName method %}.map({ {% if method.throws %}try {% endif %}$0({% call methodClosureCallParameters method %}) }) ?? {% call swiftifyMethodName method.selectorName %}ReturnValue\n {% endif %}\n }\n\n{% endif %}\n{% endmacro %}\n\n{% macro mockOptionalVariable variable %}\n var {% call mockedVariableName variable %}: {{ variable.typeName }}\n{% endmacro %}\n\n{% macro mockNonOptionalArrayOrDictionaryVariable variable %}\n var {% call mockedVariableName variable %}: {{ variable.typeName }} = {% if variable.isArray %}[]{% elif variable.isDictionary %}[:]{% endif %}\n{% endmacro %}\n\n{% macro mockNonOptionalVariable variable %}\n var {% call mockedVariableName variable %}: {{ variable.typeName }} {\n get { return {% call underlyingMockedVariableName variable %} }\n set(value) { {% call underlyingMockedVariableName variable %} = value }\n }\n var {% call underlyingMockedVariableName variable %}: {{ variable.typeName }}!\n{% endmacro %}\n\n{% macro underlyingMockedVariableName variable %}underlying{{ variable.name|upperFirstLetter }}{% endmacro %}\n{% macro mockedVariableName variable %}{{ variable.name }}{% endmacro %}\n\n{% for type in types.protocols where type.name == \"WebSocketClient\" or type.name == \"TimeoutTimer\" %}\nclass {{ type.name }}Mock: {{ type.name }} {\n{% for variable in type.allVariables|!definedInExtension %}\n {% if variable.isOptional %}{% call mockOptionalVariable variable %}{% elif variable.isArray or variable.isDictionary %}{% call mockNonOptionalArrayOrDictionaryVariable variable %}{% else %}{% call mockNonOptionalVariable variable %}{% endif %}\n{% endfor %}\n\n{% for method in type.allMethods|!definedInExtension %}\n {% call mockMethod method %}\n{% endfor %}\n}\n{% endfor %}\n"
}
] ![](\"../img/carat.png\")
\n Channel Class Reference\n ![](\"../../img/carat.png\")
\n Events Enumeration Reference\n ![](\"img/carat.png\")
\n Classes Reference\n ![\"Swift\"](\"https://img.shields.io/badge/Swift-5.0-orange.svg?style=flat\"){kind=icon}
![\"Version\"](\"https://img.shields.io/cocoapods/v/SwiftPhoenixClient.svg?style=flat\")
![\"License\"](\"https://img.shields.io/cocoapods/l/SwiftPhoenixClient.svg?style=flat\")
![\"Platform\"](\"https://img.shields.io/cocoapods/p/SwiftPhoenixClient.svg?style=flat\")
![\"Carthage](\"https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat\"){kind=icon}
![\"Open](\"https://www.codetriage.com/davidstump/swiftphoenixclient/badges/users.svg\")