1641 lines
		
	
	
		
			83 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			1641 lines
		
	
	
		
			83 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE html>
 | 
						||
<html lang="en">
 | 
						||
  <head>
 | 
						||
    <title>SocketEngine Class Reference</title>
 | 
						||
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
 | 
						||
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
 | 
						||
    <meta charset="utf-8">
 | 
						||
    <script src="../js/jquery.min.js" defer></script>
 | 
						||
    <script src="../js/jazzy.js" defer></script>
 | 
						||
    
 | 
						||
    <script src="../js/lunr.min.js" defer></script>
 | 
						||
    <script src="../js/typeahead.jquery.js" defer></script>
 | 
						||
    <script src="../js/jazzy.search.js" defer></script>
 | 
						||
  </head>
 | 
						||
  <body>
 | 
						||
 | 
						||
    <a name="//apple_ref/swift/Class/SocketEngine" class="dashAnchor"></a>
 | 
						||
 | 
						||
    <a title="SocketEngine Class Reference"></a>
 | 
						||
 | 
						||
    <header class="header">
 | 
						||
      <p class="header-col header-col--primary">
 | 
						||
        <a class="header-link" href="../index.html">
 | 
						||
          SocketIO 16.0.0-beta2 Docs
 | 
						||
        </a>
 | 
						||
         (100% documented)
 | 
						||
      </p>
 | 
						||
    
 | 
						||
      <p class="header-col--secondary">
 | 
						||
        <form role="search" action="../search.json">
 | 
						||
          <input type="text" placeholder="Search documentation" data-typeahead>
 | 
						||
        </form>
 | 
						||
      </p>
 | 
						||
    
 | 
						||
    
 | 
						||
    </header>
 | 
						||
 | 
						||
    <p class="breadcrumbs">
 | 
						||
      <a class="breadcrumb" href="../index.html">SocketIO Reference</a>
 | 
						||
      <img class="carat" src="../img/carat.png" />
 | 
						||
      SocketEngine Class Reference
 | 
						||
    </p>
 | 
						||
 | 
						||
    <div class="content-wrapper">
 | 
						||
      <nav class="navigation">
 | 
						||
        <ul class="nav-groups">
 | 
						||
          <li class="nav-group-name">
 | 
						||
            <a class="nav-group-name-link" href="../Guides.html">Guides</a>
 | 
						||
            <ul class="nav-group-tasks">
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../12to13.html">12to13</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../15to16.html">15to16</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../faq.html">FAQ</a>
 | 
						||
              </li>
 | 
						||
            </ul>
 | 
						||
          </li>
 | 
						||
          <li class="nav-group-name">
 | 
						||
            <a class="nav-group-name-link" href="../Classes.html">Classes</a>
 | 
						||
            <ul class="nav-group-tasks">
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Classes/SocketAnyEvent.html">SocketAnyEvent</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Classes/SocketEngine.html">SocketEngine</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Classes/SocketIOClient.html">SocketIOClient</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Classes/SocketManager.html">SocketManager</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Classes/SocketRawAckView.html">SocketRawAckView</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Classes/SocketRawView.html">SocketRawView</a>
 | 
						||
              </li>
 | 
						||
            </ul>
 | 
						||
          </li>
 | 
						||
          <li class="nav-group-name">
 | 
						||
            <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
 | 
						||
            <ul class="nav-group-tasks">
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Enums/SocketAckStatus.html">SocketAckStatus</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Enums/SocketClientEvent.html">SocketClientEvent</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Enums/SocketEnginePacketType.html">SocketEnginePacketType</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Enums/SocketIOClientOption.html">SocketIOClientOption</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Enums/SocketIOStatus.html">SocketIOStatus</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Enums/SocketIOVersion.html">SocketIOVersion</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Enums/SocketParsableError.html">SocketParsableError</a>
 | 
						||
              </li>
 | 
						||
            </ul>
 | 
						||
          </li>
 | 
						||
          <li class="nav-group-name">
 | 
						||
            <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
 | 
						||
            <ul class="nav-group-tasks">
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
 | 
						||
              </li>
 | 
						||
            </ul>
 | 
						||
          </li>
 | 
						||
          <li class="nav-group-name">
 | 
						||
            <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
 | 
						||
            <ul class="nav-group-tasks">
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/ConfigSettable.html">ConfigSettable</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketData.html">SocketData</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketDataBufferable.html">SocketDataBufferable</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketEngineClient.html">SocketEngineClient</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketEnginePollable.html">SocketEnginePollable</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketIOClientSpec.html">SocketIOClientSpec</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketLogger.html">SocketLogger</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketManagerSpec.html">SocketManagerSpec</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Protocols/SocketParsable.html">SocketParsable</a>
 | 
						||
              </li>
 | 
						||
            </ul>
 | 
						||
          </li>
 | 
						||
          <li class="nav-group-name">
 | 
						||
            <a class="nav-group-name-link" href="../Structs.html">Structures</a>
 | 
						||
            <ul class="nav-group-tasks">
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Structs/SocketEventHandler.html">SocketEventHandler</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Structs/SocketPacket.html">SocketPacket</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Structs/SocketPacket/PacketType.html">– PacketType</a>
 | 
						||
              </li>
 | 
						||
            </ul>
 | 
						||
          </li>
 | 
						||
          <li class="nav-group-name">
 | 
						||
            <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
 | 
						||
            <ul class="nav-group-tasks">
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO14NormalCallbacka">NormalCallback</a>
 | 
						||
              </li>
 | 
						||
              <li class="nav-group-task">
 | 
						||
                <a class="nav-group-task-link" href="../Typealiases.html#/s:8SocketIO4Posta">Post</a>
 | 
						||
              </li>
 | 
						||
            </ul>
 | 
						||
          </li>
 | 
						||
        </ul>
 | 
						||
      </nav>
 | 
						||
      <article class="main-content">
 | 
						||
 | 
						||
        <section class="section">
 | 
						||
          <div class="section-content top-matter">
 | 
						||
            <h1>SocketEngine</h1>
 | 
						||
              <div class="declaration">
 | 
						||
                <div class="language">
 | 
						||
                  
 | 
						||
                  <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SocketEngine</span><span class="p">:</span>
 | 
						||
        <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">WebSocketDelegate</span><span class="p">,</span> <span class="kt">URLSessionDelegate</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketEnginePollable.html">SocketEnginePollable</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/ConfigSettable.html">ConfigSettable</a></span></code></pre>
 | 
						||
 | 
						||
                </div>
 | 
						||
              </div>
 | 
						||
            <p>The class that handles the engine.io protocol and transports.
 | 
						||
