PusherConnection Class Reference

url

Undocumented

Declaration

Swift

public let url: String

Show on GitHub

key

Undocumented

Declaration

Swift

public let key: String

Show on GitHub


                    
                    
                    options

Undocumented

Declaration

Swift

open var options: PusherClientOptions

Show on GitHub


                    
                    
                    globalChannel

Undocumented

Declaration

Swift

open var globalChannel: GlobalChannel!

Show on GitHub


                    
                    
                    socketId

Undocumented

Declaration

Swift

open var socketId: String?

Show on GitHub


                    
                    
                    connectionState

Undocumented

Declaration

Swift

open var connectionState: ConnectionState

Show on GitHub


                    
                    
                    channels

Undocumented

Declaration

Swift

open var channels: PusherChannels

Show on GitHub


                    
                    
                    socket

Undocumented

Declaration

Swift

open var socket: NWWebSocket!

Show on GitHub


                    
                    
                    URLSession

Undocumented

Declaration

Swift

open var URLSession: Foundation.URLSession

Show on GitHub


                    
                    
                    userDataFetcher

Undocumented

Declaration

Swift

open var userDataFetcher: (() -> PusherPresenceChannelMember)?

Show on GitHub


                    
                    
                    reconnectAttemptsMax

Undocumented

Declaration

Swift

open var reconnectAttemptsMax: Int?

Show on GitHub


                    
                    
                    reconnectAttempts

Undocumented

Declaration

Swift

open var reconnectAttempts: Int

Show on GitHub


                    
                    
                    maxReconnectGapInSeconds

Undocumented

Declaration

Swift

open var maxReconnectGapInSeconds: Double?

Show on GitHub


                    
                    
                    delegate

Undocumented

Declaration

Swift

open weak var delegate: PusherDelegate? { get set }

Show on GitHub


                    
                    
                    pongResponseTimeoutInterval

Undocumented

Declaration

Swift

open var pongResponseTimeoutInterval: TimeInterval

Show on GitHub


                    
                    
                    activityTimeoutInterval

Undocumented

Declaration

Swift

open var activityTimeoutInterval: TimeInterval

Show on GitHub


                    
                    
                    init(key:socket:url:options:URLSession:)

Initializes a new PusherConnection with an app key, websocket, URL, options and URLSession

Declaration

Swift

public init(
    key: String,
    socket: NWWebSocket,
    url: String,
    options: PusherClientOptions,
    URLSession: Foundation.URLSession = Foundation.URLSession.shared
)

Parameters

`key`	The Pusher app key
`socket`	The websocket object
`url`	The URL the connection is made to
`options`	A PusherClientOptions instance containing all of the user-specified client options
`URLSession`	An NSURLSession instance for the connection to use for making authentication requests

Return Value

A new PusherConnection instance

Show on GitHub


                    
                    
                    sendEvent(event:data:channel:)

Either writes a string directly to the websocket with the given event name and data, or calls a client event to be sent if the event is prefixed with “client”

Declaration

Swift

open func sendEvent(event: String, data: Any, channel: PusherChannel? = nil)

Parameters

`event`	The name of the event
`data`	The data to be stringified and sent
`channel`	The name of the channel

Show on GitHub


                    
                    
                    disconnect()

Disconnects the websocket

Declaration

Swift

open func disconnect()

Show on GitHub


                    
                    
                    connect()

Establish a websocket connection

Declaration

Swift

open func connect()

Show on GitHub


                    
                    
                    handleError(error:)

Handles incoming error

Declaration

Swift

open func handleError(error: PusherError)

Parameters


                                error

The incoming error to be processed

Show on GitHub


                    
                    
                    handleEvent(event:)

Handles incoming events and passes them on to be handled by the appropriate function

Declaration

Swift

open func handleEvent(event: PusherEvent)

Parameters


                                event

The incoming event to be processed

Show on GitHub


                    
                    
                    webSocketDidReceiveMessage(connection:string:)

Delegate method called when a message is received over a websocket

Declaration

Swift

public func webSocketDidReceiveMessage(connection: WebSocketConnection, string: String)

Parameters

`connection`	The websocket that has received the message
`string`	The message received over the websocket

Show on GitHub


                    
                    
                    webSocketDidReceivePong(connection:)

Delegate method called when a pong is received over a websocket

Declaration

Swift

public func webSocketDidReceivePong(connection: WebSocketConnection)

Parameters


                                connection

The websocket that has received the pong

Show on GitHub


                    
                    
                    webSocketDidDisconnect(connection:closeCode:reason:)

Delegate method called when a websocket disconnected

Declaration

Swift

public func webSocketDidDisconnect(connection: WebSocketConnection,
                                   closeCode: NWProtocolWebSocket.CloseCode,
                                   reason: Data?)

Parameters

`connection`	The websocket that disconnected
`closeCode`	The closure code for the websocket connection.
`reason`	Optional further information on the connection closure.

Show on GitHub


                    
                    
                    webSocketViabilityDidChange(connection:isViable:)

Declaration

Swift

public func webSocketViabilityDidChange(connection: WebSocketConnection, isViable: Bool)

Show on GitHub


                    
                    
                    webSocketDidAttemptBetterPathMigration(result:)

Declaration

Swift

public func webSocketDidAttemptBetterPathMigration(result: Result<WebSocketConnection, NWError>)

Show on GitHub


                    
                    
                    webSocketDidConnect(connection:)

Delegate method called when a websocket connected

Declaration

Swift

public func webSocketDidConnect(connection: WebSocketConnection)

Parameters


                                connection

The websocket that connected

Show on GitHub


                    
                    
                    webSocketDidReceiveMessage(connection:data:)

Declaration

Swift

public func webSocketDidReceiveMessage(connection: WebSocketConnection, data: Data)

Show on GitHub


                    
                    
                    webSocketDidReceiveError(connection:error:)

Declaration

Swift

public func webSocketDidReceiveError(connection: WebSocketConnection, error: NWError)

Show on GitHub


                    
                    
                    OCReconnectAttemptsMax

Undocumented

Declaration

Swift

var OCReconnectAttemptsMax: NSNumber? { get set }

Show on GitHub


                    
                    
                    OCMaxReconnectGapInSeconds

Undocumented

Declaration

Swift

var OCMaxReconnectGapInSeconds: NSNumber? { get set }

Show on GitHub