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
Files
edb3c4aa1fa6346288352c300c1733edcc992e52
sqltoolsservice/docs/_site/api/Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.html
Karl Burtram edb3c4aa1f Add docs template
2016-12-15 17:06:28 -08:00

589 lines
44 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class MessageDispatcher
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class MessageDispatcher
">
<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/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">
<!--
<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 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">
<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">
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.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" 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/MessageDispatcher.cs/#L18" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher">Class MessageDispatcher
</h1>
<div class="markdown level0 summary"></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">MessageDispatcher</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_MessageDispatcher_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MessageDispatcher</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_MessageDispatcher__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.%23ctor(Microsoft.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">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/MessageDispatcher.cs/#L63">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher__ctor_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Channel_ChannelBase_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.#ctor(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel.ChannelBase)">MessageDispatcher(ChannelBase)</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 MessageDispatcher(ChannelBase protocolChannel)</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><em>protocolChannel</em></td>
<td></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_MessageDispatcher_InMessageLoopThread.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.InMessageLoopThread%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/MessageDispatcher.cs/#L43">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_InMessageLoopThread" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.InMessageLoopThread">InMessageLoopThread</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 bool InMessageLoopThread { get; }</code></pre>
</div>
<h5 class="propertyValue"></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.Boolean</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_MessageDispatcher_MessageReader.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.MessageReader%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/MessageDispatcher.cs/#L54">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_MessageReader" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.MessageReader">MessageReader</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 MessageReader MessageReader { get; }</code></pre>
</div>
<h5 class="propertyValue"></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.MessageReader.html">MessageReader</a></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_MessageDispatcher_MessageWriter.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.MessageWriter%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/MessageDispatcher.cs/#L56">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_MessageWriter" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.MessageWriter">MessageWriter</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 MessageWriter MessageWriter { get; }</code></pre>
</div>
<h5 class="propertyValue"></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.MessageWriter.html">MessageWriter</a></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_MessageDispatcher_SynchronizationContext.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SynchronizationContext%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/MessageDispatcher.cs/#L41">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SynchronizationContext" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SynchronizationContext">SynchronizationContext</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 SynchronizationContext SynchronizationContext { get; }</code></pre>
</div>
<h5 class="propertyValue"></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.SynchronizationContext</span></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_MessageDispatcher_DispatchMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.DispatchMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter)%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/MessageDispatcher.cs/#L257">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_DispatchMessage_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageWriter_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.DispatchMessage(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter)">DispatchMessage(Message, MessageWriter)</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 Task DispatchMessage(Message messageToDispatch, MessageWriter messageWriter)</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.Message.html">Message</a></td>
<td><em>messageToDispatch</em></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageWriter.html">MessageWriter</a></td>
<td><em>messageWriter</em></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></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_MessageDispatcher_OnUnhandledException_System_Exception_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.OnUnhandledException(System.Exception)%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/MessageDispatcher.cs/#L191">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_OnUnhandledException_System_Exception_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.OnUnhandledException(System.Exception)">OnUnhandledException(Exception)</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 void OnUnhandledException(Exception unhandledException)</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><span class="xref">System.Exception</span></td>
<td><em>unhandledException</em></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_MessageDispatcher_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.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/MessageDispatcher.cs/#L136">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_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.MessageDispatcher.SetEventHandler``1(Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.EventType{``0},System.Func{``0,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext,System.Threading.Tasks.Task})">SetEventHandler&lt;TParams&gt;(EventType&lt;TParams&gt;, Func&lt;TParams, EventContext, Task&gt;)</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&lt;TParams&gt;(EventType&lt;TParams&gt; eventType, Func&lt;TParams, EventContext, Task&gt; 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>&lt;TParams&gt;</td>
<td><em>eventType</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Func</span>&lt;TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>&gt;</td>
<td><em>eventHandler</em></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_MessageDispatcher_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&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.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/MessageDispatcher.cs/#L146">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_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.MessageDispatcher.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&lt;TParams&gt;(EventType&lt;TParams&gt;, Func&lt;TParams, EventContext, Task&gt;, 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&lt;TParams&gt;(EventType&lt;TParams&gt; eventType, Func&lt;TParams, EventContext, Task&gt; 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>&lt;TParams&gt;</td>
<td><em>eventType</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Func</span>&lt;TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.EventContext.html">EventContext</a>, <span class="xref">System.Threading.Tasks.Task</span>&gt;</td>
<td><em>eventHandler</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><em>overrideExisting</em></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_MessageDispatcher_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&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.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/MessageDispatcher.cs/#L95">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_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.MessageDispatcher.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&lt;TParams, TResult&gt;(RequestType&lt;TParams, TResult&gt;, Func&lt;TParams, RequestContext&lt;TResult&gt;, Task&gt;)</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&lt;TParams, TResult&gt;(RequestType&lt;TParams, TResult&gt; requestType, Func&lt;TParams, RequestContext&lt;TResult&gt;, Task&gt; 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>&lt;TParams, TResult&gt;</td>
<td><em>requestType</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Func</span>&lt;TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a>&lt;TResult&gt;, <span class="xref">System.Threading.Tasks.Task</span>&gt;</td>
<td><em>requestHandler</em></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_MessageDispatcher_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__System_Boolean_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.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%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/MessageDispatcher.cs/#L105">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_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__System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.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},System.Boolean)">SetRequestHandler&lt;TParams, TResult&gt;(RequestType&lt;TParams, TResult&gt;, Func&lt;TParams, RequestContext&lt;TResult&gt;, Task&gt;, 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 SetRequestHandler&lt;TParams, TResult&gt;(RequestType&lt;TParams, TResult&gt; requestType, Func&lt;TParams, RequestContext&lt;TResult&gt;, Task&gt; requestHandler, 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.RequestType-2.html">RequestType</a>&lt;TParams, TResult&gt;</td>
<td><em>requestType</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Func</span>&lt;TParams, <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a>&lt;TResult&gt;, <span class="xref">System.Threading.Tasks.Task</span>&gt;</td>
<td><em>requestHandler</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><em>overrideExisting</em></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_MessageDispatcher_SetResponseHandler_System_Action_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message__.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetResponseHandler(System.Action%7BMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message%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/MessageDispatcher.cs/#L180">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_SetResponseHandler_System_Action_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_Message__" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.SetResponseHandler(System.Action{Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message})">SetResponseHandler(Action&lt;Message&gt;)</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 SetResponseHandler(Action&lt;Message&gt; responseHandler)</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><span class="xref">System.Action</span>&lt;<a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Contracts.Message.html">Message</a>&gt;</td>
<td><em>responseHandler</em></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_MessageDispatcher_Start.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.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/MessageDispatcher.cs/#L74">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_Start" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.Start">Start()</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 Start()</code></pre>
</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_MessageDispatcher_Stop.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.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/MessageDispatcher.cs/#L85">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_Stop" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.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 void Stop()</code></pre>
</div>
<h3 id="events">Events
</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_MessageDispatcher_UnhandledException.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.UnhandledException%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/MessageDispatcher.cs/#L189">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_MessageDispatcher_UnhandledException" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.MessageDispatcher.UnhandledException">UnhandledException</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 event EventHandler&lt;Exception&gt; UnhandledException</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_MessageDispatcher.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/Protocol/MessageDispatcher.cs/#L18" 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="inner-footer">
<p>© Microsoft &nbsp;//&nbsp; Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
</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>
Reference in New Issue View Git Blame Copy Permalink