Back to Socket Io Client Swift

SocketEngineClient

docs/Protocols/SocketEngineClient.html

16.1.12.9 KB
Original Source

SocketEngineClient

@objc
public protocol SocketEngineClient

Declares that a type will be a delegate to an engine.

Methods

`

                engineDidError(reason:)
                `

Called when the engine errors.

Declaration

Swift

func engineDidError(reason: String)

Parameters

| reason |

The reason the engine errored.

|

`

                engineDidClose(reason:)
                `

Called when the engine closes.

Declaration

Swift

func engineDidClose(reason: String)

Parameters

| reason |

The reason that the engine closed.

|

`

                engineDidOpen(reason:)
                `

Called when the engine opens.

Declaration

Swift

func engineDidOpen(reason: String)

Parameters

| reason |

The reason the engine opened.

|

`

                engineDidReceivePing()
                `

Called when the engine receives a ping message. Only called in socket.io >3.

Declaration

Swift

func engineDidReceivePing()

`

                engineDidReceivePong()
                `

Called when the engine receives a pong message. Only called in socket.io 2.

Declaration

Swift

func engineDidReceivePong()

`

                engineDidSendPing()
                `

Called when the engine sends a ping to the server. Only called in socket.io 2.

Declaration

Swift

func engineDidSendPing()

`

                engineDidSendPong()
                `

Called when the engine sends a pong to the server. Only called in socket.io >3.

Declaration

Swift

func engineDidSendPong()

`

                parseEngineMessage(_:)
                `

Called when the engine has a message that must be parsed.

Declaration

Swift

func parseEngineMessage(_ msg: String)

Parameters

| msg |

The message that needs parsing.

|

`

                parseEngineBinaryData(_:)
                `

Called when the engine receives binary data.

Declaration

Swift

func parseEngineBinaryData(_ data: Data)

Parameters

| data |

The data the engine received.

|

`

                engineDidWebsocketUpgrade(headers:)
                `

Called when when upgrading the http connection to a websocket connection.

Declaration

Swift

func engineDidWebsocketUpgrade(headers: [String : String])

Parameters

| headers |

The http headers.

|