74 lines
2.7 KiB
Swift
74 lines
2.7 KiB
Swift
//
|
|
// SocketEngineClient.swift
|
|
// Socket.IO-Client-Swift
|
|
//
|
|
// Created by Erik Little on 3/19/15.
|
|
//
|
|
// 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 Foundation
|
|
|
|
/// Declares that a type will be a delegate to an engine.
|
|
@objc public protocol SocketEngineClient {
|
|
// MARK: Methods
|
|
|
|
/// Called when the engine errors.
|
|
///
|
|
/// - parameter reason: The reason the engine errored.
|
|
func engineDidError(reason: String)
|
|
|
|
/// Called when the engine closes.
|
|
///
|
|
/// - parameter reason: The reason that the engine closed.
|
|
func engineDidClose(reason: String)
|
|
|
|
/// Called when the engine opens.
|
|
///
|
|
/// - parameter reason: The reason the engine opened.
|
|
func engineDidOpen(reason: String)
|
|
|
|
/// Called when the engine receives a ping message. Only called in socket.io >3.
|
|
func engineDidReceivePing()
|
|
|
|
/// Called when the engine receives a pong message. Only called in socket.io 2.
|
|
func engineDidReceivePong()
|
|
|
|
/// Called when the engine sends a ping to the server. Only called in socket.io 2.
|
|
func engineDidSendPing()
|
|
|
|
/// Called when the engine sends a pong to the server. Only called in socket.io >3.
|
|
func engineDidSendPong()
|
|
|
|
/// Called when the engine has a message that must be parsed.
|
|
///
|
|
/// - parameter msg: The message that needs parsing.
|
|
func parseEngineMessage(_ msg: String)
|
|
|
|
/// Called when the engine receives binary data.
|
|
///
|
|
/// - parameter data: The data the engine received.
|
|
func parseEngineBinaryData(_ data: Data)
|
|
|
|
/// Called when when upgrading the http connection to a websocket connection.
|
|
///
|
|
/// - parameter headers: The http headers.
|
|
func engineDidWebsocketUpgrade(headers: [String: String])
|
|
}
|