ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-23 01:25:42 -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

127
docs/_site/api/Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue-1.html
View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class AsyncQueue&lt;T&gt;
">
<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_Utility_AsyncQueue_1.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue%601%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/Utility/AsyncQueue.cs/#L18" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1">Class AsyncQueue&lt;T&gt;
</h1>
<div class="markdown level0 summary"><p>Provides a synchronized queue which can be used from within async
@@ -80,51 +83,12 @@ operations. This is primarily used for producer/consumer scenarios.</p>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">AsyncQueue&lt;T&gt;</span></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.Utility</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AsyncQueue&lt;T&gt;</code></pre>
</div>
<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">T</span></td>
<td>The type of item contained in the queue.</td>
</tr>
</tbody>
</table>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
@@ -134,7 +98,6 @@ operations. This is primarily used for producer/consumer scenarios.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/AsyncQueue.cs/#L42">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1__ctor" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.#ctor">AsyncQueue()</h4>
<div class="markdown level1 summary"><p>Initializes an empty instance of the AsyncQueue class.</p>
</div>
@@ -150,7 +113,6 @@ operations. This is primarily used for producer/consumer scenarios.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/AsyncQueue.cs/#L54">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1__ctor_System_Collections_Generic_IEnumerable__0__" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.#ctor(System.Collections.Generic.IEnumerable{`0})">AsyncQueue(IEnumerable&lt;T&gt;)</h4>
<div class="markdown level1 summary"><p>Initializes an instance of the AsyncQueue class, pre-populated
with the given collection of items.</p>
@@ -172,7 +134,7 @@ with the given collection of items.</p>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
<td><span class="parametername">initialItems</span></td>
<td><em>initialItems</em></td>
<td><p>An IEnumerable containing the initial items with which the queue will
be populated.</p>
</td>
@@ -188,7 +150,6 @@ be populated.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/AsyncQueue.cs/#L33">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_IsEmpty_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.IsEmpty*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_IsEmpty" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.IsEmpty">IsEmpty</h4>
<div class="markdown level1 summary"><p>Returns true if the queue is currently empty.</p>
</div>
@@ -197,7 +158,7 @@ be populated.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsEmpty { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -221,7 +182,6 @@ be populated.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/AsyncQueue.cs/#L104">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_DequeueAsync_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.DequeueAsync*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_DequeueAsync" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.DequeueAsync">DequeueAsync()</h4>
<div class="markdown level1 summary"><p>Dequeues an item from the queue or waits asynchronously
until an item is available.</p>
@@ -254,7 +214,6 @@ until an item is available.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/AsyncQueue.cs/#L120">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_DequeueAsync_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.DequeueAsync*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_DequeueAsync_System_Threading_CancellationToken_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.DequeueAsync(System.Threading.CancellationToken)">DequeueAsync(CancellationToken)</h4>
<div class="markdown level1 summary"><p>Dequeues an item from the queue or waits asynchronously
until an item is available. The wait can be cancelled
@@ -277,7 +236,7 @@ using the given CancellationToken.</p>
<tbody>
<tr>
<td><span class="xref">System.Threading.CancellationToken</span></td>
<td><span class="parametername">cancellationToken</span></td>
<td><em>cancellationToken</em></td>
<td><p>A CancellationToken with which a dequeue wait can be cancelled.</p>
</td>
</tr>
@@ -306,7 +265,6 @@ using the given CancellationToken.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/AsyncQueue.cs/#L72">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_EnqueueAsync_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.EnqueueAsync*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_AsyncQueue_1_EnqueueAsync__0_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.AsyncQueue`1.EnqueueAsync(`0)">EnqueueAsync(T)</h4>
<div class="markdown level1 summary"><p>Enqueues an item onto the end of the queue.</p>
</div>
@@ -327,7 +285,7 @@ using the given CancellationToken.</p>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><em>item</em></td>
<td><p>The item to be added to the queue.</p>
</td>
</tr>
@@ -374,16 +332,9 @@ operation completes.</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>