20
20
< header class ="header ">
21
21
< p class ="header-col header-col--primary ">
22
22
< a class ="header-link " href ="index.html ">
23
- SocketIO Docs
23
+ SocketIO 16.0.0-beta2 Docs
24
24
</ a >
25
25
(100% documented)
26
26
</ p >
49
49
< li class ="nav-group-task ">
50
50
< a class ="nav-group-task-link " href ="12to13.html "> 12to13</ a >
51
51
</ li >
52
+ < li class ="nav-group-task ">
53
+ < a class ="nav-group-task-link " href ="15to16.html "> 15to16</ a >
54
+ </ li >
52
55
< li class ="nav-group-task ">
53
56
< a class ="nav-group-task-link " href ="faq.html "> FAQ</ a >
54
57
</ li >
60
63
< li class ="nav-group-task ">
61
64
< a class ="nav-group-task-link " href ="Classes/OnAckCallback.html "> OnAckCallback</ a >
62
65
</ li >
63
- < li class ="nav-group-task ">
64
- < a class ="nav-group-task-link " href ="Classes/SSLSecurity.html "> SSLSecurity</ a >
65
- </ li >
66
66
< li class ="nav-group-task ">
67
67
< a class ="nav-group-task-link " href ="Classes/SocketAckEmitter.html "> SocketAckEmitter</ a >
68
68
</ li >
109
109
</ li >
110
110
</ ul >
111
111
</ li >
112
+ < li class ="nav-group-name ">
113
+ < a class ="nav-group-name-link " href ="Extensions.html "> Extensions</ a >
114
+ < ul class ="nav-group-tasks ">
115
+ < li class ="nav-group-task ">
116
+ < a class ="nav-group-task-link " href ="Extensions.html#/s:Sa "> Array</ a >
117
+ </ li >
118
+ < li class ="nav-group-task ">
119
+ < a class ="nav-group-task-link " href ="Extensions.html#/s:Sb "> Bool</ a >
120
+ </ li >
121
+ < li class ="nav-group-task ">
122
+ < a class ="nav-group-task-link " href ="Extensions.html#/s:10Foundation4DataV "> Data</ a >
123
+ </ li >
124
+ < li class ="nav-group-task ">
125
+ < a class ="nav-group-task-link " href ="Extensions.html#/s:SD "> Dictionary</ a >
126
+ </ li >
127
+ < li class ="nav-group-task ">
128
+ < a class ="nav-group-task-link " href ="Extensions.html#/s:Sd "> Double</ a >
129
+ </ li >
130
+ < li class ="nav-group-task ">
131
+ < a class ="nav-group-task-link " href ="Extensions.html#/s:Si "> Int</ a >
132
+ </ li >
133
+ < li class ="nav-group-task ">
134
+ < a class ="nav-group-task-link " href ="Extensions.html#/c:objc(cs)NSArray "> NSArray</ a >
135
+ </ li >
136
+ < li class ="nav-group-task ">
137
+ < a class ="nav-group-task-link " href ="Extensions.html#/c:objc(cs)NSData "> NSData</ a >
138
+ </ li >
139
+ < li class ="nav-group-task ">
140
+ < a class ="nav-group-task-link " href ="Extensions.html#/c:objc(cs)NSDictionary "> NSDictionary</ a >
141
+ </ li >
142
+ < li class ="nav-group-task ">
143
+ < a class ="nav-group-task-link " href ="Extensions.html#/c:objc(cs)NSNull "> NSNull</ a >
144
+ </ li >
145
+ < li class ="nav-group-task ">
146
+ < a class ="nav-group-task-link " href ="Extensions.html#/c:objc(cs)NSString "> NSString</ a >
147
+ </ li >
148
+ < li class ="nav-group-task ">
149
+ < a class ="nav-group-task-link " href ="Extensions.html#/s:SS "> String</ a >
150
+ </ li >
151
+ </ ul >
152
+ </ li >
112
153
< li class ="nav-group-name ">
113
154
< a class ="nav-group-name-link " href ="Protocols.html "> Protocols</ a >
114
155
< ul class ="nav-group-tasks ">
183
224
< article class ="main-content ">
184
225
185
226
< section class ="section ">
186
- < div class ="section-content ">
227
+ < div class ="section-content top-matter ">
187
228
188
229
< h1 id ='upgrading-from-v12 ' class ='heading '> Upgrading from v12</ h1 >
189
230
@@ -195,8 +236,8 @@ <h2 id='what-are-the-big-changes' class='heading'>What are the big changes?</h2>
195
236
to create multiple clients, and each client had its own engine.</ p >
196
237
197
238
< p > Some v12 code might’ve looked like this:</ p >
198
- < pre class ="highlight swift "> < code > < span class ="k "> let</ span > < span class ="nv "> defaultSocket</ span > < span class ="o "> =</ span > < span class ="nf "> SocketIOClient</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> myURL</ span > < span class ="p "> )</ span >
199
- < span class ="k "> let</ span > < span class ="nv "> namespaceSocket</ span > < span class ="o "> =</ span > < span class ="nf "> SocketIOClient</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> myURL</ span > < span class ="p "> ,</ span > < span class ="nv "> config</ span > < span class ="p "> :</ span > < span class ="p "> [</ span > < span class ="o "> .</ span > < span class ="nf "> nsp</ span > < span class ="p "> (</ span > < span class ="s "> "/swift"</ span > < span class ="p "> )])</ span >
239
+ < pre class ="highlight swift "> < code > < span class ="k "> let</ span > < span class ="nv "> defaultSocket</ span > < span class ="o "> =</ span > < span class ="kt "> SocketIOClient</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> myURL</ span > < span class ="p "> )</ span >
240
+ < span class ="k "> let</ span > < span class ="nv "> namespaceSocket</ span > < span class ="o "> =</ span > < span class ="kt "> SocketIOClient</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> myURL</ span > < span class ="p "> ,</ span > < span class ="nv "> config</ span > < span class ="p "> :</ span > < span class ="p "> [</ span > < span class ="o "> .</ span > < span class ="nf "> nsp</ span > < span class ="p "> (</ span > < span class ="s "> "/swift"</ span > < span class ="p "> )])</ span >
200
241
201
242
< span class ="c1 "> // add handlers for sockets and connect</ span >
202
243
@@ -205,7 +246,7 @@ <h2 id='what-are-the-big-changes' class='heading'>What are the big changes?</h2>
205
246
< p > In v12 this would have opened two connections to the socket.io.</ p >
206
247
207
248
< p > In v13 the same code would look like this:</ p >
208
- < pre class ="highlight swift "> < code > < span class ="k "> let</ span > < span class ="nv "> manager</ span > < span class ="o "> =</ span > < span class ="nf "> SocketManager</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> myURL</ span > < span class ="p "> )</ span >
249
+ < pre class ="highlight swift "> < code > < span class ="k "> let</ span > < span class ="nv "> manager</ span > < span class ="o "> =</ span > < span class ="kt "> SocketManager</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> myURL</ span > < span class ="p "> )</ span >
209
250
< span class ="k "> let</ span > < span class ="nv "> defaultSocket</ span > < span class ="o "> =</ span > < span class ="n "> manager</ span > < span class ="o "> .</ span > < span class ="n "> defaultSocket</ span >
210
251
< span class ="k "> let</ span > < span class ="nv "> namespaceSocket</ span > < span class ="o "> =</ span > < span class ="n "> manager</ span > < span class ="o "> .</ span > < span class ="nf "> socket</ span > < span class ="p "> (</ span > < span class ="nv "> forNamespace</ span > < span class ="p "> :</ span > < span class ="s "> "/swift"</ span > < span class ="p "> )</ span >
211
252
@@ -236,9 +277,9 @@ <h2 id='how-sockets-are-stored' class='heading'>How sockets are stored</h2>
236
277
< p > You should know that < code > < a href ="Classes/SocketIOClient.html "> SocketIOClient</ a > </ code > s no longer need to be held around in properties, but the < code > < a href ="Classes/SocketManager.html "> SocketManager</ a > </ code > should.</ p >
237
278
238
279
< p > One of the most common mistakes people made is not maintaining a strong reference to the client.</ p >
239
- < pre class ="highlight swift "> < code > < span class ="kd "> class</ span > < span class ="nf "> Manager</ span > < span class ="p "> {</ span >
280
+ < pre class ="highlight swift "> < code > < span class ="kd "> class</ span > < span class ="kt "> Manager</ span > < span class ="p "> {</ span >
240
281
< span class ="kd "> func</ span > < span class ="nf "> addHandlers</ span > < span class ="p "> ()</ span > < span class ="p "> {</ span >
241
- < span class ="k "> let</ span > < span class ="nv "> socket</ span > < span class ="o "> =</ span > < span class ="nf "> SocketIOClient</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> myURL</ span > < span class ="p "> ,</ span > < span class ="nv "> config</ span > < span class ="p "> :</ span > < span class ="p "> [</ span > < span class ="o "> .</ span > < span class ="nf "> nsp</ span > < span class ="p "> (</ span > < span class ="s "> "/swift"</ span > < span class ="p "> )])</ span >
282
+ < span class ="k "> let</ span > < span class ="nv "> socket</ span > < span class ="o "> =</ span > < span class ="kt "> SocketIOClient</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> myURL</ span > < span class ="p "> ,</ span > < span class ="nv "> config</ span > < span class ="p "> :</ span > < span class ="p "> [</ span > < span class ="o "> .</ span > < span class ="nf "> nsp</ span > < span class ="p "> (</ span > < span class ="s "> "/swift"</ span > < span class ="p "> )])</ span >
242
283
243
284
< span class ="c1 "> // Add handlers</ span >
244
285
< span class ="p "> }</ span >
@@ -248,8 +289,8 @@ <h2 id='how-sockets-are-stored' class='heading'>How sockets are stored</h2>
248
289
< p > This would have resulted in the client being released and no handlers being called.</ p >
249
290
250
291
< p > A < em > correct</ em > equivalent would be:</ p >
251
- < pre class ="highlight swift "> < code > < span class ="kd "> class</ span > < span class ="nf "> Manager</ span > < span class ="p "> {</ span >
252
- < span class ="k "> let</ span > < span class ="nv "> socketManager</ span > < span class ="o "> =</ span > < span class ="nf "> SocketManager</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> someURL</ span > < span class ="p "> )</ span >
292
+ < pre class ="highlight swift "> < code > < span class ="kd "> class</ span > < span class ="kt "> Manager</ span > < span class ="p "> {</ span >
293
+ < span class ="k "> let</ span > < span class ="nv "> socketManager</ span > < span class ="o "> =</ span > < span class ="kt "> SocketManager</ span > < span class ="p "> (</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="n "> someURL</ span > < span class ="p "> )</ span >
253
294
254
295
< span class ="kd "> func</ span > < span class ="nf "> addHandlers</ span > < span class ="p "> ()</ span > < span class ="p "> {</ span >
255
296
< span class ="k "> let</ span > < span class ="nv "> socket</ span > < span class ="o "> =</ span > < span class ="n "> socketManager</ span > < span class ="o "> .</ span > < span class ="nf "> socket</ span > < span class ="p "> (</ span > < span class ="nv "> forNamespace</ span > < span class ="p "> :</ span > < span class ="s "> "/swift"</ span > < span class ="p "> )</ span >
@@ -268,7 +309,7 @@ <h2 id='how-sockets-are-stored' class='heading'>How sockets are stored</h2>
268
309
< h2 id ='what-to-call-connect-on ' class ='heading '> What to call connect on</ h2 >
269
310
270
311
< p > Connect can either be called on the manager directly, or on one of the sockets made from it. In either case, if the manager
271
- was not already connected to the server, a connection will be made. Also in both cases the default socket (namespace < q > / </ q > )
312
+ was not already connected to the server, a connection will be made. Also in both cases the default socket (namespace “/” )
272
313
will fire a < code > connect</ code > event. </ p >
273
314
274
315
< p > The difference is that if < code > connect()</ code > is just called on the manager, then any sockets for that manager that are not the default
@@ -283,8 +324,8 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
283
324
</ article >
284
325
</ div >
285
326
< section class ="footer ">
286
- < p > © 2019 < a class ="link " href ="https://github.com/socketio/socket.io-client-swift " target ="_blank " rel ="external "> Erik</ a > . All rights reserved. (Last updated: 2019-05-28 )</ p >
287
- < p > Generated by < a class ="link " href ="https://github.com/realm/jazzy " target ="_blank " rel ="external "> jazzy ♪♫ v0.9.4 </ a > , a < a class ="link " href ="https://realm.io " target ="_blank " rel ="external "> Realm</ a > project.</ p >
327
+ < p > © 2020 < a class ="link " href ="https://github.com/socketio/socket.io-client-swift " target ="_blank " rel ="external "> Erik</ a > . All rights reserved. (Last updated: 2020-11-07 )</ p >
328
+ < p > Generated by < a class ="link " href ="https://github.com/realm/jazzy " target ="_blank " rel ="external "> jazzy ♪♫ v0.13.5 </ a > , a < a class ="link " href ="https://realm.io " target ="_blank " rel ="external "> Realm</ a > project.</ p >
288
329
</ section >
289
330
</ body >
290
331
</ div >
0 commit comments