524 lines
17 KiB
HTML
524 lines
17 KiB
HTML
<html>
|
|
<head>
|
|
<title>websocket-sharp</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">
|
|
</div>
|
|
<h1 class="PageTitle">websocket-sharp</h1>
|
|
<p class="Summary">
|
|
<div class="AssemblyRemarks" style="margin-top: 1em; margin-bottom: 1em">A C# implementation of the WebSocket protocol client & server.</div>
|
|
</p>
|
|
<div>
|
|
</div>
|
|
<div class="Remarks">
|
|
<h2 class="Section">
|
|
<a href="WebSocketSharp/index.html">WebSocketSharp Namespace</a>
|
|
</h2>
|
|
<p>The WebSocketSharp namespace contains classes and enumerations to implement the WebSocket interface.</p>
|
|
<table class="TypesListing" style="margin-top: 1em">
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/ByteOrder.html">ByteOrder</a>
|
|
</td>
|
|
<td>
|
|
Contains the values that indicate whether the byte order is a Little-endian or Big-endian.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/CloseEventArgs.html">CloseEventArgs</a>
|
|
</td>
|
|
<td>
|
|
Contains the event data associated with a <a href="./WebSocketSharp/WebSocket.html#E:WebSocketSharp.WebSocket.OnClose">WebSocketSharp.WebSocket.OnClose</a> event.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/CloseStatusCode.html">CloseStatusCode</a>
|
|
</td>
|
|
<td>
|
|
Contains the values of the status codes for the WebSocket connection closure.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/ErrorEventArgs.html">ErrorEventArgs</a>
|
|
</td>
|
|
<td>
|
|
Contains the event data associated with a error event.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/Ext.html">Ext</a>
|
|
</td>
|
|
<td>
|
|
Provides a set of static methods for the websocket-sharp.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/MessageEventArgs.html">MessageEventArgs</a>
|
|
</td>
|
|
<td>
|
|
Contains the event data associated with a <a href="./WebSocketSharp/WebSocket.html#E:WebSocketSharp.WebSocket.OnMessage">WebSocketSharp.WebSocket.OnMessage</a> event.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/Opcode.html">Opcode</a>
|
|
</td>
|
|
<td>
|
|
Contains the values of the opcodes that denotes the frame type of the WebSocket frame.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/WebSocket.html">WebSocket</a>
|
|
</td>
|
|
<td>
|
|
Implements the WebSocket interface.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/WsReceivedTooBigMessageException.html">WsReceivedTooBigMessageException</a>
|
|
</td>
|
|
<td>
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp/WsState.html">WsState</a>
|
|
</td>
|
|
<td>
|
|
Contains the values of the state of the WebSocket connection.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="Section">
|
|
<a href="WebSocketSharp.Net/index.html">WebSocketSharp.Net Namespace</a>
|
|
</h2>
|
|
<p>The WebSocketSharp.Net namespace contains some modified classes and enumerations in the System.Net namespace (e.g. <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.HttpListenerContext">System.Net.HttpListenerContext</a>) to accept the WebSocket connection requests.</p>
|
|
<table class="TypesListing" style="margin-top: 1em">
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/AuthenticationSchemes.html">AuthenticationSchemes</a>
|
|
</td>
|
|
<td>
|
|
Contains the values of the schemes for authentication.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/AuthenticationSchemeSelector.html">AuthenticationSchemeSelector</a>
|
|
</td>
|
|
<td>
|
|
Selects the authentication scheme for a <a href="./WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> instance.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/Cookie.html">Cookie</a>
|
|
</td>
|
|
<td>
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/CookieCollection.html">CookieCollection</a>
|
|
</td>
|
|
<td>
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/CookieException.html">CookieException</a>
|
|
</td>
|
|
<td>
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/HttpListener.html">HttpListener</a>
|
|
</td>
|
|
<td>
|
|
Provides a simple, programmatically controlled HTTP listener.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/HttpListenerContext.html">HttpListenerContext</a>
|
|
</td>
|
|
<td>
|
|
Provides access to the HTTP request and response objects used by the <a href="./WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> class.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/HttpListenerException.html">HttpListenerException</a>
|
|
</td>
|
|
<td>
|
|
The exception that is thrown when an error occurs processing an HTTP request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/HttpListenerPrefixCollection.html">HttpListenerPrefixCollection</a>
|
|
</td>
|
|
<td>
|
|
Provides the collection used to store the URI prefixes for the <a href="./WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a>.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/HttpListenerRequest.html">HttpListenerRequest</a>
|
|
</td>
|
|
<td>
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/HttpListenerResponse.html">HttpListenerResponse</a>
|
|
</td>
|
|
<td>
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/HttpStatusCode.html">HttpStatusCode</a>
|
|
</td>
|
|
<td>
|
|
Contains the values of the HTTP status codes.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/HttpVersion.html">HttpVersion</a>
|
|
</td>
|
|
<td>
|
|
Provides the HTTP version numbers.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net/WebHeaderCollection.html">WebHeaderCollection</a>
|
|
</td>
|
|
<td>
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="Section">
|
|
<a href="WebSocketSharp.Net.WebSockets/index.html">WebSocketSharp.Net.WebSockets Namespace</a>
|
|
</h2>
|
|
<p>The WebSocketSharp.Net.WebSockets namespace contains classes to access to the WebSocket connection request objects.</p>
|
|
<table class="TypesListing" style="margin-top: 1em">
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.html">HttpListenerWebSocketContext</a>
|
|
</td>
|
|
<td>
|
|
Provides access to the WebSocket connection request objects received by the <a href="./WebSocketSharp.Net/HttpListener.html">WebSocketSharp.Net.HttpListener</a> class.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">TcpListenerWebSocketContext</a>
|
|
</td>
|
|
<td>
|
|
Provides access to the WebSocket connection request objects received by the <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.Sockets.TcpListener">System.Net.Sockets.TcpListener</a> class.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Net.WebSockets/WebSocketContext.html">WebSocketContext</a>
|
|
</td>
|
|
<td>
|
|
Provides access to the WebSocket connection request objects.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="Section">
|
|
<a href="WebSocketSharp.Server/index.html">WebSocketSharp.Server Namespace</a>
|
|
</h2>
|
|
<p>The WebSocketSharp.Server namespace contains classes to implement the server that receives the WebSocket connection requests.</p>
|
|
<table class="TypesListing" style="margin-top: 1em">
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Server/HttpRequestEventArgs.html">HttpRequestEventArgs</a>
|
|
</td>
|
|
<td>
|
|
Contains the event data associated with the HTTP request events of the <a href="./WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a> class.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Server/HttpServer.html">HttpServer</a>
|
|
</td>
|
|
<td>
|
|
Provides a simple HTTP server that allows to accept the WebSocket connection requests.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Server/IServiceHost.html">IServiceHost</a>
|
|
</td>
|
|
<td>
|
|
Exposes the methods and property for the host that provides a <a href="./WebSocketSharp.Server/WebSocketService.html">WebSocketSharp.Server.WebSocketService</a>.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Server/WebSocketServer.html">WebSocketServer</a>
|
|
</td>
|
|
<td>
|
|
Provides the functions of the server that receives the WebSocket connection requests.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Server/WebSocketServerBase.html">WebSocketServerBase</a>
|
|
</td>
|
|
<td>
|
|
Provides the basic functions of the server that receives the WebSocket connection requests.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Server/WebSocketService.html">WebSocketService</a>
|
|
</td>
|
|
<td>
|
|
Provides the basic functions of the WebSocket service.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Server/WebSocketServiceHost`1.html">WebSocketServiceHost<T></a>
|
|
</td>
|
|
<td>
|
|
Provides the functions of the server that receives the WebSocket connection requests.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="WebSocketSharp.Server/WebSocketServiceManager.html">WebSocketServiceManager</a>
|
|
</td>
|
|
<td>
|
|
Manages the collection of <a href="./WebSocketSharp.Server/WebSocketService.html">WebSocketSharp.Server.WebSocketService</a> objects.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="Members">
|
|
</div>
|
|
<hr size="1" />
|
|
<div class="Copyright">Copyright (c) 2010-2013 sta.blockhead</div>
|
|
</body>
|
|
</html> |