websocket-sharp/websocket-sharp/doc/html/WebSocketSharp/CloseStatusCode.html

361 lines
11 KiB
HTML

<html>
<head>
<title>WebSocketSharp.CloseStatusCode</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.CloseStatusCode">Overview</a>
</p>
<p>
<a href="#T:WebSocketSharp.CloseStatusCode:Signature">Signature</a>
</p>
<p>
<a href="#T:WebSocketSharp.CloseStatusCode:Docs">Remarks</a>
</p>
<p>
<a href="#Members">Members</a>
</p>
<p>
<a href="#T:WebSocketSharp.CloseStatusCode:Members">Member Details</a>
</p>
</div>
<h1 class="PageTitle" id="T:WebSocketSharp.CloseStatusCode">CloseStatusCode Enum</h1>
<p class="Summary" id="T:WebSocketSharp.CloseStatusCode:Summary">
Contains the values of the status codes for the WebSocket connection closure.
</p>
<div id="T:WebSocketSharp.CloseStatusCode:Signature">
<h2>Syntax</h2>
<div class="Signature">public enum <b>CloseStatusCode</b></div>
</div>
<div class="Remarks" id="T:WebSocketSharp.CloseStatusCode:Docs">
<h2 class="Section">Remarks</h2>
<div class="SectionBox" id="T:WebSocketSharp.CloseStatusCode:Docs:Remarks">
<p>
The CloseStatusCode enumeration contains the values of the status codes for the WebSocket connection closure
defined in RFC 6455 for the WebSocket protocol.
</p>
<p>
"Reserved value" must not be set as a status code in a close control frame by an endpoint.
It is designated for use in applications expecting a status code to indicate that connection
was closed due to a system grounds.
</p>
</div>
<h2 class="Section">Members</h2>
<div class="SectionBox" id="T:WebSocketSharp.CloseStatusCode:Docs:Members">
<table class="Enumeration">
<tr>
<th>Member Name</th>
<th>Description</th>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.ABNORMAL">
<b>ABNORMAL</b>
</td>
<td>
Equivalent to close status 1006. Indicates that the connection was closed abnormally. Reserved value.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.AWAY">
<b>AWAY</b>
</td>
<td>
Equivalent to close status 1001. Indicates that an endpoint is "going away".
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.IGNORE_EXTENSION">
<b>IGNORE_EXTENSION</b>
</td>
<td>
Equivalent to close status 1010. Indicates that an endpoint (client) is terminating the connection
because it has expected the server to negotiate one or more extension, but the server didn't return
them in the response message of the WebSocket handshake.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.INCONSISTENT_DATA">
<b>INCONSISTENT_DATA</b>
</td>
<td>
Equivalent to close status 1007. Indicates that an endpoint is terminating the connection
because it has received data within a message that was not consistent with the type of the message.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.INCORRECT_DATA">
<b>INCORRECT_DATA</b>
</td>
<td>
Equivalent to close status 1003. Indicates that an endpoint is terminating the connection
because it has received a type of data it cannot accept.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.NO_STATUS_CODE">
<b>NO_STATUS_CODE</b>
</td>
<td>
Equivalent to close status 1005. Indicates that no status code was actually present. Reserved value.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.NORMAL">
<b>NORMAL</b>
</td>
<td>
Equivalent to close status 1000. Indicates a normal closure.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.POLICY_VIOLATION">
<b>POLICY_VIOLATION</b>
</td>
<td>
Equivalent to close status 1008. Indicates that an endpoint is terminating the connection
because it has received a message that violates its policy.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.PROTOCOL_ERROR">
<b>PROTOCOL_ERROR</b>
</td>
<td>
Equivalent to close status 1002. Indicates that an endpoint is terminating the connection
due to a protocol error.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.SERVER_ERROR">
<b>SERVER_ERROR</b>
</td>
<td>
Equivalent to close status 1011. Indicates that a server is terminating the connection because it encountered
an unexpected condition that prevented it from fulfilling the request.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.TLS_HANDSHAKE_FAILURE">
<b>TLS_HANDSHAKE_FAILURE</b>
</td>
<td>
Equivalent to close status 1015. Indicates that the connection was closed due to a failure to perform
a TLS handshake. Reserved value.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.TOO_BIG">
<b>TOO_BIG</b>
</td>
<td>
Equivalent to close status 1009. Indicates that an endpoint is terminating the connection
because it has received a message that is too big for it to process.
</td>
</tr>
<tr valign="top">
<td id="F:WebSocketSharp.CloseStatusCode.UNDEFINED">
<b>UNDEFINED</b>
</td>
<td>
Equivalent to close status 1004. Still undefined. Reserved value.
</td>
</tr>
</table>
</div>
<h2 class="Section">Requirements</h2>
<div class="SectionBox" id="T:WebSocketSharp.CloseStatusCode: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.CloseStatusCode:Members">
</div>
<hr size="1" />
<div class="Copyright">
</div>
</body>
</html>