77 lines
2.8 KiB
Swift
77 lines
2.8 KiB
Swift
//
|
|
// SocketIOClientSpec.swift
|
|
// Socket.IO-Client-Swift
|
|
//
|
|
// Created by Erik Little on 1/3/16.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
import Dispatch
|
|
|
|
protocol SocketIOClientSpec : class {
|
|
var handleQueue: DispatchQueue { get set }
|
|
var nsp: String { get set }
|
|
var waitingPackets: [SocketPacket] { get set }
|
|
|
|
func didConnect(toNamespace namespace: String)
|
|
func didDisconnect(reason: String)
|
|
func didError(reason: String)
|
|
func handleAck(_ ack: Int, data: [Any])
|
|
func handleEvent(_ event: String, data: [Any], isInternalMessage: Bool, withAck ack: Int)
|
|
func handleClientEvent(_ event: SocketClientEvent, data: [Any])
|
|
func joinNamespace(_ namespace: String)
|
|
}
|
|
|
|
extension SocketIOClientSpec {
|
|
func didError(reason: String) {
|
|
DefaultSocketLogger.Logger.error("%@", type: "SocketIOClient", args: reason)
|
|
|
|
handleClientEvent(.error, data: [reason])
|
|
}
|
|
}
|
|
|
|
/// The set of events that are generated by the client.
|
|
public enum SocketClientEvent : String {
|
|
/// Emitted when the client connects. This is also called on a successful reconnection. A connect event gets one
|
|
/// data item: the namespace that was connected to.
|
|
///
|
|
/// ```swift
|
|
/// socket.on(clientEvent: .connect) {data, ack in
|
|
/// guard let nsp = data[0] as? String else { return }
|
|
/// // Some logic using the nsp
|
|
/// }
|
|
/// ```
|
|
case connect
|
|
|
|
/// Called when the socket has disconnected and will not attempt to try to reconnect.
|
|
case disconnect
|
|
|
|
/// Called when an error occurs.
|
|
case error
|
|
|
|
/// Called when the client begins the reconnection process.
|
|
case reconnect
|
|
|
|
/// Called each time the client tries to reconnect to the server.
|
|
case reconnectAttempt
|
|
|
|
/// Called every time there is a change in the client's status.
|
|
case statusChange
|
|
}
|