Create gh-pages branch via GitHub
This commit is contained in:
sta
parent
ae8889cd10
commit
b6e0524bec
Binary file not shown.
|
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 139 B |
118
index.html
118
index.html
@ -53,18 +53,11 @@
|
||||
<li><strong><a href="#secure-connection">Secure Connection</a></strong></li>
|
||||
<li><strong><a href="#http-authentication">HTTP Authentication</a></strong></li>
|
||||
<li><strong><a href="#query-string-origin-header-and-cookies">Query String, Origin header and Cookies</a></strong></li>
|
||||
<li><strong><a href="#connecting-through-the-http-proxy-server">Connecting through the HTTP Proxy server</a></strong></li>
|
||||
<li>.NET <strong>3.5</strong> or later (includes compatible)</li>
|
||||
</ul><h2>
|
||||
<a name="branches" class="anchor" href="#branches"><span class="octicon octicon-link"></span></a>Branches</h2>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<strong><a href="https://github.com/sta/websocket-sharp/tree/master">master</a></strong> for production releases.</li>
|
||||
<li>
|
||||
<strong><a href="https://github.com/sta/websocket-sharp/tree/hybi-00">hybi-00</a></strong> for older <a href="http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00">draft-ietf-hybi-thewebsocketprotocol-00</a>. No longer maintained.</li>
|
||||
<li>
|
||||
<strong><a href="https://github.com/sta/websocket-sharp/tree/draft75">draft75</a></strong> for even more old <a href="http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75">draft-hixie-thewebsocketprotocol-75</a>. No longer maintained.</li>
|
||||
</ul><h2>
|
||||
<h2>
|
||||
<a name="build" class="anchor" href="#build"><span class="octicon octicon-link"></span></a>Build</h2>
|
||||
|
||||
<p>websocket-sharp is built as a single assembly, <strong>websocket-sharp.dll</strong>.</p>
|
||||
@ -88,7 +81,9 @@
|
||||
|
||||
<ul>
|
||||
<li><strong><a href="http://www.nuget.org/packages/WebSocketSharp">NuGet Gallery: websocket-sharp</a></strong></li>
|
||||
</ul><p>You can add websocket-sharp to your project using the <strong>NuGet Package Manager</strong>, the following command in the <strong>Package Manager Console</strong>.</p>
|
||||
</ul>
|
||||
|
||||
<p>You can add websocket-sharp to your project using the <strong>NuGet Package Manager</strong>, the following command in the <strong>Package Manager Console</strong>.</p>
|
||||
|
||||
<pre><code>PM> Install-Package WebSocketSharp -Pre
|
||||
</code></pre>
|
||||
@ -100,7 +95,9 @@
|
||||
|
||||
<ul>
|
||||
<li><strong><a href="http://u3d.as/content/sta-blockhead/websocket-sharp-for-unity">WebSocket-Sharp for Unity</a></strong></li>
|
||||
</ul><p>It works with <strong>Unity Free</strong>, but there are some limitations:</p>
|
||||
</ul>
|
||||
|
||||
<p>It works with <strong>Unity Free</strong>, but there are some limitations:</p>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
@ -108,7 +105,9 @@
|
||||
<li>
|
||||
<strong><a href="http://unity3d.com/unity/licenses">.NET Socket Support for iOS/Android</a></strong> (requires iOS/Android Pro)</li>
|
||||
<li><strong>.NET API 2.0 compatibility level for iOS/Android</strong></li>
|
||||
</ul><p>Using <strong>.NET API 2.0 compatibility level for iOS/Android</strong> requires to fix lack of some features for later than .NET 2.0, such as the <code>System.Func<...></code> delegates (so i've fixed it in the asset package).</p>
|
||||
</ul>
|
||||
|
||||
<p>Using <strong>.NET API 2.0 compatibility level for iOS/Android</strong> requires to fix lack of some features for later than .NET 2.0, such as the <code>System.Func<...></code> delegates (so i've fixed it in the asset package).</p>
|
||||
|
||||
<p>And it's priced at <strong>US$15</strong>. I think your $15 makes this project more better and accelerated, <strong>Thank you!</strong></p>
|
||||
|
||||
@ -160,7 +159,7 @@
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
|
||||
<p>The <code>WebSocket</code> class inherits the <code>System.IDisposable</code> interface, so you can use the <code>using</code> statement.</p>
|
||||
<p>The <code>WebSocket</code> class inherits the <code>System.IDisposable</code> interface, so you can use the <code>using</code> statement. And the WebSocket connection is closed with close status <code>1001</code> (going away) when the control leaves the <code>using</code> block.</p>
|
||||
|
||||
<h4>
|
||||
<a name="step-3" class="anchor" href="#step-3"><span class="octicon octicon-link"></span></a>Step 3</h4>
|
||||
@ -191,21 +190,21 @@
|
||||
|
||||
<p><code>e</code> has passed as a <code>WebSocketSharp.MessageEventArgs</code>.</p>
|
||||
|
||||
<p><code>e.Type</code> property returns either <code>WebSocketSharp.Opcode.Text</code> or <code>WebSocketSharp.Opcode.Binary</code> that represents the type of the received message. So by checking it, you determine which item you should use.</p>
|
||||
<p><code>e.Type</code> property returns either <code>WebSocketSharp.Opcode.Text</code> or <code>WebSocketSharp.Opcode.Binary</code> that represents the type of the message. So by checking it, you can determine which item you should use.</p>
|
||||
|
||||
<p>If <code>e.Type</code> is <code>Opcode.Text</code>, you should use <code>e.Data</code> property (returns a <code>string</code>) that represents the received <strong>Text</strong> message.</p>
|
||||
<p>If it returns <code>Opcode.Text</code>, you should use <code>e.Data</code> property that returns a <code>string</code> (represents the <strong>Text</strong> message).</p>
|
||||
|
||||
<p>Or if <code>e.Type</code> is <code>Opcode.Binary</code>, you should use <code>e.RawData</code> property (returns a <code>byte[]</code>) that represents the received <strong>Binary</strong> message.</p>
|
||||
<p>Or if it returns <code>Opcode.Binary</code>, you should use <code>e.RawData</code> property that returns a <code>byte[]</code> (represents the <strong>Binary</strong> message).</p>
|
||||
|
||||
<div class="highlight highlight-cs"><pre><span class="k">if</span> <span class="p">(</span><span class="n">e</span><span class="p">.</span><span class="n">Type</span> <span class="p">==</span> <span class="n">Opcode</span><span class="p">.</span><span class="n">Text</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="c1">// Do something with e.Data</span>
|
||||
<span class="c1">// Do something with e.Data.</span>
|
||||
<span class="p">...</span>
|
||||
|
||||
<span class="k">return</span><span class="p">;</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">e</span><span class="p">.</span><span class="n">Type</span> <span class="p">==</span> <span class="n">Opcode</span><span class="p">.</span><span class="n">Binary</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="c1">// Do something with e.RawData</span>
|
||||
<span class="c1">// Do something with e.RawData.</span>
|
||||
<span class="p">...</span>
|
||||
|
||||
<span class="k">return</span><span class="p">;</span>
|
||||
@ -226,6 +225,8 @@
|
||||
|
||||
<p><code>e.Message</code> property returns a <code>string</code> that represents the error message. So you should use it to get the error message.</p>
|
||||
|
||||
<p>And if the error is due to an exception, you can get the <code>System.Exception</code> instance that caused the error, by using <code>e.Exception</code> property.</p>
|
||||
|
||||
<h5>
|
||||
<a name="websocketonclose-event" class="anchor" href="#websocketonclose-event"><span class="octicon octicon-link"></span></a>WebSocket.OnClose Event</h5>
|
||||
|
||||
@ -294,7 +295,7 @@
|
||||
|
||||
<span class="k">namespace</span> <span class="nn">Example</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">public</span> <span class="k">class</span> <span class="nc">Laputa</span> <span class="p">:</span> <span class="n">WebSocketService</span>
|
||||
<span class="k">public</span> <span class="k">class</span> <span class="nc">Laputa</span> <span class="p">:</span> <span class="n">WebSocketBehavior</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">protected</span> <span class="k">override</span> <span class="k">void</span> <span class="nf">OnMessage</span> <span class="p">(</span><span class="n">MessageEventArgs</span> <span class="n">e</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
@ -328,12 +329,12 @@
|
||||
<div class="highlight highlight-cs"><pre><span class="k">using</span> <span class="nn">WebSocketSharp.Server</span><span class="p">;</span>
|
||||
</pre></div>
|
||||
|
||||
<p>The <code>WebSocketServer</code> and <code>WebSocketService</code> classes exist in the <code>WebSocketSharp.Server</code> namespace.</p>
|
||||
<p>The <code>WebSocketBehavior</code> and <code>WebSocketServer</code> classes exist in the <code>WebSocketSharp.Server</code> namespace.</p>
|
||||
|
||||
<h4>
|
||||
<a name="step-2-1" class="anchor" href="#step-2-1"><span class="octicon octicon-link"></span></a>Step 2</h4>
|
||||
|
||||
<p>Creating the class that inherits the <code>WebSocketService</code> class.</p>
|
||||
<p>Creating the class that inherits the <code>WebSocketBehavior</code> class.</p>
|
||||
|
||||
<p>For example, if you would like to provide an echo service,</p>
|
||||
|
||||
@ -341,7 +342,7 @@
|
||||
<span class="k">using</span> <span class="nn">WebSocketSharp</span><span class="p">;</span>
|
||||
<span class="k">using</span> <span class="nn">WebSocketSharp.Server</span><span class="p">;</span>
|
||||
|
||||
<span class="k">public</span> <span class="k">class</span> <span class="nc">Echo</span> <span class="p">:</span> <span class="n">WebSocketService</span>
|
||||
<span class="k">public</span> <span class="k">class</span> <span class="nc">Echo</span> <span class="p">:</span> <span class="n">WebSocketBehavior</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">protected</span> <span class="k">override</span> <span class="k">void</span> <span class="nf">OnMessage</span> <span class="p">(</span><span class="n">MessageEventArgs</span> <span class="n">e</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
@ -356,7 +357,7 @@
|
||||
<span class="k">using</span> <span class="nn">WebSocketSharp</span><span class="p">;</span>
|
||||
<span class="k">using</span> <span class="nn">WebSocketSharp.Server</span><span class="p">;</span>
|
||||
|
||||
<span class="k">public</span> <span class="k">class</span> <span class="nc">Chat</span> <span class="p">:</span> <span class="n">WebSocketService</span>
|
||||
<span class="k">public</span> <span class="k">class</span> <span class="nc">Chat</span> <span class="p">:</span> <span class="n">WebSocketBehavior</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">private</span> <span class="kt">string</span> <span class="n">_suffix</span><span class="p">;</span>
|
||||
|
||||
@ -377,15 +378,17 @@
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
|
||||
<p>If you override the <code>WebSocketService.OnMessage (MessageEventArgs)</code> method, it's called when the <code>OnMessage</code> event of the <code>WebSocket</code> used in the current session in the WebSocket service occurs.</p>
|
||||
<p>You can define the behavior of any WebSocket service by creating the class that inherits the <code>WebSocketBehavior</code> class.</p>
|
||||
|
||||
<p>And if you override the <code>WebSocketService.OnOpen ()</code>, <code>WebSocketService.OnError (ErrorEventArgs)</code>, and <code>WebSocketService.OnClose (CloseEventArgs)</code> methods, each of them is called when each event of the <code>WebSocket</code> (the <code>OnOpen</code>, <code>OnError</code>, and <code>OnClose</code> events) occurs.</p>
|
||||
<p>If you override the <code>WebSocketBehavior.OnMessage (MessageEventArgs)</code> method, it's called when the <code>WebSocket</code> used in the current session in the service receives a message.</p>
|
||||
|
||||
<p>The <code>WebSocketService.Send</code> method sends a data to the client on the current session in the WebSocket service.</p>
|
||||
<p>And if you override the <code>WebSocketBehavior.OnOpen ()</code>, <code>WebSocketBehavior.OnError (ErrorEventArgs)</code>, and <code>WebSocketBehavior.OnClose (CloseEventArgs)</code> methods, each of them is called when each event of the <code>WebSocket</code> (the <code>OnOpen</code>, <code>OnError</code>, and <code>OnClose</code> events) occurs.</p>
|
||||
|
||||
<p>If you would like to access the sessions in the WebSocket service, you should use the <code>WebSocketService.Sessions</code> property (returns a <code>WebSocketSharp.Server.WebSocketSessionManager</code>).</p>
|
||||
<p>The <code>WebSocketBehavior.Send</code> method sends a data to the client on the current session in the service.</p>
|
||||
|
||||
<p>The <code>WebSocketService.Sessions.Broadcast</code> method broadcasts a data to every client in the WebSocket service.</p>
|
||||
<p>If you would like to access the sessions in the service, you should use the <code>WebSocketBehavior.Sessions</code> property (returns a <code>WebSocketSharp.Server.WebSocketSessionManager</code>).</p>
|
||||
|
||||
<p>The <code>WebSocketBehavior.Sessions.Broadcast</code> method broadcasts a data to every client in the service.</p>
|
||||
|
||||
<h4>
|
||||
<a name="step-3-1" class="anchor" href="#step-3-1"><span class="octicon octicon-link"></span></a>Step 3</h4>
|
||||
@ -398,13 +401,13 @@
|
||||
<span class="n">wssv</span><span class="p">.</span><span class="n">AddWebSocketService</span><span class="p"><</span><span class="n">Chat</span><span class="p">></span> <span class="p">(</span><span class="s">"/ChatWithNyan"</span><span class="p">,</span> <span class="p">()</span> <span class="p">=></span> <span class="k">new</span> <span class="n">Chat</span> <span class="p">(</span><span class="s">" Nyan!"</span><span class="p">));</span>
|
||||
</pre></div>
|
||||
|
||||
<p>You can add any WebSocket service to your <code>WebSocketServer</code> with the specified path to the service, using the <code>WebSocketServer.AddWebSocketService<TWithNew> (string)</code> or <code>WebSocketServer.AddWebSocketService<T> (string, Func<T>)</code> method.</p>
|
||||
<p>You can add any WebSocket service to your <code>WebSocketServer</code> with the specified behavior and path to the service, using the <code>WebSocketServer.AddWebSocketService<TBehaviorWithNew> (string)</code> or <code>WebSocketServer.AddWebSocketService<TBehavior> (string, Func<TBehavior>)</code> method.</p>
|
||||
|
||||
<p>The type of <code>TWithNew</code> must inherit the <code>WebSocketService</code> class and must have a public parameterless constructor.</p>
|
||||
<p>The type of <code>TBehaviorWithNew</code> must inherit the <code>WebSocketBehavior</code> class, and must have a public parameterless constructor.</p>
|
||||
|
||||
<p>And also the type of <code>T</code> must inherit the <code>WebSocketService</code> class.</p>
|
||||
<p>And also the type of <code>TBehavior</code> must inherit the <code>WebSocketBehavior</code> class.</p>
|
||||
|
||||
<p>So you can use the classes created in <strong>Step 2</strong> to add the WebSocket service.</p>
|
||||
<p>So you can use the classes created in <strong>Step 2</strong> to add the service.</p>
|
||||
|
||||
<p>If you create an instance of the <code>WebSocketServer</code> class without a port number, the <code>WebSocketServer</code> set the port number to <strong>80</strong> automatically. So it's necessary to run with root permission.</p>
|
||||
|
||||
@ -438,7 +441,7 @@
|
||||
|
||||
<p>So websocket-sharp provides the <code>WebSocketSharp.Server.HttpServer</code> class.</p>
|
||||
|
||||
<p>You can add any WebSocket service to your <code>HttpServer</code> with the specified path to the service, using the <code>HttpServer.AddWebSocketService<TWithNew> (string)</code> or <code>HttpServer.AddWebSocketService<T> (string, Func<T>)</code> method.</p>
|
||||
<p>You can add any WebSocket service to your <code>HttpServer</code> with the specified behavior and path to the service, using the <code>HttpServer.AddWebSocketService<TBehaviorWithNew> (string)</code> or <code>HttpServer.AddWebSocketService<TBehavior> (string, Func<TBehavior>)</code> method.</p>
|
||||
|
||||
<div class="highlight highlight-cs"><pre><span class="kt">var</span> <span class="n">httpsv</span> <span class="p">=</span> <span class="k">new</span> <span class="n">HttpServer</span> <span class="p">(</span><span class="m">4649</span><span class="p">);</span>
|
||||
<span class="n">httpsv</span><span class="p">.</span><span class="n">AddWebSocketService</span><span class="p"><</span><span class="n">Echo</span><span class="p">></span> <span class="p">(</span><span class="s">"/Echo"</span><span class="p">);</span>
|
||||
@ -490,7 +493,7 @@
|
||||
<span class="p">};</span>
|
||||
</pre></div>
|
||||
|
||||
<p>If you set this property to nothing, the validation does nothing with the server certificate and returns <code>true</code>.</p>
|
||||
<p>If you set this property to nothing, the validation does nothing with the server certificate, and returns <code>true</code>.</p>
|
||||
|
||||
<p>As a <strong>WebSocket Server</strong>, you should create an instance of the <code>WebSocketServer</code> or <code>HttpServer</code> class with some settings for the secure connection, like the following.</p>
|
||||
|
||||
@ -510,7 +513,7 @@
|
||||
|
||||
<p>If <code>preAuth</code> is <code>true</code>, the <code>WebSocket</code> sends the Basic authentication credentials with the first connection request to the server.</p>
|
||||
|
||||
<p>Or if <code>preAuth</code> is <code>false</code>, the <code>WebSocket</code> sends either the Basic or Digest authentication (determined by the unauthorized response to the first connection request) credentials with the second connection request to the server.</p>
|
||||
<p>Or if <code>preAuth</code> is <code>false</code>, the <code>WebSocket</code> sends either the Basic or Digest (determined by the unauthorized response to the first connection request) authentication credentials with the second connection request to the server.</p>
|
||||
|
||||
<p>As a <strong>WebSocket Server</strong>, you should set an HTTP authentication scheme, a realm, and any function to find the user credentials before starting, like the following.</p>
|
||||
|
||||
@ -519,8 +522,8 @@
|
||||
<span class="n">wssv</span><span class="p">.</span><span class="n">UserCredentialsFinder</span> <span class="p">=</span> <span class="n">id</span> <span class="p">=></span> <span class="p">{</span>
|
||||
<span class="kt">var</span> <span class="n">expected</span> <span class="p">=</span> <span class="s">"nobita"</span><span class="p">;</span>
|
||||
<span class="k">return</span> <span class="n">id</span><span class="p">.</span><span class="n">Name</span> <span class="p">==</span> <span class="n">expected</span>
|
||||
<span class="p">?</span> <span class="k">new</span> <span class="n">NetworkCredential</span> <span class="p">(</span><span class="n">expected</span><span class="p">,</span> <span class="s">"password"</span><span class="p">,</span> <span class="s">"gunfighter"</span><span class="p">)</span> <span class="c1">// User name, password, and roles</span>
|
||||
<span class="p">:</span> <span class="k">null</span><span class="p">;</span> <span class="c1">// If the user credentials not found.</span>
|
||||
<span class="p">?</span> <span class="k">new</span> <span class="n">NetworkCredential</span> <span class="p">(</span><span class="n">expected</span><span class="p">,</span> <span class="s">"password"</span><span class="p">,</span> <span class="s">"gunfighter"</span><span class="p">)</span> <span class="c1">// User name, password, and roles.</span>
|
||||
<span class="p">:</span> <span class="k">null</span><span class="p">;</span> <span class="c1">// If the user credentials aren't found.</span>
|
||||
<span class="p">};</span>
|
||||
</pre></div>
|
||||
|
||||
@ -549,9 +552,9 @@
|
||||
<div class="highlight highlight-cs"><pre><span class="n">ws</span><span class="p">.</span><span class="n">SetCookie</span> <span class="p">(</span><span class="k">new</span> <span class="n">Cookie</span> <span class="p">(</span><span class="s">"name"</span><span class="p">,</span> <span class="s">"nobita"</span><span class="p">));</span>
|
||||
</pre></div>
|
||||
|
||||
<p>As a <strong>WebSocket Server</strong>, if you would like to get the <strong>Query String</strong> included in each WebSocket connection request, you should access the <code>WebSocketService.Context.QueryString</code> property, like the following.</p>
|
||||
<p>As a <strong>WebSocket Server</strong>, if you would like to get the <strong>Query String</strong> included in each WebSocket connection request, you should access the <code>WebSocketBehavior.Context.QueryString</code> property, like the following.</p>
|
||||
|
||||
<div class="highlight highlight-cs"><pre><span class="k">public</span> <span class="k">class</span> <span class="nc">Chat</span> <span class="p">:</span> <span class="n">WebSocketService</span>
|
||||
<div class="highlight highlight-cs"><pre><span class="k">public</span> <span class="k">class</span> <span class="nc">Chat</span> <span class="p">:</span> <span class="n">WebSocketBehavior</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">private</span> <span class="kt">string</span> <span class="n">_name</span><span class="p">;</span>
|
||||
<span class="p">...</span>
|
||||
@ -565,31 +568,48 @@
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
|
||||
<p>And if you would like to check the <strong>Origin header and Cookies</strong> included in each WebSocket connection request, you should set each validation for the Origin header and Cookies in your <code>WebSocketService</code>, for example, using the <code>AddWebSocketService<T> (string, Func<T>)</code> method with initializing, like the following.</p>
|
||||
<p>And if you would like to validate the <strong>Origin header</strong>, <strong>Cookies</strong>, or both included in each WebSocket connection request, you should set each validation with your <code>WebSocketBehavior</code>, for example, using the <code>AddWebSocketService<TBehavior> (string, Func<TBehavior>)</code> method with initializing, like the following.</p>
|
||||
|
||||
<div class="highlight highlight-cs"><pre><span class="n">wssv</span><span class="p">.</span><span class="n">AddWebSocketService</span><span class="p"><</span><span class="n">Chat</span><span class="p">></span> <span class="p">(</span>
|
||||
<span class="s">"/Chat"</span><span class="p">,</span>
|
||||
<span class="p">()</span> <span class="p">=></span> <span class="k">new</span> <span class="n">Chat</span> <span class="p">()</span> <span class="p">{</span>
|
||||
<span class="n">OriginValidator</span> <span class="p">=</span> <span class="n">val</span> <span class="p">=></span> <span class="p">{</span>
|
||||
<span class="c1">// Check the value of the Origin header, and return true if valid</span>
|
||||
<span class="c1">// Check the value of the Origin header, and return true if valid.</span>
|
||||
<span class="n">Uri</span> <span class="n">origin</span><span class="p">;</span>
|
||||
<span class="k">return</span> <span class="p">!</span><span class="n">val</span><span class="p">.</span><span class="n">IsNullOrEmpty</span> <span class="p">()</span> <span class="p">&&</span>
|
||||
<span class="n">Uri</span><span class="p">.</span><span class="n">TryCreate</span> <span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">UriKind</span><span class="p">.</span><span class="n">Absolute</span><span class="p">,</span> <span class="k">out</span> <span class="n">origin</span><span class="p">)</span> <span class="p">&&</span>
|
||||
<span class="n">origin</span><span class="p">.</span><span class="n">Host</span> <span class="p">==</span> <span class="s">"example.com"</span><span class="p">;</span>
|
||||
<span class="p">},</span>
|
||||
<span class="n">CookiesValidator</span> <span class="p">=</span> <span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
|
||||
<span class="c1">// Check the Cookies in 'req', and set the Cookies to send to the client with 'res' if necessary</span>
|
||||
<span class="c1">// Check the Cookies in 'req', and set the Cookies to send to the client with 'res' if necessary.</span>
|
||||
<span class="k">foreach</span> <span class="p">(</span><span class="n">Cookie</span> <span class="n">cookie</span> <span class="k">in</span> <span class="n">req</span><span class="p">)</span> <span class="p">{</span>
|
||||
<span class="n">cookie</span><span class="p">.</span><span class="n">Expired</span> <span class="p">=</span> <span class="k">true</span><span class="p">;</span>
|
||||
<span class="n">res</span><span class="p">.</span><span class="n">Add</span> <span class="p">(</span><span class="n">cookie</span><span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">return</span> <span class="k">true</span><span class="p">;</span> <span class="c1">// If valid</span>
|
||||
<span class="k">return</span> <span class="k">true</span><span class="p">;</span> <span class="c1">// If valid.</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">});</span>
|
||||
</pre></div>
|
||||
|
||||
<p>Also, if you would like to get each value of the Origin header and cookies, you should access each of the <code>WebSocketService.Context.Origin</code> and <code>WebSocketService.Context.CookieCollection</code> properties.</p>
|
||||
<p>Also, if you would like to get each value of the Origin header and cookies, you should access each of the <code>WebSocketBehavior.Context.Origin</code> and <code>WebSocketBehavior.Context.CookieCollection</code> properties.</p>
|
||||
|
||||
<h3>
|
||||
<a name="connecting-through-the-http-proxy-server" class="anchor" href="#connecting-through-the-http-proxy-server"><span class="octicon octicon-link"></span></a>Connecting through the HTTP Proxy server</h3>
|
||||
|
||||
<p>websocket-sharp supports to connect through the <strong>HTTP Proxy</strong> server.</p>
|
||||
|
||||
<p>If you would like to connect to a WebSocket server through the HTTP Proxy server, you should set the proxy server URL, and if necessary, a pair of user name and password for the proxy server authentication (Basic/Digest), using the <code>WebSocket.SetProxy (string, string, string)</code> method before connecting.</p>
|
||||
|
||||
<div class="highlight highlight-cs"><pre><span class="kt">var</span> <span class="n">ws</span> <span class="p">=</span> <span class="k">new</span> <span class="n">WebSocket</span> <span class="p">(</span><span class="s">"ws://example.com"</span><span class="p">);</span>
|
||||
<span class="n">ws</span><span class="p">.</span><span class="n">SetProxy</span> <span class="p">(</span><span class="s">"http://localhost:3128"</span><span class="p">,</span> <span class="s">"nobita"</span><span class="p">,</span> <span class="s">"password"</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<p>I tested this with the <a href="http://www.squid-cache.org">Squid</a>. And it's necessary to disable the following configuration option in <strong>squid.conf</strong> (e.g. <code>/etc/squid/squid.conf</code>).</p>
|
||||
|
||||
<pre><code># Deny CONNECT to other than SSL ports
|
||||
#http_access deny CONNECT !SSL_ports
|
||||
</code></pre>
|
||||
|
||||
<h3>
|
||||
<a name="logging" class="anchor" href="#logging"><span class="octicon octicon-link"></span></a>Logging</h3>
|
||||
@ -650,12 +670,16 @@
|
||||
<li><strong><a href="http://tools.ietf.org/html/rfc6455">The WebSocket Protocol</a></strong></li>
|
||||
<li><strong><a href="http://www.w3.org/TR/websockets">The WebSocket API</a></strong></li>
|
||||
<li><strong><a href="http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-09">Compression Extensions for WebSocket</a></strong></li>
|
||||
</ul><p>Thanks for translating to japanese.</p>
|
||||
</ul>
|
||||
|
||||
<p>Thanks for translating to japanese.</p>
|
||||
|
||||
<ul>
|
||||
<li><strong><a href="http://www.hcn.zaq.ne.jp/___/WEB/RFC6455-ja.html">The WebSocket Protocol 日本語訳</a></strong></li>
|
||||
<li><strong><a href="http://www.hcn.zaq.ne.jp/___/WEB/WebSocket-ja.html">The WebSocket API 日本語訳</a></strong></li>
|
||||
</ul><h2>
|
||||
</ul>
|
||||
|
||||
<h2>
|
||||
<a name="license" class="anchor" href="#license"><span class="octicon octicon-link"></span></a>License</h2>
|
||||
|
||||
<p>websocket-sharp is provided under <strong><a href="https://raw.github.com/sta/websocket-sharp/master/LICENSE.txt">The MIT License</a></strong>.</p>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user