@@ -179,6 +179,8 @@ <h1>SocketIOClient</h1>
179179 </ div >
180180 < p > The main class for SocketIOClientSwift.</ p >
181181
182+ < p > < strong > NOTE</ strong > : The client is not thread/queue safe, all interaction with the socket should be done on the < code > handleQueue</ code > </ p >
183+
182184< p > Represents a socket.io-client. Most interaction with socket.io will be through this class.</ p >
183185
184186 </ div >
@@ -195,33 +197,6 @@ <h3 class="section-name">Properties</h3>
195197 </ a >
196198 </ div >
197199 < ul class ="item-container ">
198- < li class ="item ">
199- < div >
200- < code >
201- < a name ="/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL "> </ a >
202- < a name ="//apple_ref/swift/Property/socketURL " class ="dashAnchor "> </ a >
203- < a class ="token " href ="#/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL "> socketURL</ a >
204- </ code >
205- </ div >
206- < div class ="height-container ">
207- < div class ="pointer-container "> </ div >
208- < section class ="section ">
209- < div class ="pointer "> </ div >
210- < div class ="abstract ">
211- < p > The URL of the socket.io server. This is set in the initializer.</ p >
212-
213- </ div >
214- < div class ="declaration ">
215- < h4 > Declaration</ h4 >
216- < div class ="language ">
217- < p class ="aside-title "> Swift</ p >
218- < pre class ="highlight "> < code > < span class ="kd "> public</ span > < span class ="k "> let</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="kt "> URL</ span > </ code > </ pre >
219-
220- </ div >
221- </ div >
222- </ section >
223- </ div >
224- </ li >
225200 < li class ="item ">
226201 < div >
227202 < code >
@@ -466,6 +441,36 @@ <h4>Declaration</h4>
466441 </ section >
467442 </ div >
468443 </ li >
444+ < li class ="item ">
445+ < div >
446+ < code >
447+ < a name ="/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL "> </ a >
448+ < a name ="//apple_ref/swift/Property/socketURL " class ="dashAnchor "> </ a >
449+ < a class ="token " href ="#/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL "> socketURL</ a >
450+ </ code >
451+ </ div >
452+ < div class ="height-container ">
453+ < div class ="pointer-container "> </ div >
454+ < section class ="section ">
455+ < div class ="pointer "> </ div >
456+ < div class ="abstract ">
457+ < p > The URL of the socket.io server.</ p >
458+
459+ < p > If changed after calling < code > init</ code > , < code > < a href ="../Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient8forceNewSb "> forceNew</ a > </ code > must be set to < code > true</ code > , or it will only connect to the url set in the
460+ init.</ p >
461+
462+ </ div >
463+ < div class ="declaration ">
464+ < h4 > Declaration</ h4 >
465+ < div class ="language ">
466+ < p class ="aside-title "> Swift</ p >
467+ < pre class ="highlight "> < code > < span class ="kd "> public</ span > < span class ="k "> var</ span > < span class ="nv "> socketURL</ span > < span class ="p "> :</ span > < span class ="kt "> URL</ span > </ code > </ pre >
468+
469+ </ div >
470+ </ div >
471+ </ section >
472+ </ div >
473+ </ li >
469474 </ ul >
470475 </ div >
471476 < div class ="task-group ">
@@ -652,7 +657,7 @@ <h4>Declaration</h4>
652657 < h4 > Declaration</ h4 >
653658 < div class ="language ">
654659 < p class ="aside-title "> Swift</ p >
655- < pre class ="highlight "> < code > < span class ="n "> open</ span > < span class ="kd "> func</ span > < span class ="nf "> connect</ span > < span class ="p "> (</ span > < span class ="nv "> timeoutAfter</ span > < span class ="p "> :</ span > < span class ="kt "> Int</ span > < span class ="p "> ,</ span > < span class ="n "> withHandler</ span > < span class ="nv "> handler</ span > < span class ="p "> :</ span > < span class ="p "> (()</ span > < span class ="o "> -></ span > < span class ="kt " > Void </ span > < span class =" p "> )?)</ span > </ code > </ pre >
660+ < pre class ="highlight "> < code > < span class ="n "> open</ span > < span class ="kd "> func</ span > < span class ="nf "> connect</ span > < span class ="p "> (</ span > < span class ="nv "> timeoutAfter</ span > < span class ="p "> :</ span > < span class ="kt "> Int</ span > < span class ="p "> ,</ span > < span class ="n "> withHandler</ span > < span class ="nv "> handler</ span > < span class ="p "> :</ span > < span class ="p "> (()</ span > < span class ="o "> -></ span > < span class ="p "> () )?)</ span > </ code > </ pre >
656661
657662 </ div >
658663 </ div >
@@ -1585,7 +1590,7 @@ <h4>Return Value</h4>
15851590 < h4 > Declaration</ h4 >
15861591 < div class ="language ">
15871592 < p class ="aside-title "> Swift</ p >
1588- < pre class ="highlight "> < code > < span class ="n "> open</ span > < span class ="kd "> func</ span > < span class ="nf "> onAny</ span > < span class ="p "> (</ span > < span class ="n "> _</ span > < span class ="nv "> handler</ span > < span class ="p "> :</ span > < span class ="kd "> @escaping</ span > < span class ="p "> (</ span > < span class ="kt "> < a href ="../Classes/SocketAnyEvent.html "> SocketAnyEvent</ a > </ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="kt " > Void </ span > < span class =" p "> )</ span > </ code > </ pre >
1593+ < pre class ="highlight "> < code > < span class ="n "> open</ span > < span class ="kd "> func</ span > < span class ="nf "> onAny</ span > < span class ="p "> (</ span > < span class ="n "> _</ span > < span class ="nv "> handler</ span > < span class ="p "> :</ span > < span class ="kd "> @escaping</ span > < span class ="p "> (</ span > < span class ="kt "> < a href ="../Classes/SocketAnyEvent.html "> SocketAnyEvent</ a > </ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="p "> () )</ span > </ code > </ pre >
15891594
15901595 </ div >
15911596 </ div >
@@ -1768,7 +1773,7 @@ <h4>Declaration</h4>
17681773 </ article >
17691774 </ div >
17701775 < section class ="footer ">
1771- < p > © 2017 < a class ="link " href ="https://github.com/socketio/socket.io-client-swift " target ="_blank " rel ="external "> Erik</ a > . All rights reserved. (Last updated: 2017-05-27 )</ p >
1776+ < p > © 2017 < a class ="link " href ="https://github.com/socketio/socket.io-client-swift " target ="_blank " rel ="external "> Erik</ a > . All rights reserved. (Last updated: 2017-06-18 )</ p >
17721777 < p > Generated by < a class ="link " href ="https://github.com/realm/jazzy " target ="_blank " rel ="external "> jazzy ♪♫ v0.8.1</ a > , a < a class ="link " href ="http://realm.io " target ="_blank " rel ="external "> Realm</ a > project.</ p >
17731778 </ section >
17741779 </ body >
0 commit comments