ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-22 17:24:07 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add docs template

Browse Source
This commit is contained in:
Karl Burtram
2016-12-15 17:06:28 -08:00
parent b9f1c2b60e 2346ffff38
commit edb3c4aa1f
275 changed files with 10751 additions and 19075 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
docs/_site/api/Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.html
View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ChannelBase
">
<meta name="generator" content="docfx 1.0.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/style.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<!--
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-63735192-1', 'auto');
ga('send', 'pageview');
</script>
-->
</head> <body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<nav class="navbar navbar-inverse">
<div class="container">
<a href="../"><img height="50px" src="../images/sqlserver.png" style="float:right;"></a>
<div class="navbar-header ">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../"><span class="dotnet">SQL Tools Service</span></a>
</div>
<div id="navbar" class="collapse navbar-collapse">
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
@@ -68,7 +70,8 @@
<div class="col-md-10">
<article class="content wrap" id="_content">
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="pull-right mobile-hide"><span class="fa fa-github"></span>Improve this Doc</a>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L15" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase">Class ChannelBase
</h1>
<div class="markdown level0 summary"><p>Defines a base implementation for servers and their clients over a
@@ -79,32 +82,6 @@ single kind of communication channel.</p>
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">ChannelBase</span></div>
<div class="level2"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioClientChannel.html">StdioClientChannel</a></div>
<div class="level2"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.StdioServerChannel.html">StdioServerChannel</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
@@ -121,7 +98,6 @@ single kind of communication channel.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L20">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_IsConnected_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.IsConnected*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_IsConnected" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.IsConnected">IsConnected</h4>
<div class="markdown level1 summary"><p>Gets a boolean that is true if the channel is connected or false if not.</p>
</div>
@@ -130,7 +106,7 @@ single kind of communication channel.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsConnected { get; protected set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -152,7 +128,6 @@ single kind of communication channel.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L25">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_MessageReader_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.MessageReader*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_MessageReader" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.MessageReader">MessageReader</h4>
<div class="markdown level1 summary"><p>Gets the MessageReader for reading messages from the channel.</p>
</div>
@@ -161,7 +136,7 @@ single kind of communication channel.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MessageReader MessageReader { get; protected set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -183,7 +158,6 @@ single kind of communication channel.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L30">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_MessageWriter_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.MessageWriter*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_MessageWriter" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.MessageWriter">MessageWriter</h4>
<div class="markdown level1 summary"><p>Gets the MessageWriter for writing messages to the channel.</p>
</div>
@@ -192,7 +166,7 @@ single kind of communication channel.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MessageWriter MessageWriter { get; protected set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -216,7 +190,6 @@ single kind of communication channel.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L73">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Initialize_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Initialize*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Initialize_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Serializers_IMessageSerializer_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Initialize(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer)">Initialize(IMessageSerializer)</h4>
<div class="markdown level1 summary"><p>A method to be implemented by subclasses to handle the
actual initialization of the channel and the creation and
@@ -239,7 +212,7 @@ assignment of the MessageReader and MessageWriter properties.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Serializers.IMessageSerializer.html">IMessageSerializer</a></td>
<td><span class="parametername">messageSerializer</span></td>
<td><em>messageSerializer</em></td>
<td><p>The IMessageSerializer to use for message serialization.</p>
</td>
</tr>
@@ -252,7 +225,6 @@ assignment of the MessageReader and MessageWriter properties.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L79">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Shutdown_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Shutdown*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Shutdown" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Shutdown">Shutdown()</h4>
<div class="markdown level1 summary"><p>A method to be implemented by subclasses to handle shutdown
of the channel once Stop is called.</p>
@@ -269,7 +241,6 @@ of the channel once Stop is called.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L36">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Start_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Start*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Start_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Start(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType)">Start(MessageProtocolType)</h4>
<div class="markdown level1 summary"><p>Starts the channel and initializes the MessageDispatcher.</p>
</div>
@@ -290,7 +261,7 @@ of the channel once Stop is called.</p>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType.html">MessageProtocolType</a></td>
<td><span class="parametername">messageProtocolType</span></td>
<td><em>messageProtocolType</em></td>
<td><p>The type of message protocol used by the channel.</p>
</td>
</tr>
@@ -303,7 +274,6 @@ of the channel once Stop is called.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L62">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Stop_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Stop*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Stop" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.Stop">Stop()</h4>
<div class="markdown level1 summary"><p>Stops the channel.</p>
</div>
@@ -319,7 +289,6 @@ of the channel once Stop is called.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/Channel/ChannelBase.cs/#L57">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_WaitForConnection_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.WaitForConnection*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_WaitForConnection" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.WaitForConnection">WaitForConnection()</h4>
<div class="markdown level1 summary"><p>Returns a Task that allows the consumer of the ChannelBase
implementation to wait until a connection has been made to
@@ -370,16 +339,9 @@ the opposite endpoint whether it&#39;s a client or server.</p>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2016 Microsoft<br>Generated by <strong>DocFX</strong></span>
<div class="inner-footer">
<p>© Microsoft &nbsp;//&nbsp; Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
</div>
</div>
</footer>
</div>