docs/Classes/SocketEngine.html
open class SocketEngine:
NSObject, WebSocketDelegate, URLSessionDelegate, SocketEnginePollable, SocketEngineWebsocket, ConfigSettable
The class that handles the engine.io protocol and transports. See SocketEnginePollable and SocketEngineWebsocket for transport specific methods.
Properties
`
engineQueue
`
The queue that all engine actions take place on.
Swift
public let engineQueue: DispatchQueue
`
connectParams
`
The connect parameters sent during a connect.
Swift
public var connectParams: [String : Any]? { get set }
`
extraHeaders
`
A dictionary of extra http headers that will be set during connection.
Swift
public var extraHeaders: [String : String]?
`
postWait
`
A queue of engine.io messages waiting for POSTing
You should not touch this directly
Swift
public var postWait: [Post]
`
waitingForPoll
`
true if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to disconnect us.
Do not touch this directly
Swift
public var waitingForPoll: Bool
`
waitingForPost
`
true if there is an outstanding post. Trying to post before the first is done will cause socket.io to disconnect us.
Do not touch this directly
Swift
public var waitingForPost: Bool
`
closed
`
true if this engine is closed.
Swift
public private(set) var closed: Bool { get }
`
compress
`
If true the engine will attempt to use WebSocket compression.
Swift
public private(set) var compress: Bool { get }
`
connected
`
true if this engine is connected. Connected means that the initial poll connect has succeeded.
Swift
public private(set) var connected: Bool { get }
`
cookies
`
An array of HTTPCookies that are sent during the connection.
Swift
public private(set) var cookies: [HTTPCookie]? { get }
`
fastUpgrade
`
When true, the engine is in the process of switching to WebSockets.
Do not touch this directly
Swift
public private(set) var fastUpgrade: Bool { get }
`
forcePolling
`
When true, the engine will only use HTTP long-polling as a transport.
Swift
public private(set) var forcePolling: Bool { get }
`
forceWebsockets
`
When true, the engine will only use WebSockets as a transport.
Swift
public private(set) var forceWebsockets: Bool { get }
`
invalidated
`
true If engine’s session has been invalidated.
Swift
public private(set) var invalidated: Bool { get }
`
polling
`
If true, the engine is currently in HTTP long-polling mode.
Swift
public private(set) var polling: Bool { get }
`
probing
`
If true, the engine is currently seeing whether it can upgrade to WebSockets.
Swift
public private(set) var probing: Bool { get }
`
session
`
The URLSession that will be used for polling.
Swift
public private(set) var session: URLSession? { get }
`
sid
`
The session id for this engine.
Swift
public private(set) var sid: String { get }
`
socketPath
`
The path to engine.io.
Swift
public private(set) var socketPath: String { get }
`
urlPolling
`
The url for polling.
Swift
public private(set) var urlPolling: URL { get }
`
urlWebSocket
`
The url for WebSockets.
Swift
public private(set) var urlWebSocket: URL { get }
`
version
`
The version of engine.io being used. Default is three.
Swift
public private(set) var version: SocketIOVersion { get }
`
websocket
`
If true, then the engine is currently in WebSockets mode.
Swift
@available(*, deprecated, message: "No longer needed, if we're not polling, then we must be doing websockets")
public private(set) var websocket: Bool { get }
`
enableSOCKSProxy
`
When true, the WebSocket stream will be configured with the enableSOCKSProxy true.
Swift
public private(set) var enableSOCKSProxy: Bool { get }
`
ws
`
The WebSocket for this engine.
Swift
public private(set) var ws: WebSocket? { get }
`
wsConnected
`
Whether or not the WebSocket is currently connected.
Swift
public private(set) var wsConnected: Bool { get }
`
client
`
The client for this engine.
Swift
public weak var client: SocketEngineClient?
Initializers
`
init(client:url:config:)
`
Creates a new engine.
Swift
public init(client: SocketEngineClient, url: URL, config: SocketIOClientConfiguration)
| client |
The client for this engine.
|
| url |
The url for this engine.
|
| config |
An array of configuration options for this engine.
|
`
init(client:url:options:)
`
Creates a new engine.
Swift
public required convenience init(client: SocketEngineClient, url: URL, options: [String : Any]?)
| client |
The client for this engine.
|
| url |
The url for this engine.
|
| options |
The options for this engine.
|
Methods
`
connect()
`
Starts the connection to the server.
Swift
open func connect()
`
didError(reason:)
`
Called when an error happens during execution. Causes a disconnection.
Swift
open func didError(reason: String)
`
disconnect(reason:)
`
Disconnects from the server.
Swift
open func disconnect(reason: String)
| reason |
The reason for the disconnection. This is communicated up to the client.
|
`
doFastUpgrade()
`
Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in WebSocket mode.
You shouldn’t call this directly
Swift
open func doFastUpgrade()
`
flushWaitingForPostToWebSocket()
`
Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when the engine is attempting to upgrade to WebSocket it does not do any POSTing.
You shouldn’t call this directly
Swift
open func flushWaitingForPostToWebSocket()
`
parseEngineData(_:)
`
Parses raw binary received from engine.io.
Swift
open func parseEngineData(_ data: Data)
| data |
The data to parse.
|
`
parseEngineMessage(_:)
`
Parses a raw engine.io packet.
Swift
open func parseEngineMessage(_ message: String)
| message |
The message to parse.
|
`
setConfigs(_:)
`
Called when the engine should set/update its configs from a given configuration.
parameter config: The SocketIOClientConfiguration that should be used to set/update configs.
Swift
open func setConfigs(_ config: SocketIOClientConfiguration)
`
write(_:withType:withData:completion:)
`
Writes a message to engine.io, independent of transport.
Swift
open func write(_ msg: String, withType type: SocketEnginePacketType, withData data: [Data], completion: (() -> ())? = nil)
| msg |
The message to send.
|
| type |
The type of this message.
|
| data |
Any data that this message has.
|
| completion |
Callback called on transport write completion.
|
URLSessionDelegate methods
`
URLSession(session:didBecomeInvalidWithError:)
`
Delegate called when the session becomes invalid.
Swift
public func URLSession(session: URLSession, didBecomeInvalidWithError error: NSError?)
`
didReceive(event:client:)
`
Delegate method for WebSocketDelegate.
Swift
public func didReceive(event: WebSocketEvent, client _: WebSocket)
| event |
WS Event
|
| _ |
|