451 lines
17 KiB
HTML
451 lines
17 KiB
HTML
<html>
|
|
<head>
|
|
<title>WebSocketSharp.Server.IServiceHost</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.IServiceHost">Overview</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.IServiceHost:Signature">Signature</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.IServiceHost:Docs">Remarks</a>
|
|
</p>
|
|
<p>
|
|
<a href="#Members">Members</a>
|
|
</p>
|
|
<p>
|
|
<a href="#T:WebSocketSharp.Server.IServiceHost:Members">Member Details</a>
|
|
</p>
|
|
</div>
|
|
<h1 class="PageTitle" id="T:WebSocketSharp.Server.IServiceHost">IServiceHost Interface</h1>
|
|
<p class="Summary" id="T:WebSocketSharp.Server.IServiceHost:Summary">
|
|
Exposes the methods and property for the WebSocket service host.
|
|
</p>
|
|
<div id="T:WebSocketSharp.Server.IServiceHost:Signature">
|
|
<h2>Syntax</h2>
|
|
<div class="Signature">public interface <b>IServiceHost</b></div>
|
|
</div>
|
|
<div class="Remarks" id="T:WebSocketSharp.Server.IServiceHost:Docs">
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="T:WebSocketSharp.Server.IServiceHost:Docs:Remarks">
|
|
</div>
|
|
<h2 class="Section">Requirements</h2>
|
|
<div class="SectionBox" id="T:WebSocketSharp.Server.IServiceHost: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">
|
|
<h2 class="Section">Public Properties</h2>
|
|
<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.Server.IServiceHost.Sweeped">Sweeped</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 WebSocket service host cleans up the inactive service client.
|
|
</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.IServiceHost.BindWebSocket(WebSocketSharp.WebSocket)">BindWebSocket</a>
|
|
</b>(<a href="../WebSocketSharp/WebSocket.html">WebSocketSharp.WebSocket</a>)<blockquote>
|
|
Binds the specified <a href="../WebSocketSharp/WebSocket.html">WebSocketSharp.WebSocket</a> instance to the WebSocket service.
|
|
</blockquote></td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.IServiceHost.Broadcast(System.String)">Broadcast</a>
|
|
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)<blockquote>
|
|
Broadcasts the specified <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>.
|
|
</blockquote></td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.IServiceHost.Start">Start</a>
|
|
</b>()<blockquote>
|
|
Starts the WebSocket service host.
|
|
</blockquote></td>
|
|
</tr>
|
|
<tr valign="top">
|
|
<td>
|
|
<div>
|
|
</div>
|
|
</td>
|
|
<td colspan="2">
|
|
<b>
|
|
<a href="#M:WebSocketSharp.Server.IServiceHost.Stop">Stop</a>
|
|
</b>()<blockquote>
|
|
Stops the WebSocket service host.
|
|
</blockquote></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.IServiceHost:Members">
|
|
<h2 class="Section" id="MemberDetails">Member Details</h2>
|
|
<div class="SectionBox" id="_MemberDetails">
|
|
<h3 id="M:WebSocketSharp.Server.IServiceHost.BindWebSocket(WebSocketSharp.WebSocket)">BindWebSocket Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.IServiceHost.BindWebSocket(WebSocketSharp.WebSocket):member">
|
|
<p class="Summary">
|
|
Binds the specified <a href="../WebSocketSharp/WebSocket.html">WebSocketSharp.WebSocket</a> instance to the 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>BindWebSocket</b> (<a href="../WebSocketSharp/WebSocket.html">WebSocketSharp.WebSocket</a> socket)</div>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.IServiceHost.BindWebSocket(WebSocketSharp.WebSocket):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>socket</i>
|
|
</dt>
|
|
<dd>
|
|
An <a href="../WebSocketSharp/WebSocket.html">WebSocketSharp.WebSocket</a> to bind.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.IServiceHost.BindWebSocket(WebSocketSharp.WebSocket):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.IServiceHost.BindWebSocket(WebSocketSharp.WebSocket):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.IServiceHost.Broadcast(System.String)">Broadcast Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.IServiceHost.Broadcast(System.String):member">
|
|
<p class="Summary">
|
|
Broadcasts 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">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Broadcast</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> data)</div>
|
|
<h4 class="Subsection">Parameters</h4>
|
|
<blockquote class="SubsectionBox" id="M:WebSocketSharp.Server.IServiceHost.Broadcast(System.String):Parameters">
|
|
<dl>
|
|
<dt>
|
|
<i>data</i>
|
|
</dt>
|
|
<dd>
|
|
A <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> to broadcast.
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="M:WebSocketSharp.Server.IServiceHost.Broadcast(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.IServiceHost.Broadcast(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.IServiceHost.Start">Start Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.IServiceHost.Start:member">
|
|
<p class="Summary">
|
|
Starts the WebSocket service host.
|
|
</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.IServiceHost.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.IServiceHost.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.IServiceHost.Stop">Stop Method</h3>
|
|
<blockquote id="M:WebSocketSharp.Server.IServiceHost.Stop:member">
|
|
<p class="Summary">
|
|
Stops the WebSocket service host.
|
|
</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.IServiceHost.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.IServiceHost.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.IServiceHost.Sweeped">Sweeped Property</h3>
|
|
<blockquote id="P:WebSocketSharp.Server.IServiceHost.Sweeped:member">
|
|
<p class="Summary">
|
|
Gets or sets a value indicating whether the WebSocket service host cleans up the inactive service client.
|
|
</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>Sweeped</b> { get; set; }</div>
|
|
<h4 class="Subsection">Value</h4>
|
|
<blockquote class="SubsectionBox" id="P:WebSocketSharp.Server.IServiceHost.Sweeped:Value">
|
|
<tt>true</tt> if the WebSocket service host cleans up the inactive service client; otherwise, <tt>false</tt>.
|
|
</blockquote>
|
|
<h2 class="Section">Remarks</h2>
|
|
<div class="SectionBox" id="P:WebSocketSharp.Server.IServiceHost.Sweeped: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.IServiceHost.Sweeped: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> |