See <code><a href="../Protocols/SocketEnginePollable.html">SocketEnginePollable</a></code> and <code><a href="../Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a></code> for transport specific methods.</p>
 | 
						||
 | 
						||
          </div>
 | 
						||
        </section>
 | 
						||
 | 
						||
        <section class="section">
 | 
						||
          <div class="section-content">
 | 
						||
            <div class="task-group">
 | 
						||
              <div class="task-name-container">
 | 
						||
                <a name="/Properties"></a>
 | 
						||
                <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
 | 
						||
                <div class="section-name-container">
 | 
						||
                  <a class="section-name-link" href="#/Properties"></a>
 | 
						||
                  <h3 class="section-name"><p>Properties</p>
 | 
						||
</h3>
 | 
						||
                </div>
 | 
						||
              </div>
 | 
						||
              <ul class="item-container">
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC11engineQueueSo17OS_dispatch_queueCvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/engineQueue" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC11engineQueueSo17OS_dispatch_queueCvp">engineQueue</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The queue that all engine actions take place on.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">engineQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC13connectParamsSDySSypGSgvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/connectParams" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC13connectParamsSDySSypGSgvp">connectParams</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The connect parameters sent during a connect.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">connectParams</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC12extraHeadersSDyS2SGSgvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/extraHeaders" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC12extraHeadersSDyS2SGSgvp">extraHeaders</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>A dictionary of extra http headers that will be set during connection.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">extraHeaders</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">String</span><span class="p">]?</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC8postWaitSaySS3msg_yycSg10completiontGvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/postWait" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC8postWaitSaySS3msg_yycSg10completiontGvp">postWait</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>A queue of engine.io messages waiting for POSTing</p>
 | 
						||
 | 
						||
