931 lines
40 KiB
HTML
931 lines
40 KiB
HTML
<html>
|
|
<head>
|
|
<title>WebSocketSharp.Server.HttpServer</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.Server Namespace</a></div>
|
|
<div class="SideBar">
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.HttpServer">Overview</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.HttpServer:Signature">Signature</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.HttpServer:Docs">Remarks</a>
|
|
</p>
|
|
<p>
|
|
<a href="#Members">Members</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.HttpServer:Members">Member Details</a>
|
|
</p>
|
|
</div>
|
|
<h1 class="PageTitle" id="T:WebSocketSharp.Server.HttpServer">HttpServer Class</h1>
|
|
<p class="Summary" id="T:WebSocketSharp.Server.HttpServer:Summary">
|
|
Provides a simple HTTP server that allows to accept the WebSocket connection requests.
|
|
</p>
|
|
<div id="T:WebSocketSharp.Server.HttpServer:Signature">
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public class <b>HttpServer</b></div>
|
|
</div>
|
|
<div class="Remarks" id="T:WebSocketSharp.Server.HttpServer:Docs">
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="T:WebSocketSharp.Server.HttpServer:Docs:Remarks">
|
|
<p>
|
|
The HttpServer class provides the multi WebSocket service.
|
|
</p>
|
|
<p>
|
|
<p>
|
|
The HttpServer class needs the application configuration file to configure the server root path.
|
|
</p>
|
|
<table class="CodeExampleTable">
|
|
<tr>
|
|
<td>
|
|
<b>
|
|
<font size="-1">xml Example</font>
|
|
</b>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<pre class="">
|
|
<?xml version="1.0" encoding="utf-8"?>
|
|
<configuration>
|
|
<appSettings>
|
|
<add key="RootPath" value="./Public" />
|
|
</appSettings>
|
|
</configuration>
|
|
</pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</p>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="T:WebSocketSharp.Server.HttpServer:Docs:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<h2 class="Section" id="Members">Members</h2>
|
|
<div class="SectionBox" id="_Members">
|
|
<p>
|
|
See Also: Inherited members from
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Object">object</a>.
|
|
</p>
|
|
<h2 class="Section">Public Constructors</h2>
|
|
<div class="SectionBox" id="Public Constructors">
|
|
<div class="SubsectionBox">
|
|
<table class="TypeMembers">
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<b>
|
|
<a href="#C:WebSocketSharp.Server.HttpServer">HttpServer</a>
|
|
</b>()</div>
|
|
</td>
|
|
<td>
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a> class that listens for incoming requests
|
|
on port 80.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<b>
|
|
<a href="#C:WebSocketSharp.Server.HttpServer(System.Int32)">HttpServer</a>
|
|
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>)</div>
|
|
</td>
|
|
<td>
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a> class that listens for incoming requests
|
|
on the specified <i>port</i>.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h2 class="Section">Public Properties</h2>
|
|
<div class="SectionBox" id="Public Properties">
|
|
<div class="SubsectionBox">
|
|
<table class="TypeMembers">
|
|
<tr valign="top">
|
|
<td>[read-only]<div></div></td>
|
|
<td>
|
|
<b>
|
|
<a href="#P:WebSocketSharp.Server.HttpServer.Port">Port</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
<i>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>
|
|
</i>.
|
|
Gets the port on which to listen for incoming requests.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>[read-only]<div></div></td>
|
|
<td>
|
|
<b>
|
|
<a href="#P:WebSocketSharp.Server.HttpServer.ServicePaths">ServicePaths</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
<i>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Collections.Generic.IEnumerable`1">IEnumerable<string></a>
|
|
</i>.
|
|
Gets the collection of paths associated with the every WebSocket services that the server provides.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#P:WebSocketSharp.Server.HttpServer.Sweeping">Sweeping</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
<i>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
|
|
</i>.
|
|
Gets or sets a value indicating whether the server cleans up the inactive WebSocket service
|
|
instances periodically.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h2 class="Section">Public Methods</h2>
|
|
<div class="SectionBox" id="Public Methods">
|
|
<div class="SubsectionBox">
|
|
<table class="TypeMembers">
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String)">AddWebSocketService<T></a>
|
|
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
|
|
Adds the specified type WebSocket service.
|
|
</blockquote></td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.HttpServer.GetFile(System.String)">GetFile</a>
|
|
</b>(<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.Byte">byte</a>[]</nobr><blockquote>
|
|
Gets the contents of the specified file.
|
|
</blockquote></td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.HttpServer.Start">Start</a>
|
|
</b>()<blockquote>
|
|
Starts the <a href="../WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a>.
|
|
</blockquote></td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.HttpServer.Stop">Stop</a>
|
|
</b>()<blockquote>
|
|
Shuts down the <a href="../WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a>.
|
|
</blockquote></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h2 class="Section">Public Events</h2>
|
|
<div class="SectionBox" id="Public Events">
|
|
<div class="SubsectionBox">
|
|
<table class="TypeMembers">
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnConnect">OnConnect</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP CONNECT request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnDelete">OnDelete</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP DELETE request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnError">OnError</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server gets an error.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnGet">OnGet</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP GET request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnHead">OnHead</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP HEAD request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnOptions">OnOptions</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP OPTIONS request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnPatch">OnPatch</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP PATCH request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnPost">OnPost</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP POST request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnPut">OnPut</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP PUT request.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#E:WebSocketSharp.Server.HttpServer.OnTrace">OnTrace</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server receives an HTTP TRACE request.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="Members" id="T:WebSocketSharp.Server.HttpServer:Members">
|
|
<h2 class="Section" id="MemberDetails">Member Details</h2>
|
|
<div class="SectionBox" id="_MemberDetails">
|
|
<h3 id="C:WebSocketSharp.Server.HttpServer">HttpServer Constructor</h3>
|
|
<blockquote id="C:WebSocketSharp.Server.HttpServer:member">
|
|
<p class="Summary">
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a> class that listens for incoming requests
|
|
on port 80.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public <b>HttpServer</b> ()</div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="C:WebSocketSharp.Server.HttpServer:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="C:WebSocketSharp.Server.HttpServer:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="C:WebSocketSharp.Server.HttpServer(System.Int32)">HttpServer Constructor</h3>
|
|
<blockquote id="C:WebSocketSharp.Server.HttpServer(System.Int32):member">
|
|
<p class="Summary">
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a> class that listens for incoming requests
|
|
on the specified <i>port</i>.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public <b>HttpServer</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> port)</div>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="C:WebSocketSharp.Server.HttpServer(System.Int32):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>port</i>
|
|
</dt>
|
|
<dd>
|
|
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> that contains a port number.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="C:WebSocketSharp.Server.HttpServer(System.Int32):Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="C:WebSocketSharp.Server.HttpServer(System.Int32):Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String)">AddWebSocketService<T> Generic Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String):member">
|
|
<p class="Summary">
|
|
Adds the specified type WebSocket service.
|
|
</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>AddWebSocketService<T></b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> absPath)<br /> where T : <a href="../WebSocketSharp.Server/WebSocketService.html">WebSocketSharp.Server.WebSocketService</a>, new()</div>
|
|
<h4 class="Subsection">Type Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String):Type Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>T</i>
|
|
</dt>
|
|
<dd>
|
|
The type of the WebSocket service. The T must inherit the <a href="../WebSocketSharp.Server/WebSocketService.html">WebSocketSharp.Server.WebSocketService</a> class.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>absPath</i>
|
|
</dt>
|
|
<dd>
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains an absolute path associated with the WebSocket service.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String):Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String):Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="M:WebSocketSharp.Server.HttpServer.GetFile(System.String)">GetFile Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.HttpServer.GetFile(System.String):member">
|
|
<p class="Summary">
|
|
Gets the contents of the specified file.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Byte">byte</a>[] <b>GetFile</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> path)</div>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.HttpServer.GetFile(System.String):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>path</i>
|
|
</dt>
|
|
<dd>
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains a virtual path to the file to get.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h4 class="Subsection">Returns</h4>
|
|
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.HttpServer.GetFile(System.String):Returns">
|
|
An array of <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Byte">byte</a> that contains the contents of the file.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.HttpServer.GetFile(System.String):Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.HttpServer.GetFile(System.String):Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnConnect">OnConnect Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnConnect:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP CONNECT request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnConnect</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnConnect:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnConnect:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnDelete">OnDelete Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnDelete:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP DELETE request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnDelete</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnDelete:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnDelete:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnError">OnError Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnError:member">
|
|
<p class="Summary">
|
|
Occurs when the server gets an error.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<WebSocketSharp.ErrorEventArgs></a> <b>OnError</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnError:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnError:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnGet">OnGet Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnGet:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP GET request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnGet</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnGet:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnGet:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnHead">OnHead Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnHead:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP HEAD request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnHead</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnHead:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnHead:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnOptions">OnOptions Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnOptions:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP OPTIONS request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnOptions</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnOptions:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnOptions:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnPatch">OnPatch Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnPatch:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP PATCH request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnPatch</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnPatch:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnPatch:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnPost">OnPost Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnPost:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP POST request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnPost</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnPost:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnPost:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnPut">OnPut Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnPut:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP PUT request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnPut</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnPut:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnPut:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="E:WebSocketSharp.Server.HttpServer.OnTrace">OnTrace Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.HttpServer.OnTrace:member">
|
|
<p class="Summary">
|
|
Occurs when the server receives an HTTP TRACE request.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public event <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.EventHandler`1">EventHandler<HttpRequestEventArgs></a> <b>OnTrace</b> </div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnTrace:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="E:WebSocketSharp.Server.HttpServer.OnTrace:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="P:WebSocketSharp.Server.HttpServer.Port">Port Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.HttpServer.Port:member">
|
|
<p class="Summary">
|
|
Gets the port on which to listen for incoming requests.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> <b>Port</b> { get; }</div>
|
|
<h4 class="Subsection">Value</h4>
|
|
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.HttpServer.Port:Value">
|
|
An <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> that contains a port number.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="P:WebSocketSharp.Server.HttpServer.Port: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.Server.HttpServer.Port:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="P:WebSocketSharp.Server.HttpServer.ServicePaths">ServicePaths Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.HttpServer.ServicePaths:member">
|
|
<p class="Summary">
|
|
Gets the collection of paths associated with the every WebSocket services that the server provides.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Collections.Generic.IEnumerable`1">IEnumerable<string></a> <b>ServicePaths</b> { get; }</div>
|
|
<h4 class="Subsection">Value</h4>
|
|
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.HttpServer.ServicePaths:Value">
|
|
An IEnumerable<string> that contains the collection of paths.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="P:WebSocketSharp.Server.HttpServer.ServicePaths: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.Server.HttpServer.ServicePaths:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="M:WebSocketSharp.Server.HttpServer.Start">Start Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.HttpServer.Start:member">
|
|
<p class="Summary">
|
|
Starts the <a href="../WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a>.
|
|
</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>Start</b> ()</div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.HttpServer.Start:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.HttpServer.Start:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="M:WebSocketSharp.Server.HttpServer.Stop">Stop Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.HttpServer.Stop:member">
|
|
<p class="Summary">
|
|
Shuts down the <a href="../WebSocketSharp.Server/HttpServer.html">WebSocketSharp.Server.HttpServer</a>.
|
|
</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>Stop</b> ()</div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.HttpServer.Stop:Remarks">
|
|
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.HttpServer.Stop:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
<h3 id="P:WebSocketSharp.Server.HttpServer.Sweeping">Sweeping Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.HttpServer.Sweeping:member">
|
|
<p class="Summary">
|
|
Gets or sets a value indicating whether the server cleans up the inactive WebSocket service
|
|
instances periodically.
|
|
</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>Sweeping</b> { get; set; }</div>
|
|
<h4 class="Subsection">Value</h4>
|
|
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.HttpServer.Sweeping:Value">
|
|
<tt>true</tt> if the server cleans up the inactive WebSocket service instances every 60 seconds;
|
|
otherwise, <tt>false</tt>. The default value is <tt>true</tt>.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="P:WebSocketSharp.Server.HttpServer.Sweeping: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.Server.HttpServer.Sweeping:Version Information">
|
|
<b>Namespace: </b>WebSocketSharp.Server<br /><b>Assembly: </b>websocket-sharp (in websocket-sharp.dll)</div>
|
|
<hr size="1" />
|
|
</blockquote>
|
|
</div>
|
|
</div>
|
|
<hr size="1" />
|
|
<div class="Copyright">
|
|
</div>
|
|
</body>
|
|
</html> |