844 lines
39 KiB
HTML
844 lines
39 KiB
HTML
<html>
|
|
<head>
|
|
<title>WebSocketSharp.Server.WebSocketServerBase</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.WebSocketServerBase">Overview</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.WebSocketServerBase:Signature">Signature</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.WebSocketServerBase:Docs">Remarks</a>
|
|
</p>
|
|
<p>
|
|
<a href="#Members">Members</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.WebSocketServerBase:Members">Member Details</a>
|
|
</p>
|
|
</div>
|
|
<h1 class="PageTitle" id="T:WebSocketSharp.Server.WebSocketServerBase">WebSocketServerBase Class</h1>
|
|
<p class="Summary" id="T:WebSocketSharp.Server.WebSocketServerBase:Summary">
|
|
Provides the basic functions of the server that receives the WebSocket connection requests.
|
|
</p>
|
|
<div id="T:WebSocketSharp.Server.WebSocketServerBase:Signature">
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public abstract class <b>WebSocketServerBase</b></div>
|
|
</div>
|
|
<div class="Remarks" id="T:WebSocketSharp.Server.WebSocketServerBase:Docs">
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="T:WebSocketSharp.Server.WebSocketServerBase:Docs:Remarks">
|
|
The WebSocketServerBase class is an abstract class.
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="T:WebSocketSharp.Server.WebSocketServerBase: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">Protected Constructors</h2>
|
|
<div class="SectionBox" id="Protected Constructors">
|
|
<div class="SubsectionBox">
|
|
<table class="TypeMembers">
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<b>
|
|
<a href="#C:WebSocketSharp.Server.WebSocketServerBase">WebSocketServerBase</a>
|
|
</b>()</div>
|
|
</td>
|
|
<td>
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketSharp.Server.WebSocketServerBase</a> class.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<b>
|
|
<a href="#C:WebSocketSharp.Server.WebSocketServerBase(System.String)">WebSocketServerBase</a>
|
|
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)</div>
|
|
</td>
|
|
<td>
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketSharp.Server.WebSocketServerBase</a> class that listens for incoming connection attempts
|
|
on the specified WebSocket URL.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<b>
|
|
<a href="#C:WebSocketSharp.Server.WebSocketServerBase(System.Net.IPAddress,System.Int32,System.String,System.Boolean)">WebSocketServerBase</a>
|
|
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>)</div>
|
|
</td>
|
|
<td>
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketSharp.Server.WebSocketServerBase</a> class that listens for incoming connection attempts
|
|
on the specified <i>address</i>, <i>port</i>, <i>absPath</i> and <i>secure</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.WebSocketServerBase.Address">Address</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
<i>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a>
|
|
</i>.
|
|
Gets the local IP address on which to listen for incoming connection attempts.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>[read-only]<div></div></td>
|
|
<td>
|
|
<b>
|
|
<a href="#P:WebSocketSharp.Server.WebSocketServerBase.IsSecure">IsSecure</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
<i>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
|
|
</i>.
|
|
Gets a value indicating whether the server provides secure connection.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>[read-only]<div></div></td>
|
|
<td>
|
|
<b>
|
|
<a href="#P:WebSocketSharp.Server.WebSocketServerBase.IsSelfHost">IsSelfHost</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
<i>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>
|
|
</i>.
|
|
Gets a value indicating whether the server is self host.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>[read-only]<div></div></td>
|
|
<td>
|
|
<b>
|
|
<a href="#P:WebSocketSharp.Server.WebSocketServerBase.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 connection attempts.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h2 class="Section">Protected Properties</h2>
|
|
<div class="SectionBox" id="Protected Properties">
|
|
<div class="SubsectionBox">
|
|
<table class="TypeMembers">
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<b>
|
|
<a href="#P:WebSocketSharp.Server.WebSocketServerBase.BaseUri">BaseUri</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
<i>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Uri">Uri</a>
|
|
</i>.
|
|
Gets or sets the WebSocket URL on which to listen for incoming connection attempts.
|
|
</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.WebSocketServerBase.Start">Start</a>
|
|
</b>()<blockquote>
|
|
Starts to receive the WebSocket connection requests.
|
|
</blockquote></td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.WebSocketServerBase.Stop">Stop</a>
|
|
</b>()<blockquote>
|
|
Stops receiving the WebSocket connection requests.
|
|
</blockquote></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h2 class="Section">Protected Methods</h2>
|
|
<div class="SectionBox" id="Protected Methods">
|
|
<div class="SubsectionBox">
|
|
<table class="TypeMembers">
|
|
<tr valign="top">
|
|
<td>
|
|
<div>abstract </div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket</a>
|
|
</b>(<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a>)<blockquote>
|
|
Accepts a WebSocket connection.
|
|
</blockquote></td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String)">Error</a>
|
|
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
|
|
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</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.WebSocketServerBase.OnError">OnError</a>
|
|
</b>
|
|
</td>
|
|
<td>
|
|
Occurs when the server gets an error.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h2 class="Section">Extension Methods</h2>
|
|
<div class="SectionBox" id="Extension Methods">
|
|
<div class="SubsectionBox">
|
|
<table class="TypeMembers">
|
|
<tr valign="top">
|
|
<td>
|
|
<div>static </div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="../WebSocketSharp/Ext.html#M:WebSocketSharp.Ext.IsNull``1(``0)">IsNull<T></a>
|
|
</b>(<i>this</i> <i title="
 The type of the parameter.
 ">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>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>static </div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="../WebSocketSharp/Ext.html#M:WebSocketSharp.Ext.IsNullDo``1(``0,System.Action)">IsNullDo<T></a>
|
|
</b>(<i>this</i> <i title="
 The type of the parameter.
 ">T</i>, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Action">Action</a>)<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>.
|
|
And invokes the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Action">Action</a> delegate if the specified object is <tt>null</tt>.
|
|
</blockquote></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="Members" id="T:WebSocketSharp.Server.WebSocketServerBase:Members">
|
|
<h2 class="Section" id="MemberDetails">Member Details</h2>
|
|
<div class="SectionBox" id="_MemberDetails">
|
|
<h3 id="C:WebSocketSharp.Server.WebSocketServerBase">WebSocketServerBase Constructor</h3>
|
|
<blockquote id="C:WebSocketSharp.Server.WebSocketServerBase:member">
|
|
<p class="Summary">
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketSharp.Server.WebSocketServerBase</a> class.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">protected <b>WebSocketServerBase</b> ()</div>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="C:WebSocketSharp.Server.WebSocketServerBase: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.WebSocketServerBase: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.WebSocketServerBase(System.String)">WebSocketServerBase Constructor</h3>
|
|
<blockquote id="C:WebSocketSharp.Server.WebSocketServerBase(System.String):member">
|
|
<p class="Summary">
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketSharp.Server.WebSocketServerBase</a> class that listens for incoming connection attempts
|
|
on the specified WebSocket URL.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">protected <b>WebSocketServerBase</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> url)</div>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="C:WebSocketSharp.Server.WebSocketServerBase(System.String):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>url</i>
|
|
</dt>
|
|
<dd>
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains a WebSocket URL.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h4 class="Subsection">Exceptions</h4>
|
|
<blockquote class="SubsectionBox" id="C:WebSocketSharp.Server.WebSocketServerBase(System.String):Exceptions">
|
|
<table class="TypeDocumentation">
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Reason</th>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.ArgumentNullException">ArgumentNullException</a>
|
|
</td>
|
|
<td>
|
|
<i>url</i> is <tt>null</tt>.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.ArgumentException">ArgumentException</a>
|
|
</td>
|
|
<td>
|
|
<i>url</i> is invalid.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="C:WebSocketSharp.Server.WebSocketServerBase(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="C:WebSocketSharp.Server.WebSocketServerBase(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="C:WebSocketSharp.Server.WebSocketServerBase(System.Net.IPAddress,System.Int32,System.String,System.Boolean)">WebSocketServerBase Constructor</h3>
|
|
<blockquote id="C:WebSocketSharp.Server.WebSocketServerBase(System.Net.IPAddress,System.Int32,System.String,System.Boolean):member">
|
|
<p class="Summary">
|
|
Initializes a new instance of the <a href="../WebSocketSharp.Server/WebSocketServerBase.html">WebSocketSharp.Server.WebSocketServerBase</a> class that listens for incoming connection attempts
|
|
on the specified <i>address</i>, <i>port</i>, <i>absPath</i> and <i>secure</i>.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">protected <b>WebSocketServerBase</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> address, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32">int</a> port, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> absPath, <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> secure)</div>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="C:WebSocketSharp.Server.WebSocketServerBase(System.Net.IPAddress,System.Int32,System.String,System.Boolean):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>address</i>
|
|
</dt>
|
|
<dd>
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains a local IP address.
|
|
</dd>
|
|
<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>
|
|
<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.
|
|
</dd>
|
|
<dt>
|
|
<i>secure</i>
|
|
</dt>
|
|
<dd>
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> that indicates providing a secure connection or not. (<tt>true</tt> indicates providing a secure connection.)
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h4 class="Subsection">Exceptions</h4>
|
|
<blockquote class="SubsectionBox" id="C:WebSocketSharp.Server.WebSocketServerBase(System.Net.IPAddress,System.Int32,System.String,System.Boolean):Exceptions">
|
|
<table class="TypeDocumentation">
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Reason</th>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.ArgumentNullException">ArgumentNullException</a>
|
|
</td>
|
|
<td>
|
|
Either <i>address</i> or <i>absPath</i> is <tt>null</tt>.
|
|
</td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.ArgumentException">ArgumentException</a>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<i>absPath</i> is invalid.
|
|
</p>
|
|
<p>
|
|
-or-
|
|
</p>
|
|
<p>
|
|
Pair of <i>port</i> and <i>secure</i> is invalid.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="C:WebSocketSharp.Server.WebSocketServerBase(System.Net.IPAddress,System.Int32,System.String,System.Boolean):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.WebSocketServerBase(System.Net.IPAddress,System.Int32,System.String,System.Boolean):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.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)">AcceptWebSocket Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):member">
|
|
<p class="Summary">
|
|
Accepts a WebSocket connection.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">protected abstract <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>AcceptWebSocket</b> (<a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> context)</div>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>context</i>
|
|
</dt>
|
|
<dd>
|
|
A <a href="../WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html">WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext</a> that contains the WebSocket connection request objects.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):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.WebSocketServerBase.AcceptWebSocket(WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext):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.WebSocketServerBase.Address">Address Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.WebSocketServerBase.Address:member">
|
|
<p class="Summary">
|
|
Gets the local IP address on which to listen for incoming connection attempts.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> <b>Address</b> { get; }</div>
|
|
<h4 class="Subsection">Value</h4>
|
|
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.Address:Value">
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Net.IPAddress">System.Net.IPAddress</a> that contains a local IP address.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.Address: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.WebSocketServerBase.Address: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.WebSocketServerBase.BaseUri">BaseUri Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.WebSocketServerBase.BaseUri:member">
|
|
<p class="Summary">
|
|
Gets or sets the WebSocket URL on which to listen for incoming connection attempts.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">protected <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Uri">Uri</a> <b>BaseUri</b> { get; set; }</div>
|
|
<h4 class="Subsection">Value</h4>
|
|
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.BaseUri:Value">
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Uri">Uri</a> that contains a WebSocket URL.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.BaseUri: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.WebSocketServerBase.BaseUri: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.WebSocketServerBase.Error(System.String)">Error Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String):member">
|
|
<p class="Summary">
|
|
Occurs the <a href="../WebSocketSharp.Server/WebSocketServerBase.html#E:WebSocketSharp.Server.WebSocketServerBase.OnError">WebSocketServerBase.OnError</a> event with the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">protected virtual <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Error</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> message)</div>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.Error(System.String):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>message</i>
|
|
</dt>
|
|
<dd>
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> that contains an error message.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.WebSocketServerBase.Error(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.WebSocketServerBase.Error(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="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure">IsSecure Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure:member">
|
|
<p class="Summary">
|
|
Gets a value indicating whether the server provides secure connection.
|
|
</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>
|
|
<h4 class="Subsection">Value</h4>
|
|
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure:Value">
|
|
<tt>true</tt> if the server provides secure connection; otherwise, <tt>false</tt>.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.IsSecure: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.WebSocketServerBase.IsSecure: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.WebSocketServerBase.IsSelfHost">IsSelfHost Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.WebSocketServerBase.IsSelfHost:member">
|
|
<p class="Summary">
|
|
Gets a value indicating whether the server is self host.
|
|
</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>IsSelfHost</b> { get; }</div>
|
|
<h4 class="Subsection">Value</h4>
|
|
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.IsSelfHost:Value">
|
|
<tt>true</tt> if the server is self host; otherwise, <tt>false</tt>.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="P:WebSocketSharp.Server.WebSocketServerBase.IsSelfHost: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.WebSocketServerBase.IsSelfHost: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.WebSocketServerBase.OnError">OnError Event</h3>
|
|
<blockquote id="E:WebSocketSharp.Server.WebSocketServerBase.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.WebSocketServerBase.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.WebSocketServerBase.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="P:WebSocketSharp.Server.WebSocketServerBase.Port">Port Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.WebSocketServerBase.Port:member">
|
|
<p class="Summary">
|
|
Gets the port on which to listen for incoming connection attempts.
|
|
</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.WebSocketServerBase.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.WebSocketServerBase.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.WebSocketServerBase.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="M:WebSocketSharp.Server.WebSocketServerBase.Start">Start Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.WebSocketServerBase.Start:member">
|
|
<p class="Summary">
|
|
Starts to receive the WebSocket connection requests.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public virtual <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.WebSocketServerBase.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.WebSocketServerBase.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.WebSocketServerBase.Stop">Stop Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.WebSocketServerBase.Stop:member">
|
|
<p class="Summary">
|
|
Stops receiving the WebSocket connection requests.
|
|
</p>
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public virtual <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.WebSocketServerBase.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.WebSocketServerBase.Stop: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> |