<p><strong>You should not touch this directly</strong></p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">postWait</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Typealiases.html#/s:8SocketIO4Posta">Post</a></span><span class="p">]</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC14waitingForPollSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/waitingForPoll" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC14waitingForPollSbvp">waitingForPoll</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p><code>true</code> if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to
 | 
						||
disconnect us.</p>
 | 
						||
 | 
						||
<p><strong>Do not touch this directly</strong></p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">waitingForPoll</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC14waitingForPostSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/waitingForPost" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC14waitingForPostSbvp">waitingForPost</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p><code>true</code> if there is an outstanding post. Trying to post before the first is done will cause socket.io to
 | 
						||
disconnect us.</p>
 | 
						||
 | 
						||
<p><strong>Do not touch this directly</strong></p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">waitingForPost</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC6closedSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/closed" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC6closedSbvp">closed</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p><code>true</code> if this engine is closed.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">closed</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC8compressSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/compress" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC8compressSbvp">compress</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>If <code>true</code> the engine will attempt to use WebSocket compression.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">compress</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC9connectedSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/connected" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC9connectedSbvp">connected</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p><code>true</code> if this engine is connected. Connected means that the initial poll connect has succeeded.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">connected</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC7cookiesSaySo12NSHTTPCookieCGSgvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/cookies" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC7cookiesSaySo12NSHTTPCookieCGSgvp">cookies</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>An array of HTTPCookies that are sent during the connection.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">cookies</span><span class="p">:</span> <span class="p">[</span><span class="kt">HTTPCookie</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC11fastUpgradeSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/fastUpgrade" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC11fastUpgradeSbvp">fastUpgrade</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>When <code>true</code>, the engine is in the process of switching to WebSockets.</p>
 | 
						||
 | 
						||
<p><strong>Do not touch this directly</strong></p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">fastUpgrade</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC12forcePollingSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/forcePolling" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC12forcePollingSbvp">forcePolling</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>When <code>true</code>, the engine will only use HTTP long-polling as a transport.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">forcePolling</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC15forceWebsocketsSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/forceWebsockets" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC15forceWebsocketsSbvp">forceWebsockets</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>When <code>true</code>, the engine will only use WebSockets as a transport.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">forceWebsockets</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC11invalidatedSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/invalidated" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC11invalidatedSbvp">invalidated</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p><code>true</code> If engine’s session has been invalidated.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">invalidated</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC7pollingSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/polling" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC7pollingSbvp">polling</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>If <code>true</code>, the engine is currently in HTTP long-polling mode.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">polling</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC7probingSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/probing" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC7probingSbvp">probing</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>If <code>true</code>, the engine is currently seeing whether it can upgrade to WebSockets.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">probing</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC7sessionSo12NSURLSessionCSgvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/session" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC7sessionSo12NSURLSessionCSgvp">session</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The URLSession that will be used for polling.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC3sidSSvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/sid" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC3sidSSvp">sid</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The session id for this engine.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">sid</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC10socketPathSSvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/socketPath" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC10socketPathSSvp">socketPath</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The path to engine.io.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">socketPath</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC10urlPolling10Foundation3URLVvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/urlPolling" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC10urlPolling10Foundation3URLVvp">urlPolling</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The url for polling.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">urlPolling</span><span class="p">:</span> <span class="kt">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC06urlWebA010Foundation3URLVvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/urlWebSocket" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC06urlWebA010Foundation3URLVvp">urlWebSocket</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The url for WebSockets.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">urlWebSocket</span><span class="p">:</span> <span class="kt">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC7versionAA0A9IOVersionOvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/version" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC7versionAA0A9IOVersionOvp">version</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The version of engine.io being used. Default is three.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">version</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketIOVersion.html">SocketIOVersion</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC9websocketSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/websocket" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC9websocketSbvp">websocket</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>If <code>true</code>, then the engine is currently in WebSockets mode.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"No longer needed, if we're not polling, then we must be doing websockets"</span><span class="p">)</span>
 | 
						||
