mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 01:25:40 -05:00
eb4f2f2b91
* Initial commit for GitHub IO pages * Add initial doxfx content * Update manifest.json * Update manifest.json * Set theme jekyll-theme-cayman * Set theme jekyll-theme-slate * Set theme jekyll-theme-minimal * Set theme jekyll-theme-tactile * Clear out theme setting * Remove API docs * Revert "Adding Milliseconds to DateTime fields (#173)" (#197) This reverts commit431dfa4156. * ported new BatchParser * added BatchParser tests * fixing merge conflicts * fix build issues * cleaned code and addressed comments from code review * addressed code review and made BatchParser logic more efficient * fixed batch parser tests * changed class name to fix build issues * fixed merge conflicts * added path for lab mode baseline tests * changed env path for lab mode * added env variable to appveyor * testing env variable for appveyor * fixed lab build * debug appveyor build * testing changes for appveyor * changed trace env path * debugging appveyor build * changed baseline env path * debugging * debugging * debugging * switched on trace flag * debugging * debugging * changed build config * changed baseline files * checking baseline output * changed baseline files * debug baseline tests * debugging baseline * debugging * debugging * debug * debugging * testing baseline format * debug * debug * debug * debug * debug * newline debug * changed baseline file * debug * test * try new way to read * added execution engine tests * change test * testing file encoding * moved execution engine tests to integration * try compare without spaces * removed no op test * added env variable for travis * put batch parser tests to integration too * put batch parser in integration * try new baseline string match * compare baseline test logic changed * changed baseline logic as well as cleaned tests * fix build for travis CI * fix travis CI issues * fixed highlighting bugs on vscode * code review changes * ported new BatchParser * added BatchParser tests * Initial commit for GitHub IO pages * Add initial doxfx content * Update manifest.json * Update manifest.json * Set theme jekyll-theme-cayman * Set theme jekyll-theme-slate * Set theme jekyll-theme-minimal * Set theme jekyll-theme-tactile * Clear out theme setting * Remove API docs * Revert "Adding Milliseconds to DateTime fields (#173)" (#197) This reverts commit431dfa4156. * fixing merge conflicts * fix build issues * cleaned code and addressed comments from code review * addressed code review and made BatchParser logic more efficient * fixed batch parser tests * changed class name to fix build issues * fixed merge conflicts * added path for lab mode baseline tests changed env path for lab mode added env variable to appveyor testing env variable for appveyor fixed lab build debug appveyor build testing changes for appveyor changed trace env path debugging appveyor build changed baseline env path debugging debugging debugging switched on trace flag debugging debugging changed build config changed baseline files checking baseline output changed baseline files debug baseline tests debugging baseline debugging debugging debug debugging testing baseline format debug debug debug debug debug newline debug changed baseline file debug test try new way to read added execution engine tests change test testing file encoding moved execution engine tests to integration try compare without spaces removed no op test added env variable for travis * put batch parser tests to integration too * put batch parser in integration try new baseline string match * compare baseline test logic changed * changed baseline logic as well as cleaned tests * fix build for travis CI * fix travis CI issues * fixed highlighting bugs on vscode * code review changes * fixed filestream writer test * added localization string * added localization string * generated new string files again * code review changes
797 lines
54 KiB
HTML
797 lines
54 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class ProtocolEndpoint
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ProtocolEndpoint
|
|
">
|
|
<meta name="generator" content="docfx 1.0.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
</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>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content">
|
|
|
|
|
|
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint">Class ProtocolEndpoint
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Provides behavior for a client or server endpoint that
|
|
communicates using the specified protocol.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">ProtocolEndpoint</span></div>
|
|
<div class="level2"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.html">ServiceHostBase</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</h6>
|
|
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
|
<h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class ProtocolEndpoint : IProtocolEndpoint, IMessageSender</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.%23ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType)%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L48">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.#ctor*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageProtocolType_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.#ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType)">ProtocolEndpoint(ChannelBase, MessageProtocolType)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes an instance of the protocol server using the
|
|
specified channel for communication.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ProtocolEndpoint(ChannelBase protocolChannel, MessageProtocolType messageProtocolType)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase.html">ChannelBase</a></td>
|
|
<td><span class="parametername">protocolChannel</span></td>
|
|
<td><p>The channel to use for communication with the connected endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageProtocolType.html">MessageProtocolType</a></td>
|
|
<td><span class="parametername">messageProtocolType</span></td>
|
|
<td><p>The type of message protocol used by the endpoint.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_MessageDispatcher.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.MessageDispatcher%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L36">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_MessageDispatcher_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.MessageDispatcher*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_MessageDispatcher" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.MessageDispatcher">MessageDispatcher</h4>
|
|
<div class="markdown level1 summary"><p>Gets the MessageDispatcher which allows registration of
|
|
handlers for requests, responses, and events that are
|
|
transmitted through the channel.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected MessageDispatcher MessageDispatcher { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.html">MessageDispatcher</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnConnect.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnConnect%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L284">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnConnect_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnConnect*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnConnect" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnConnect">OnConnect()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual Task OnConnect()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStart.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStart%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L279">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStart_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStart*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStart" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStart">OnStart()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual Task OnStart()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStop.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStop%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L289">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStop_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStop*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStop" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.OnStop">OnStop()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual Task OnStop()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendEvent%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2C%60%600)%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L193">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendEvent_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendEvent*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendEvent``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},``0)">SendEvent<TParams>(EventType<TParams>, TParams)</h4>
|
|
<div class="markdown level1 summary"><p>Sends an event to the channel's endpoint.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task SendEvent<TParams>(EventType<TParams> eventType, TParams eventParams)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
|
<td><span class="parametername">eventType</span></td>
|
|
<td><p>The type of event being sent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TParams</span></td>
|
|
<td><span class="parametername">eventParams</span></td>
|
|
<td><p>The event parameters being sent.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td><p>A Task that tracks completion of the send operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TParams</span></td>
|
|
<td>The event parameter type.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="implements">Implements</h5>
|
|
<div><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_">IMessageSender.SendEvent<TParams>(EventType<TParams>, TParams)</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2C%60%600)%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L136">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},``0)">SendRequest<TParams, TResult>(RequestType<TParams, TResult>, TParams)</h4>
|
|
<div class="markdown level1 summary"><p>Sends a request to the server</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task<TResult> SendRequest<TParams, TResult>(RequestType<TParams, TResult> requestType, TParams requestParams)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
|
<td><span class="parametername">requestType</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TParams</span></td>
|
|
<td><span class="parametername">requestParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span><TResult></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResult</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2C%60%600%2CSystem.Boolean)%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L143">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SendRequest``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},``0,System.Boolean)">SendRequest<TParams, TResult>(RequestType<TParams, TResult>, TParams, Boolean)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task<TResult> SendRequest<TParams, TResult>(RequestType<TParams, TResult> requestType, TParams requestParams, bool waitForResponse)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
|
<td><span class="parametername">requestType</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TParams</span></td>
|
|
<td><span class="parametername">requestParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">waitForResponse</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span><TResult></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResult</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="implements">Implements</h5>
|
|
<div><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IMessageSender.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IMessageSender_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Boolean_">IMessageSender.SendRequest<TParams, TResult>(RequestType<TParams, TResult>, TParams, Boolean)</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%2CSystem.Threading.Tasks.Task%7D)%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L243">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task})">SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SetEventHandler<TParams>(EventType<TParams> eventType, Func<TParams, EventContext, Task> eventHandler)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
|
<td><span class="parametername">eventType</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
|
<td><span class="parametername">eventHandler</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="implements">Implements</h5>
|
|
<div><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__">IProtocolEndpoint.SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>)</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler%60%601(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType%7B%60%600%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext%2CSystem.Threading.Tasks.Task%7D%2CSystem.Boolean)%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L253">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task},System.Boolean)">SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>, Boolean)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SetEventHandler<TParams>(EventType<TParams> eventType, Func<TParams, EventContext, Task> eventHandler, bool overrideExisting)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType-1.html">EventType</a><TParams></td>
|
|
<td><span class="parametername">eventType</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
|
<td><span class="parametername">eventHandler</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">overrideExisting</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="implements">Implements</h5>
|
|
<div><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_">IProtocolEndpoint.SetEventHandler<TParams>(EventType<TParams>, Func<TParams, EventContext, Task>, Boolean)</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetRequestHandler%60%602(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType%7B%60%600%2C%60%601%7D%2CSystem.Func%7B%60%600%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7B%60%601%7D%2CSystem.Threading.Tasks.Task%7D)%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L234">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetRequestHandler_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetRequestHandler*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.SetRequestHandler``2(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType{``0,``1},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{``1},System.Threading.Tasks.Task})">SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult>, Func<TParams, RequestContext<TResult>, Task>)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult> requestType, Func<TParams, RequestContext<TResult>, Task> requestHandler)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.RequestType-2.html">RequestType</a><TParams, TResult></td>
|
|
<td><span class="parametername">requestType</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Func</span><TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><TResult>, <span class="xref">System.Threading.Tasks.Task</span>></td>
|
|
<td><span class="parametername">requestHandler</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResult</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="implements">Implements</h5>
|
|
<div><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.IProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_IProtocolEndpoint_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__">IProtocolEndpoint.SetRequestHandler<TParams, TResult>(RequestType<TParams, TResult>, Func<TParams, RequestContext<TResult>, Task>)</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Start.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Start%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L61">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Start_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Start*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Start" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Start">Start()</h4>
|
|
<div class="markdown level1 summary"><p>Starts the language server client and sends the Initialize method.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task Start()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td><p>A Task that can be awaited for initialization to complete.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Stop.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Stop%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L104">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Stop_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Stop*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Stop" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.Stop">Stop()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task Stop()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_WaitForExit.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.WaitForExit%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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L98">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_WaitForExit_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.WaitForExit*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_WaitForExit" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.WaitForExit">WaitForExit()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void WaitForExit()</code></pre>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint%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="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/ProtocolEndpoint.cs/#L19" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</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>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|