The namespace that this socket is currently connected to.

Must start with a/.

Declaration

publicletnsp:String

A handler that will be called on any event.

Declaration

publicprivate(set)varanyHandler:((SocketAnyEvent)->())?{get}

The array of handlers for this socket.

Declaration

publicprivate(set)varhandlers:[SocketEventHandler]{get}

The manager for this socket.

Declaration

publicprivate(set)weakvarmanager:SocketManagerSpec?{get}

A view into this socket where emits do not check for binary data.

Usage:

socket.rawEmitView.emit("myEvent",myObject)

NOTE: It is not safe to hold on to this view beyond the life of the socket.

Declaration

publicprivate(set)lazyvarrawEmitView:SocketRawView{getset}

The status of this client.

Declaration

publicprivate(set)varstatus:SocketIOStatus{getset}

The id of this socket.io connect. This is different from the sid of the engine.io connection.

Declaration

publicprivate(set)varsid:String?{get}

Type safe way to create a new SocketIOClient.opts can be omitted.

Declaration

publicinit(manager:SocketManagerSpec,nsp:String)

Parameters

Connect to the server. The same as callingconnect(timeoutAfter:withHandler:) with a timeout of 0.

Only call after adding your event listeners, unless you know what you’re doing.

Declaration

openfuncconnect(withPayloadpayload:[String:Any]?=nil)

Parameters

Connect to the server. If we aren’t connected aftertimeoutAfter seconds, thenwithHandler is called.

Only call after adding your event listeners, unless you know what you’re doing.

Declaration

openfuncconnect(withPayloadpayload:[String:Any]?=nil,timeoutAfter:Double,withHandlerhandler:(()->())?)

Parameters

Called when the client connects to a namespace. If the client was created with a namespace upfront,then this is only called when the client connects to that namespace.

Declaration

openfuncdidConnect(toNamespacenamespace:String,payload:[String:Any]?)

Parameters

Called when the client has disconnected from socket.io.

Declaration

openfuncdidDisconnect(reason:String)

Parameters

Disconnects the socket.

This will cause the socket to leave the namespace it is associated to, as well as remove itself from themanager.

Declaration

openfuncdisconnect()

Send an event to the server, with optional data items and optional write completion handler.

If an error occurs trying to transformitems into their socket representation, aSocketClientEvent.errorwill be emitted. The structure of the error data is[eventName, items, theError]

Declaration

openfuncemit(_event:String,_items:SocketData...,completion:(()->())?=nil)

Parameters

Sends a message to the server, requesting an ack.

NOTE: It is up to the server send an ack back, just calling this method does not mean the server will ack.Check that your server’s api will ack the event being sent.

If an error occurs trying to transformitems into their socket representation, aSocketClientEvent.errorwill be emitted. The structure of the error data is[eventName, items, theError]

Example:

socket.emitWithAck("myEvent",1).timingOut(after:1){datain...}

Declaration

openfuncemitWithAck(_event:String,_items:SocketData...)->OnAckCallback

Parameters

Return Value

AnOnAckCallback. You must call thetimingOut(after:) method before the event will be sent.

Call when you wish to tell the server that you’ve received the event forack.

You shouldn’t need to call this directly. Instead use anSocketAckEmitter that comes in an event callback.

Declaration

openfuncemitAck(_ack:Int,withitems:[Any])

Parameters

Called when socket.io has acked one of our emits. Causes the corresponding ack callback to be called.

Declaration

openfunchandleAck(_ack:Int,data:[Any])

Parameters

Called on socket.io specific events.

Declaration

openfunchandleClientEvent(_event:SocketClientEvent,data:[Any])

Parameters

Called when we get an event from socket.io.

Declaration

openfunchandleEvent(_event:String,data:[Any],isInternalMessage:Bool,withAckack:Int=-1)

Parameters

Causes a client to handle a socket.io packet. The namespace for the packet must match the namespace of thesocket.

Declaration

openfunchandlePacket(_packet:SocketPacket)

Parameters

Call when you wish to leave a namespace and disconnect this socket.

Declaration

openfuncleaveNamespace()

Joinsnsp. You shouldn’t need to call this directly, instead callconnect.

Declaration

openfuncjoinNamespace(withPayloadpayload:[String:Any]?=nil)

Parameters

Removes handler(s) for a client event.

If you wish to remove a client event handler, call theoff(id:) with the UUID received from itson call.

Declaration

openfuncoff(clientEventevent:SocketClientEvent)

Parameters

Removes handler(s) based on an event name.

If you wish to remove a specific event, call theoff(id:) with the UUID received from itson call.

Declaration

openfuncoff(_event:String)

Parameters

Removes a handler with the specified UUID gotten from anon oronce

If you want to remove all events for an event, call the offoff(_:) method with the event name.

Declaration

openfuncoff(id:UUID)

Parameters

Adds a handler for an event.

Declaration

@discardableResultopenfuncon(_event:String,callback:@escapingNormalCallback)->UUID

Parameters

Return Value

A unique id for the handler that can be used to remove it.

Adds a handler for a client event.

Example:

socket.on(clientEvent:.connect){data,ackin...}

Declaration

@discardableResultopenfuncon(clientEventevent:SocketClientEvent,callback:@escapingNormalCallback)->UUID

Parameters

Return Value

A unique id for the handler that can be used to remove it.

Adds a single-use handler for a client event.

Declaration

@discardableResultopenfunconce(clientEventevent:SocketClientEvent,callback:@escapingNormalCallback)->UUID

Parameters

Return Value

A unique id for the handler that can be used to remove it.

Adds a single-use handler for an event.

Declaration

@discardableResultopenfunconce(_event:String,callback:@escapingNormalCallback)->UUID

Parameters

Return Value

A unique id for the handler that can be used to remove it.

Adds a handler that will be called on every event.

Declaration

openfunconAny(_handler:@escaping(SocketAnyEvent)->())

Parameters

Removes all handlers.

Can be used after disconnecting to break any potential remaining retain cycles.

Declaration

openfuncremoveAllHandlers()

Puts the socket back into the connecting state.Called when the manager detects a broken connection, or when a manual reconnect is triggered.

Declaration

openfuncsetReconnecting(reason:String)

Parameters