<span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">websocket</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC16enableSOCKSProxySbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/enableSOCKSProxy" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC16enableSOCKSProxySbvp">enableSOCKSProxy</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>When <code>true</code>, the WebSocket <code>stream</code> will be configured with the enableSOCKSProxy <code>true</code>.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">enableSOCKSProxy</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC2ws10Starscream03WebA0CSgvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/ws" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC2ws10Starscream03WebA0CSgvp">ws</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The WebSocket for this engine.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">ws</span><span class="p">:</span> <span class="kt">WebSocket</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC11wsConnectedSbvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/wsConnected" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC11wsConnectedSbvp">wsConnected</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Whether or not the WebSocket is currently connected.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">wsConnected</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC6clientAA0aC6Client_pSgvp"></a>
 | 
						||
                    <a name="//apple_ref/swift/Property/client" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC6clientAA0aC6Client_pSgvp">client</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>The client for this engine.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">client</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">?</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
              </ul>
 | 
						||
            </div>
 | 
						||
            <div class="task-group">
 | 
						||
              <div class="task-name-container">
 | 
						||
                <a name="/Initializers"></a>
 | 
						||
                <a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a>
 | 
						||
                <div class="section-name-container">
 | 
						||
                  <a class="section-name-link" href="#/Initializers"></a>
 | 
						||
                  <h3 class="section-name"><p>Initializers</p>
 | 
						||
