DevWiki/websocket-sharp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix for the deflate frame

Browse Source
This commit is contained in:
sta
2013-04-23 18:08:42 +09:00
parent df1ff81483
commit b33b5e63ba
81 changed files with 1204 additions and 347 deletions
Download Patch File Download Diff File Expand all files Collapse all files

258
websocket-sharp/doc/html/WebSocketSharp/CompressionMethod.html Normal file
View File

@@ -0,0 +1,258 @@
<html>
<head>
<title>WebSocketSharp.CompressionMethod</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style>
a { text-decoration: none }
div.SideBar {
padding-left: 1em;
padding-right: 1em;
right: 0;
float: right;
border: thin solid black;
background-color: #f2f2f2;
}
.CollectionTitle { font-weight: bold }
.PageTitle { font-size: 150%; font-weight: bold }
.Summary { }
.Signature { }
.Remarks { }
.Members { }
.Copyright { }
.Section { font-size: 125%; font-weight: bold }
p.Summary {
margin-left: 1em;
}
.SectionBox { margin-left: 2em }
.NamespaceName { font-size: 105%; font-weight: bold }
.NamespaceSumary { }
.MemberName { font-size: 115%; font-weight: bold; margin-top: 1em }
.Subsection { font-size: 105%; font-weight: bold }
.SubsectionBox { margin-left: 2em; margin-bottom: 1em }
.CodeExampleTable { background-color: #f5f5dd; border: thin solid black; padding: .25em; }
.TypesListing {
border-collapse: collapse;
}
td {
vertical-align: top;
}
th {
text-align: left;
}
.TypesListing td {
margin: 0px;
padding: .25em;
border: solid gray 1px;
}
.TypesListing th {
margin: 0px;
padding: .25em;
background-color: #f2f2f2;
border: solid gray 1px;
}
div.Footer {
border-top: 1px solid gray;
margin-top: 1.5em;
padding-top: 0.6em;
text-align: center;
color: gray;
}
span.NotEntered /* Documentation for this section has not yet been entered */ {
font-style: italic;
color: red;
}
div.Header {
background: #B0C4DE;
border: double;
border-color: white;
border-width: 7px;
padding: 0.5em;
}
div.Header * {
font-size: smaller;
}
div.Note {
}
i.ParamRef {
}
i.subtitle {
}
ul.TypeMembersIndex {
text-align: left;
background: #F8F8F8;
}
ul.TypeMembersIndex li {
display: inline;
margin: 0.5em;
}
table.HeaderTable {
}
table.SignatureTable {
}
table.Documentation, table.Enumeration, table.TypeDocumentation {
border-collapse: collapse;
width: 100%;
}
table.Documentation tr th, table.TypeMembers tr th, table.Enumeration tr th, table.TypeDocumentation tr th {
background: whitesmoke;
padding: 0.8em;
border: 1px solid gray;
text-align: left;
vertical-align: bottom;
}
table.Documentation tr td, table.TypeMembers tr td, table.Enumeration tr td, table.TypeDocumentation tr td {
padding: 0.5em;
border: 1px solid gray;
text-align: left;
vertical-align: top;
}
table.TypeMembers {
border: 1px solid #C0C0C0;
width: 100%;
}
table.TypeMembers tr td {
background: #F8F8F8;
border: white;
}
table.Documentation {
}
table.TypeMembers {
}
div.CodeExample {
width: 100%;
border: 1px solid #DDDDDD;
background-color: #F8F8F8;
}
div.CodeExample p {
margin: 0.5em;
border-bottom: 1px solid #DDDDDD;
}
div.CodeExample div {
margin: 0.5em;
}
h4 {
margin-bottom: 0;
}
div.Signature {
border: 1px solid #C0C0C0;
background: #F2F2F2;
padding: 1em;
}
</style>
<script type="text/JavaScript">
function toggle_display (block) {
var w = document.getElementById (block);
var t = document.getElementById (block + ":toggle");
if (w.style.display == "none") {
w.style.display = "block";
t.innerHTML = "⊟";
} else {
w.style.display = "none";
t.innerHTML = "⊞";
}
}
</script>
</head>
<body>
<div class="CollectionTitle">
<a href="../index.html">websocket-sharp</a> : <a href="index.html">WebSocketSharp Namespace</a></div>
<div class="SideBar">
<p>
<a href="#T:WebSocketSharp.CompressionMethod">Overview</a>
</p>
<p>
<a href="#T:WebSocketSharp.CompressionMethod:Signature">Signature</a>
</p>
<p>
<a href="#T:WebSocketSharp.CompressionMethod:Docs">Remarks</a>
</p>
<p>
<a href="#Members">Members</a>
</p>
<p>
<a href="#T:WebSocketSharp.CompressionMethod:Members">Member Details</a>
</p>
</div>
<h1 class="PageTitle" id="T:WebSocketSharp.CompressionMethod">CompressionMethod Enum</h1>
<p class="Summary" id="T:WebSocketSharp.CompressionMethod:Summary">
Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame.
</p>
<div id="T:WebSocketSharp.CompressionMethod:Signature">
<h2>Syntax</h2>
<div class="Signature">public enum <b>CompressionMethod</b></div>
</div>
<div class="Remarks" id="T:WebSocketSharp.CompressionMethod:Docs">
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="T:WebSocketSharp.CompressionMethod:Docs:Remarks">
The CompressionMethod enumeration contains the values of the compression methods defined in
WebSocket Per-message Compression
specification for a WebSocket extension.
</div>
<h2 class="Section">Members</h2>
<div class="SectionBox" id="T:WebSocketSharp.CompressionMethod:Docs:Members">
<table class="Enumeration">
<tr>
<th>Member Name</th>
<th>Description</th>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CompressionMethod.DEFLATE">
<b>DEFLATE</b>
</td>
<td>
Indicates using DEFLATE.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CompressionMethod.NONE">
<b>NONE</b>
</td>
<td>
Indicates non compression.
</td>
</tr>
</table>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="T:WebSocketSharp.CompressionMethod:Docs:Version Information">
<b>Namespace: </b>WebSocketSharp<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
</div>
<div class="Members" id="T:WebSocketSharp.CompressionMethod:Members">
</div>
<hr size="1" />
<div class="Copyright">
</div>
</body>
</html>

22
websocket-sharp/doc/html/WebSocketSharp/Ext.html
View File

@@ -418,7 +418,7 @@
<b>
<a href="#M:WebSocketSharp.Ext.IsEmpty(System.String)">IsEmpty</a>
</b>(<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<nobr> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a></nobr><blockquote>
Determines whether the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> is a <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>.
Determines whether the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> is empty.
</blockquote></td>
</tr>
<tr valign="top">
@@ -461,7 +461,7 @@
<td colspan="2">
<b>
<a href="#M:WebSocketSharp.Ext.IsNull``1(``0)">IsNull&lt;T&gt;</a>
</b>(<i>this</i> <i title="&#xA; The type of the parameter.&#xA; ">T</i>)<nobr> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a></nobr><blockquote>
</b>(<i>this</i> <i title="&#xA; The type of parameter.&#xA; ">T</i>)<nobr> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a></nobr><blockquote>
Determines whether the specified object is <tt>null</tt>.
</blockquote></td>
</tr>
@@ -485,7 +485,7 @@
<b>
<a href="#M:WebSocketSharp.Ext.IsNullOrEmpty(System.String)">IsNullOrEmpty</a>
</b>(<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<nobr> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a></nobr><blockquote>
Determines whether the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> is <tt>null</tt> or <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>.
Determines whether the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> is <tt>null</tt> or empty.
</blockquote></td>
</tr>
<tr valign="top">
@@ -1443,7 +1443,7 @@
<h3 id="M:WebSocketSharp.Ext.IsEmpty(System.String)">IsEmpty Method</h3>
<blockquote id="M:WebSocketSharp.Ext.IsEmpty(System.String):member">
<p class="Summary">
Determines whether the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> is a <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>.
Determines whether the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> is empty.
</p>
<h2>Syntax</h2>
<div class="Signature">public static <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> <b>IsEmpty</b> (<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> value)</div>
@@ -1460,7 +1460,7 @@
</blockquote>
<h4 class="Subsection">Returns</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.IsEmpty(System.String):Returns">
<tt>true</tt> if <i>value</i> is <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>; otherwise, <tt>false</tt>.
<tt>true</tt> if <i>value</i> is empty; otherwise, <tt>false</tt>.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Ext.IsEmpty(System.String):Remarks">
@@ -1593,7 +1593,7 @@
Determines whether the specified object is <tt>null</tt>.
</p>
<h2>Syntax</h2>
<div class="Signature">public static <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> <b>IsNull&lt;T&gt;</b> (<i>this</i> <i title="&#xA; The type of the parameter.&#xA; ">T</i> obj)<br /> where T : class</div>
<div class="Signature">public static <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> <b>IsNull&lt;T&gt;</b> (<i>this</i> <i title="&#xA; The type of parameter.&#xA; ">T</i> obj)<br /> where T : class</div>
<h4 class="Subsection">Type Parameters</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.IsNull``1(``0):Type Parameters">
<dl>
@@ -1601,7 +1601,7 @@
<i>T</i>
</dt>
<dd>
The type of the <i>obj</i> parameter.
The type of <i>obj</i> parameter.
</dd>
</dl>
</blockquote>
@@ -1612,13 +1612,13 @@
<i>obj</i>
</dt>
<dd>
A class to test.
An object to test.
</dd>
</dl>
</blockquote>
<h4 class="Subsection">Returns</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.IsNull``1(``0):Returns">
<tt>true</tt> if the <i>obj</i> parameter is <tt>null</tt>; otherwise, <tt>false</tt>.
<tt>true</tt> if <i>obj</i> is <tt>null</tt>; otherwise, <tt>false</tt>.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Ext.IsNull``1(``0):Remarks">
@@ -1681,7 +1681,7 @@
<h3 id="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String)">IsNullOrEmpty Method</h3>
<blockquote id="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String):member">
<p class="Summary">
Determines whether the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> is <tt>null</tt> or <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>.
Determines whether the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> is <tt>null</tt> or empty.
</p>
<h2>Syntax</h2>
<div class="Signature">public static <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> <b>IsNullOrEmpty</b> (<i>this</i> <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> value)</div>
@@ -1698,7 +1698,7 @@
</blockquote>
<h4 class="Subsection">Returns</h4>
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String):Returns">
<tt>true</tt> if the <i>value</i> parameter is <tt>null</tt> or <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>; otherwise, <tt>false</tt>.
<tt>true</tt> if the <i>value</i> parameter is <tt>null</tt> or empty; otherwise, <tt>false</tt>.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String):Remarks">

2
websocket-sharp/doc/html/WebSocketSharp/Opcode.html
View File

@@ -211,7 +211,7 @@
</p>
<div id="T:WebSocketSharp.Opcode:Signature">
<h2>Syntax</h2>
<div class="Signature">[System.Flags]<br />public enum <b>Opcode</b></div>
<div class="Signature">public enum <b>Opcode</b></div>
</div>
<div class="Remarks" id="T:WebSocketSharp.Opcode:Docs">
<h2 class="Section">Remarks</h2>

95
websocket-sharp/doc/html/WebSocketSharp/WebSocket.html
View File

@@ -270,6 +270,23 @@
<div class="SectionBox" id="Public Properties">
<div class="SubsectionBox">
<table class="TypeMembers">
<tr valign="top">
<td>
<div>
</div>
</td>
<td>
<b>
<a href="#P:WebSocketSharp.WebSocket.Compression">Compression</a>
</b>
</td>
<td>
<i>
<a href="../WebSocketSharp/CompressionMethod.html">CompressionMethod</a>
</i>.
Gets or sets the compression method used to compress the payload data of the WebSocket Data frame.
</td>
</tr>
<tr valign="top">
<td>[read-only]<div></div></td>
<td>
@@ -295,7 +312,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>
</i>.
Gets the extensions selected by the server.
Gets the WebSocket extensions selected by the server.
</td>
</tr>
<tr valign="top">
@@ -309,7 +326,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
</i>.
Gets a value indicating whether a connection is alive.
Gets a value indicating whether the WebSocket connection is alive.
</td>
</tr>
<tr valign="top">
@@ -323,7 +340,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
</i>.
Gets a value indicating whether a connection is secure.
Gets a value indicating whether the WebSocket connection is secure.
</td>
</tr>
<tr valign="top">
@@ -354,7 +371,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>
</i>.
Gets the subprotocol selected by the server.
Gets the WebSocket subprotocol selected by the server.
</td>
</tr>
<tr valign="top">
@@ -368,7 +385,7 @@
<i>
<a href="../WebSocketSharp/WsState.html">WsState</a>
</i>.
Gets the state of the connection.
Gets the state of the WebSocket connection.
</td>
</tr>
<tr valign="top">
@@ -382,7 +399,7 @@
<i>
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Uri">Uri</a>
</i>.
Gets the WebSocket URL.
Gets the WebSocket URL to connect.
</td>
</tr>
</table>
@@ -439,8 +456,8 @@
<b>
<a href="#M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String)">Close</a>
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.UInt16">ushort</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
Closes the WebSocket connection with the specified <i>code</i> and <i>reason</i>, and
releases all associated resources.
Closes the WebSocket connection with the specified <i>code</i> and
<i>reason</i>, and releases all associated resources.
</blockquote></td>
</tr>
<tr valign="top">
@@ -452,8 +469,8 @@
<b>
<a href="#M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode,System.String)">Close</a>
</b>(<a href="../WebSocketSharp/CloseStatusCode.html">CloseStatusCode</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
Closes the WebSocket connection with the specified <i>code</i> and <i>reason</i>, and
releases all associated resources.
Closes the WebSocket connection with the specified <i>code</i> and
<i>reason</i>, and releases all associated resources.
</blockquote></td>
</tr>
<tr valign="top">
@@ -665,7 +682,7 @@
<td colspan="2">
<b>
<a href="../WebSocketSharp/Ext.html#M:WebSocketSharp.Ext.IsNull``1(``0)">IsNull&lt;T&gt;</a>
</b>(<i>this</i> <i title="&#xA; The type of the parameter.&#xA; ">T</i>)<nobr> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a></nobr><blockquote>
</b>(<i>this</i> <i title="&#xA; The type of parameter.&#xA; ">T</i>)<nobr> : <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a></nobr><blockquote>
Determines whether the specified object is <tt>null</tt>.
</blockquote></td>
</tr>
@@ -867,8 +884,8 @@
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.WebSocket.Close(System.UInt16):Remarks">
Emits a <a href="../WebSocketSharp/WebSocket.html#E:WebSocketSharp.WebSocket.OnError">WebSocket.OnError</a> event if <i>code</i> is not in the allowable range of
the WebSocket close status code, and do nothing any more.
This Close method emits a <a href="../WebSocketSharp/WebSocket.html#E:WebSocketSharp.WebSocket.OnError">WebSocket.OnError</a> event if <i>code</i> is not
in the allowable range of the WebSocket close status code.
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="M:WebSocketSharp.WebSocket.Close(System.UInt16):Version Information">
@@ -906,8 +923,8 @@
<h3 id="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String)">Close Method</h3>
<blockquote id="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String):member">
<p class="Summary">
Closes the WebSocket connection with the specified <i>code</i> and <i>reason</i>, and
releases all associated resources.
Closes the WebSocket connection with the specified <i>code</i> and
<i>reason</i>, and releases all associated resources.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Close</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.UInt16">ushort</a> code, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> reason)</div>
@@ -930,8 +947,8 @@
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String):Remarks">
Emits a <a href="../WebSocketSharp/WebSocket.html#E:WebSocketSharp.WebSocket.OnError">WebSocket.OnError</a> event if <i>code</i> is not in the allowable range of
the WebSocket close status code, and do nothing any more.
This Close method emits a <a href="../WebSocketSharp/WebSocket.html#E:WebSocketSharp.WebSocket.OnError">WebSocket.OnError</a> event if <i>code</i> is not
in the allowable range of the WebSocket close status code.
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String):Version Information">
@@ -941,8 +958,8 @@
<h3 id="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode,System.String)">Close Method</h3>
<blockquote id="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode,System.String):member">
<p class="Summary">
Closes the WebSocket connection with the specified <i>code</i> and <i>reason</i>, and
releases all associated resources.
Closes the WebSocket connection with the specified <i>code</i> and
<i>reason</i>, and releases all associated resources.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Close</b> (<a href="../WebSocketSharp/CloseStatusCode.html">CloseStatusCode</a> code, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> reason)</div>
@@ -972,6 +989,27 @@
<b>Namespace: </b>WebSocketSharp<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="P:WebSocketSharp.WebSocket.Compression">Compression Property</h3>
<blockquote id="P:WebSocketSharp.WebSocket.Compression:member">
<p class="Summary">
Gets or sets the compression method used to compress the payload data of the WebSocket Data frame.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="../WebSocketSharp/CompressionMethod.html">CompressionMethod</a> <b>Compression</b> { get; set; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.WebSocket.Compression:Value">
One of the <a href="../WebSocketSharp/CompressionMethod.html">WebSocketSharp.CompressionMethod</a> values that indicates the compression method to use.
The default is <a href="../WebSocketSharp/CompressionMethod.html#F:WebSocketSharp.CompressionMethod.NONE">CompressionMethod.NONE</a>.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.WebSocket.Compression:Remarks">
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="P:WebSocketSharp.WebSocket.Compression:Version Information">
<b>Namespace: </b>WebSocketSharp<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
<hr size="1" />
</blockquote>
<h3 id="M:WebSocketSharp.WebSocket.Connect">Connect Method</h3>
<blockquote id="M:WebSocketSharp.WebSocket.Connect:member">
<p class="Summary">
@@ -1028,14 +1066,13 @@
<h3 id="P:WebSocketSharp.WebSocket.Extensions">Extensions Property</h3>
<blockquote id="P:WebSocketSharp.WebSocket.Extensions:member">
<p class="Summary">
Gets the extensions selected by the server.
Gets the WebSocket extensions selected by the server.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> <b>Extensions</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.WebSocket.Extensions:Value">
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains the extensions if any. The default is <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>.
(Currently this will only ever be the <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>.)
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.WebSocket.Extensions:Remarks">
@@ -1049,7 +1086,7 @@
<h3 id="P:WebSocketSharp.WebSocket.IsAlive">IsAlive Property</h3>
<blockquote id="P:WebSocketSharp.WebSocket.IsAlive:member">
<p class="Summary">
Gets a value indicating whether a connection is alive.
Gets a value indicating whether the WebSocket connection is alive.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> <b>IsAlive</b> { get; }</div>
@@ -1069,7 +1106,7 @@
<h3 id="P:WebSocketSharp.WebSocket.IsSecure">IsSecure Property</h3>
<blockquote id="P:WebSocketSharp.WebSocket.IsSecure:member">
<p class="Summary">
Gets a value indicating whether a connection is secure.
Gets a value indicating whether the WebSocket connection is secure.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> <b>IsSecure</b> { get; }</div>
@@ -1230,13 +1267,13 @@
<h3 id="P:WebSocketSharp.WebSocket.Protocol">Protocol Property</h3>
<blockquote id="P:WebSocketSharp.WebSocket.Protocol:member">
<p class="Summary">
Gets the subprotocol selected by the server.
Gets the WebSocket subprotocol selected by the server.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> <b>Protocol</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.WebSocket.Protocol:Value">
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains the subprotocol if any. By default, <tt>String.Empty</tt>.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains the subprotocol if any. The default is <a href="http://www.go-mono.com/docs/monodoc.ashx?link=F:System.String.Empty">string.Empty</a>.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.WebSocket.Protocol:Remarks">
@@ -1250,13 +1287,13 @@
<h3 id="P:WebSocketSharp.WebSocket.ReadyState">ReadyState Property</h3>
<blockquote id="P:WebSocketSharp.WebSocket.ReadyState:member">
<p class="Summary">
Gets the state of the connection.
Gets the state of the WebSocket connection.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="../WebSocketSharp/WsState.html">WsState</a> <b>ReadyState</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.WebSocket.ReadyState:Value">
One of the <a href="../WebSocketSharp/WsState.html">WebSocketSharp.WsState</a>. By default, <tt>WsState.CONNECTING</tt>.
One of the <a href="../WebSocketSharp/WsState.html">WebSocketSharp.WsState</a> values. The default is <a href="../WebSocketSharp/WsState.html#F:WebSocketSharp.WsState.CONNECTING">WsState.CONNECTING</a>.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.WebSocket.ReadyState:Remarks">
@@ -1480,13 +1517,13 @@
<h3 id="P:WebSocketSharp.WebSocket.Url">Url Property</h3>
<blockquote id="P:WebSocketSharp.WebSocket.Url:member">
<p class="Summary">
Gets the WebSocket URL.
Gets the WebSocket URL to connect.
</p>
<h2>Syntax</h2>
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Uri">Uri</a> <b>Url</b> { get; }</div>
<h4 class="Subsection">Value</h4>
<blockquote class="SubsectionBox" id="P:WebSocketSharp.WebSocket.Url:Value">
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Uri">Uri</a> that contains the WebSocket URL.
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Uri">Uri</a> that contains the WebSocket URL to connect.
</blockquote>
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="P:WebSocketSharp.WebSocket.Url:Remarks">

8
websocket-sharp/doc/html/WebSocketSharp/index.html
View File

@@ -226,6 +226,14 @@
Contains the values of the status codes for the WebSocket connection closure.
</td>
</tr>
<tr valign="top">
<td>
<a href="./CompressionMethod.html">CompressionMethod</a>
</td>
<td>
Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame.
</td>
</tr>
<tr valign="top">
<td>
<a href="./ErrorEventArgs.html">ErrorEventArgs</a>

8
websocket-sharp/doc/html/index.html
View File

@@ -228,6 +228,14 @@
Contains the values of the status codes for the WebSocket connection closure.
</td>
</tr>
<tr valign="top">
<td>
<a href="WebSocketSharp/CompressionMethod.html">CompressionMethod</a>
</td>
<td>
Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame.
</td>
</tr>
<tr valign="top">
<td>
<a href="WebSocketSharp/ErrorEventArgs.html">ErrorEventArgs</a>

48
websocket-sharp/doc/mdoc/WebSocketSharp/CompressionMethod.xml Normal file
View File

@@ -0,0 +1,48 @@
<Type Name="CompressionMethod" FullName="WebSocketSharp.CompressionMethod">
<TypeSignature Language="C#" Value="public enum CompressionMethod" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed CompressionMethod extends System.Enum" />
<AssemblyInfo>
<AssemblyName>websocket-sharp</AssemblyName>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>
Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame.
</summary>
<remarks>
The <b>CompressionMethod</b> enumeration contains the values of the compression methods defined in
<see href="http://tools.ietf.org/html/draft-tyoshino-hybi-permessage-compression-00">WebSocket Per-message Compression</see>
specification for a WebSocket extension.
</remarks>
</Docs>
<Members>
<Member MemberName="DEFLATE">
<MemberSignature Language="C#" Value="DEFLATE" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype WebSocketSharp.CompressionMethod DEFLATE = unsigned int8(1)" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>WebSocketSharp.CompressionMethod</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates using DEFLATE.
</summary>
</Docs>
</Member>
<Member MemberName="NONE">
<MemberSignature Language="C#" Value="NONE" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype WebSocketSharp.CompressionMethod NONE = unsigned int8(0)" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>WebSocketSharp.CompressionMethod</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates non compression.
</summary>
</Docs>
</Member>
</Members>
</Type>

14
websocket-sharp/doc/mdoc/WebSocketSharp/Ext.xml
View File

@@ -492,10 +492,10 @@
A <see cref="T:System.String" /> to test.
</param>
<summary>
Determines whether the specified <see cref="T:System.String" /> is a <see cref="F:System.String.Empty" />.
Determines whether the specified <see cref="T:System.String" /> is empty.
</summary>
<returns>
<c>true</c> if <paramref name="value" /> is <see cref="F:System.String.Empty" />; otherwise, <c>false</c>.
<c>true</c> if <paramref name="value" /> is empty; otherwise, <c>false</c>.
</returns>
<remarks>To be added.</remarks>
</Docs>
@@ -595,16 +595,16 @@
</Parameters>
<Docs>
<typeparam name="T">
The type of the <paramref name="obj" /> parameter.
The type of <paramref name="obj" /> parameter.
</typeparam>
<param name="obj">
A <b>class</b> to test.
An <b>object</b> to test.
</param>
<summary>
Determines whether the specified object is <see langword="null" />.
</summary>
<returns>
<c>true</c> if the <paramref name="obj" /> parameter is <see langword="null" />; otherwise, <c>false</c>.
<c>true</c> if <paramref name="obj" /> is <see langword="null" />; otherwise, <c>false</c>.
</returns>
<remarks>To be added.</remarks>
</Docs>
@@ -662,10 +662,10 @@
A <see cref="T:System.String" /> to test.
</param>
<summary>
Determines whether the specified <see cref="T:System.String" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
Determines whether the specified <see cref="T:System.String" /> is <see langword="null" /> or empty.
</summary>
<returns>
<c>true</c> if the <paramref name="value" /> parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />; otherwise, <c>false</c>.
<c>true</c> if the <paramref name="value" /> parameter is <see langword="null" /> or empty; otherwise, <c>false</c>.
</returns>
<remarks>To be added.</remarks>
</Docs>

5
websocket-sharp/doc/mdoc/WebSocketSharp/Opcode.xml
View File

@@ -7,11 +7,6 @@
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>System.Flags</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Contains the values of the opcodes that denotes the frame type of the WebSocket frame.

55
websocket-sharp/doc/mdoc/WebSocketSharp/WebSocket.xml
View File

@@ -1,6 +1,6 @@
<Type Name="WebSocket" FullName="WebSocketSharp.WebSocket">
<TypeSignature Language="C#" Value="public class WebSocket : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WebSocket extends System.Object implements class System.IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi WebSocket extends System.Object implements class System.IDisposable" />
<AssemblyInfo>
<AssemblyName>websocket-sharp</AssemblyName>
</AssemblyInfo>
@@ -142,8 +142,8 @@
releases all associated resources.
</summary>
<remarks>
Emits a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event if <paramref name="code" /> is not in the allowable range of
the WebSocket close status code, and do nothing any more.
This Close method emits a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event if <paramref name="code" /> is not
in the allowable range of the WebSocket close status code.
</remarks>
</Docs>
</Member>
@@ -187,12 +187,12 @@
A <see cref="T:System.String" /> that contains the reason for closure.
</param>
<summary>
Closes the WebSocket connection with the specified <paramref name="code" /> and <paramref name="reason" />, and
releases all associated resources.
Closes the WebSocket connection with the specified <paramref name="code" /> and
<paramref name="reason" />, and releases all associated resources.
</summary>
<remarks>
Emits a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event if <paramref name="code" /> is not in the allowable range of
the WebSocket close status code, and do nothing any more.
This Close method emits a <see cref="E:WebSocketSharp.WebSocket.OnError" /> event if <paramref name="code" /> is not
in the allowable range of the WebSocket close status code.
</remarks>
</Docs>
</Member>
@@ -215,12 +215,30 @@
A <see cref="T:System.String" /> that contains the reason for closure.
</param>
<summary>
Closes the WebSocket connection with the specified <paramref name="code" /> and <paramref name="reason" />, and
releases all associated resources.
Closes the WebSocket connection with the specified <paramref name="code" /> and
<paramref name="reason" />, and releases all associated resources.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Compression">
<MemberSignature Language="C#" Value="public WebSocketSharp.CompressionMethod Compression { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype WebSocketSharp.CompressionMethod Compression" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>WebSocketSharp.CompressionMethod</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the compression method used to compress the payload data of the WebSocket Data frame.
</summary>
<value>
One of the <see cref="T:WebSocketSharp.CompressionMethod" /> values that indicates the compression method to use.
The default is <see cref="F:WebSocketSharp.CompressionMethod.NONE" />.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Connect">
<MemberSignature Language="C#" Value="public void Connect ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Connect() cil managed" />
@@ -280,11 +298,10 @@
</ReturnValue>
<Docs>
<summary>
Gets the extensions selected by the server.
Gets the WebSocket extensions selected by the server.
</summary>
<value>
A <see cref="T:System.String" /> that contains the extensions if any. The default is <see cref="F:System.String.Empty" />.
(Currently this will only ever be the <see cref="F:System.String.Empty" />.)
</value>
<remarks>To be added.</remarks>
</Docs>
@@ -298,7 +315,7 @@
</ReturnValue>
<Docs>
<summary>
Gets a value indicating whether a connection is alive.
Gets a value indicating whether the WebSocket connection is alive.
</summary>
<value>
<c>true</c> if the connection is alive; otherwise, <c>false</c>.
@@ -315,7 +332,7 @@
</ReturnValue>
<Docs>
<summary>
Gets a value indicating whether a connection is secure.
Gets a value indicating whether the WebSocket connection is secure.
</summary>
<value>
<c>true</c> if the connection is secure; otherwise, <c>false</c>.
@@ -454,10 +471,10 @@
</ReturnValue>
<Docs>
<summary>
Gets the subprotocol selected by the server.
Gets the WebSocket subprotocol selected by the server.
</summary>
<value>
A <see cref="T:System.String" /> that contains the subprotocol if any. By default, <c>String.Empty</c>.
A <see cref="T:System.String" /> that contains the subprotocol if any. The default is <see cref="F:System.String.Empty" />.
</value>
<remarks>To be added.</remarks>
</Docs>
@@ -471,10 +488,10 @@
</ReturnValue>
<Docs>
<summary>
Gets the state of the connection.
Gets the state of the WebSocket connection.
</summary>
<value>
One of the <see cref="T:WebSocketSharp.WsState" />. By default, <c>WsState.CONNECTING</c>.
One of the <see cref="T:WebSocketSharp.WsState" /> values. The default is <see cref="F:WebSocketSharp.WsState.CONNECTING" />.
</value>
<remarks>To be added.</remarks>
</Docs>
@@ -643,10 +660,10 @@
</ReturnValue>
<Docs>
<summary>
Gets the WebSocket URL.
Gets the WebSocket URL to connect.
</summary>
<value>
A <see cref="T:System.Uri" /> that contains the WebSocket URL.
A <see cref="T:System.Uri" /> that contains the WebSocket URL to connect.
</value>
<remarks>To be added.</remarks>
</Docs>

11
websocket-sharp/doc/mdoc/index.xml
View File

@@ -1,6 +1,6 @@
<Overview>
<Assemblies>
<Assembly Name="websocket-sharp" Version="1.0.2.42633">
<Assembly Name="websocket-sharp" Version="1.0.2.32570">
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 11 00 00 00 29 17 fb 89 fe c3 91 f7 2b cb 8b e2 61 d2 3f 05 93 6d 65 a8 9e 63 72 a6 f5 d5 2c f2 9d 20 fa 0b c0 70 6a f6 88 7e 8b 90 3f 39 f5 76 c8 48 e0 bb 7b b2 7b ed d3 10 a7 1a 0f 70 98 0f 7f f4 4b 53 09 d2 a5 ef 36 c3 56 b4 aa f0 91 72 63 25 07 89 e0 93 3e 3f 2e f2 b9 73 0e 12 15 5d 43 56 c3 f4 70 a5 89 fe f7 f6 ac 3e 77 c2 d8 d0 84 91 f4 0c d1 f3 8e dc c3 c3 b8 38 3d 0c bf 17 de 20 78 c1 ]</AssemblyPublicKey>
<Attributes>
<Attribute>
@@ -37,6 +37,7 @@
<Type Name="ByteOrder" Kind="Enumeration" />
<Type Name="CloseEventArgs" Kind="Class" />
<Type Name="CloseStatusCode" Kind="Enumeration" />
<Type Name="CompressionMethod" Kind="Enumeration" />
<Type Name="ErrorEventArgs" Kind="Class" />
<Type Name="Ext" Kind="Class" />
<Type Name="MessageEventArgs" Kind="Class" />
@@ -586,7 +587,7 @@
A <see cref="T:System.String" /> to test.
</param>
<summary>
Determines whether the specified <see cref="T:System.String" /> is a <see cref="F:System.String.Empty" />.
Determines whether the specified <see cref="T:System.String" /> is empty.
</summary>
</Docs>
<Link Type="WebSocketSharp.Ext" Member="M:WebSocketSharp.Ext.IsEmpty(System.String)" />
@@ -694,10 +695,10 @@
</Parameters>
<Docs>
<typeparam name="T">
The type of the <paramref name="obj" /> parameter.
The type of <paramref name="obj" /> parameter.
</typeparam>
<param name="obj">
A <b>class</b> to test.
An <b>object</b> to test.
</param>
<summary>
Determines whether the specified object is <see langword="null" />.
@@ -765,7 +766,7 @@
A <see cref="T:System.String" /> to test.
</param>
<summary>
Determines whether the specified <see cref="T:System.String" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
Determines whether the specified <see cref="T:System.String" /> is <see langword="null" /> or empty.
</summary>
</Docs>
<Link Type="WebSocketSharp.Ext" Member="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String)" />