</h3>
 | 
						||
                </div>
 | 
						||
              </div>
 | 
						||
              <ul class="item-container">
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/init(client:url:config:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc">init(client:<wbr>url:<wbr>config:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Creates a new engine.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a></span><span class="p">)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                      <div>
 | 
						||
                        <h4>Parameters</h4>
 | 
						||
                        <table class="graybox">
 | 
						||
                          <tbody>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>client</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The client for this engine.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>url</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The url for this engine.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>config</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>An array of configuration options for this engine.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                          </tbody>
 | 
						||
                        </table>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC6client3url7optionsAcA0aC6Client_p_10Foundation3URLVSDySSypGSgtcfc"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/init(client:url:options:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC6client3url7optionsAcA0aC6Client_p_10Foundation3URLVSDySSypGSgtcfc">init(client:<wbr>url:<wbr>options:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Creates a new engine.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">required</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                      <div>
 | 
						||
                        <h4>Parameters</h4>
 | 
						||
                        <table class="graybox">
 | 
						||
                          <tbody>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>client</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The client for this engine.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>url</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The url for this engine.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>options</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The options for this engine.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                          </tbody>
 | 
						||
                        </table>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
              </ul>
 | 
						||
            </div>
 | 
						||
            <div class="task-group">
 | 
						||
              <div class="task-name-container">
 | 
						||
                <a name="/Methods"></a>
 | 
						||
                <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
 | 
						||
                <div class="section-name-container">
 | 
						||
                  <a class="section-name-link" href="#/Methods"></a>
 | 
						||
                  <h3 class="section-name"><p>Methods</p>
 | 
						||
</h3>
 | 
						||
                </div>
 | 
						||
              </div>
 | 
						||
              <ul class="item-container">
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC7connectyyF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC7connectyyF">connect()</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Starts the connection to the server.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">connect</span><span class="p">()</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC8didError6reasonySS_tF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/didError(reason:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC8didError6reasonySS_tF">didError(reason:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Called when an error happens during execution. Causes a disconnection.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">didError</span><span class="p">(</span><span class="nv">reason</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC10disconnect6reasonySS_tF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/disconnect(reason:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC10disconnect6reasonySS_tF">disconnect(reason:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Disconnects from the server.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">disconnect</span><span class="p">(</span><span class="nv">reason</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                      <div>
 | 
						||
                        <h4>Parameters</h4>
 | 
						||
                        <table class="graybox">
 | 
						||
                          <tbody>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>reason</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The reason for the disconnection. This is communicated up to the client.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                          </tbody>
 | 
						||
                        </table>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC13doFastUpgradeyyF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/doFastUpgrade()" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC13doFastUpgradeyyF">doFastUpgrade()</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in
 | 
						||
WebSocket mode.</p>
 | 
						||
 | 
						||
<p><strong>You shouldn’t call this directly</strong></p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">doFastUpgrade</span><span class="p">()</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC024flushWaitingForPostToWebA0yyF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/flushWaitingForPostToWebSocket()" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC024flushWaitingForPostToWebA0yyF">flushWaitingForPostToWebSocket()</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when
 | 
						||
the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
 | 
						||
 | 
						||
<p><strong>You shouldn’t call this directly</strong></p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">flushWaitingForPostToWebSocket</span><span class="p">()</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC05parseC4Datayy10Foundation0E0VF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/parseEngineData(_:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC05parseC4Datayy10Foundation0E0VF">parseEngineData(_:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Parses raw binary received from engine.io.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">parseEngineData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                      <div>
 | 
						||
                        <h4>Parameters</h4>
 | 
						||
                        <table class="graybox">
 | 
						||
                          <tbody>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>data</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The data to parse.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                          </tbody>
 | 
						||
                        </table>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC05parseC7MessageyySSF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC05parseC7MessageyySSF">parseEngineMessage(_:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Parses a raw engine.io packet.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">parseEngineMessage</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                      <div>
 | 
						||
                        <h4>Parameters</h4>
 | 
						||
                        <table class="graybox">
 | 
						||
                          <tbody>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>message</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The message to parse.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                          </tbody>
 | 
						||
                        </table>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/setConfigs(_:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF">setConfigs(_:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Called when the engine should set/update its configs from a given configuration.</p>
 | 
						||
 | 
						||
<p>parameter config: The <code><a href="../Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a></code> that should be used to set/update configs.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">setConfigs</span><span class="p">(</span><span class="n">_</span> <span class="nv">config</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a></span><span class="p">)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC5write_8withType0E4Data10completionySS_AA0ac6PacketF0OSay10Foundation0G0VGyycSgtF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/write(_:withType:withData:completion:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC5write_8withType0E4Data10completionySS_AA0ac6PacketF0OSay10Foundation0G0VGyycSgtF">write(_:<wbr>withType:<wbr>withData:<wbr>completion:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Writes a message to engine.io, independent of transport.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">write</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">withType</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketEnginePacketType.html">SocketEnginePacketType</a></span><span class="p">,</span> <span class="n">withData</span> <span class="nv">data</span><span class="p">:</span> <span class="p">[</span><span class="kt">Data</span><span class="p">],</span> <span class="nv">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-></span> <span class="p">())?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                      <div>
 | 
						||
                        <h4>Parameters</h4>
 | 
						||
                        <table class="graybox">
 | 
						||
                          <tbody>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>msg</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The message to send.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>type</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>The type of this message.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>data</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>Any data that this message has.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>completion</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>Callback called on transport write completion.</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                          </tbody>
 | 
						||
                        </table>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
              </ul>
 | 
						||
            </div>
 | 
						||
            <div class="task-group">
 | 
						||
              <div class="task-name-container">
 | 
						||
                <a name="/URLSessionDelegate%20methods"></a>
 | 
						||
                <a name="//apple_ref/swift/Section/URLSessionDelegate methods" class="dashAnchor"></a>
 | 
						||
                <div class="section-name-container">
 | 
						||
                  <a class="section-name-link" href="#/URLSessionDelegate%20methods"></a>
 | 
						||
                  <h3 class="section-name"><p>URLSessionDelegate methods</p>
 | 
						||
</h3>
 | 
						||
                </div>
 | 
						||
              </div>
 | 
						||
              <ul class="item-container">
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/URLSession(session:didBecomeInvalidWithError:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF">URLSession(session:<wbr>didBecomeInvalidWithError:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Delegate called when the session becomes invalid.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">URLSession</span><span class="p">(</span><span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">,</span> <span class="n">didBecomeInvalidWithError</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
                <li class="item">
 | 
						||
                  <div>
 | 
						||
                    <code>
 | 
						||
                    <a name="/s:8SocketIO0A6EngineC10didReceive5event6clienty10Starscream03WebA5EventO_AG0iA0CtF"></a>
 | 
						||
                    <a name="//apple_ref/swift/Method/didReceive(event:client:)" class="dashAnchor"></a>
 | 
						||
                    <a class="token" href="#/s:8SocketIO0A6EngineC10didReceive5event6clienty10Starscream03WebA5EventO_AG0iA0CtF">didReceive(event:<wbr>client:<wbr>)</a>
 | 
						||
                    </code>
 | 
						||
                  </div>
 | 
						||
                  <div class="height-container">
 | 
						||
                    <div class="pointer-container"></div>
 | 
						||
                    <section class="section">
 | 
						||
                      <div class="pointer"></div>
 | 
						||
                      <div class="abstract">
 | 
						||
                        <p>Delegate method for WebSocketDelegate.</p>
 | 
						||
 | 
						||
                      </div>
 | 
						||
                      <div class="declaration">
 | 
						||
                        <h4>Declaration</h4>
 | 
						||
                        <div class="language">
 | 
						||
                          <p class="aside-title">Swift</p>
 | 
						||
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">didReceive</span><span class="p">(</span><span class="nv">event</span><span class="p">:</span> <span class="kt">WebSocketEvent</span><span class="p">,</span> <span class="n"><a href="../Classes/SocketEngine.html#/s:8SocketIO0A6EngineC6clientAA0aC6Client_pSgvp">client</a></span> <span class="nv">_</span><span class="p">:</span> <span class="kt">WebSocket</span><span class="p">)</span></code></pre>
 | 
						||
 | 
						||
                        </div>
 | 
						||
                      </div>
 | 
						||
                      <div>
 | 
						||
                        <h4>Parameters</h4>
 | 
						||
                        <table class="graybox">
 | 
						||
                          <tbody>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>event</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p>WS Event</p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                            <tr>
 | 
						||
                              <td>
 | 
						||
                                <code>
 | 
						||
                                <em>_</em>
 | 
						||
                                </code>
 | 
						||
                              </td>
 | 
						||
                              <td>
 | 
						||
                                <div>
 | 
						||
                                  <p></p>
 | 
						||
                                </div>
 | 
						||
                              </td>
 | 
						||
                            </tr>
 | 
						||
                          </tbody>
 | 
						||
                        </table>
 | 
						||
                      </div>
 | 
						||
                    </section>
 | 
						||
                  </div>
 | 
						||
                </li>
 | 
						||
              </ul>
 | 
						||
            </div>
 | 
						||
          </div>
 | 
						||
        </section>
 | 
						||
 | 
						||
      </article>
 | 
						||
    </div>
 | 
						||
    <section class="footer">
 | 
						||
      <p>© 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
 | 
						||
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
 | 
						||
    </section>
 | 
						||
  </body>
 | 
						||
</div>
 | 
						||
</html>
 |