Skip to content

Commit

Permalink
Updated docs for 'Version 2.18.0 (Blizzard#1048)'
Browse files Browse the repository at this point in the history
  • Loading branch information
@GaryWilber
GaryWilber authored and Seth committed Apr 10, 2024
1 parent 0b5987a commit f52f49e
Show file tree
Hide file tree
Showing 391 changed files with 82,989 additions and 2,500 deletions.
1,292 changes: 1,292 additions & 0 deletions current/AdminClient.html
View file

Large diffs are not rendered by default.

3,681 changes: 3,681 additions & 0 deletions current/Client.html
View file

Large diffs are not rendered by default.

4,811 changes: 4,811 additions & 0 deletions current/HighLevelProducer.html
View file

Large diffs are not rendered by default.

6,859 changes: 6,859 additions & 0 deletions current/KafkaConsumer.html
View file

Large diffs are not rendered by default.

412 changes: 412 additions & 0 deletions current/KafkaConsumerStream.html
View file

Large diffs are not rendered by default.

4,473 changes: 4,473 additions & 0 deletions current/LibrdKafkaError.html
View file

Large diffs are not rendered by default.

4,650 changes: 4,650 additions & 0 deletions current/Producer.html
View file

Large diffs are not rendered by default.

348 changes: 348 additions & 0 deletions current/ProducerStream.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,348 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: ProducerStream</title>

<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="toolkit/css/toolkit/bnet-responsive.min.css">
<link type="text/css" rel="stylesheet" href="styles/main.css">
</head>

<body>

<!-- HEADER -->
<div class="navbar-static">
<header class="navbar header">
<div class="grid-container">
<div class="grid-25">
<a class="brand mark" href="index.html">
Class: ProducerStream
<span class="tag">3.6.11</span>
</a>
</div>
<div class="grid-75">
<ul class="nav navbar-nav navbar-right">
<li class="dropdown"><a class="dropdown-toggle" role="button" data-toggle="dropdown" href="#" onclick="return false;">Classes</a><ul class="dropdown-menu" role="menu"><li><a href="AdminClient.html">AdminClient</a></li><li><a href="Client.html">Client</a></li><li><a href="HighLevelProducer.html">HighLevelProducer</a></li><li><a href="KafkaConsumer.html">KafkaConsumer</a></li><li><a href="KafkaConsumerStream.html">KafkaConsumerStream</a></li><li><a href="LibrdKafkaError.html">LibrdKafkaError</a></li><li><a href="Producer.html">Producer</a></li><li><a href="ProducerStream.html">ProducerStream</a></li></ul></li><li class="dropdown"><a class="dropdown-toggle" role="button" data-toggle="dropdown" href="#" onclick="return false;">Events</a><ul class="dropdown-menu" role="menu"><li><a href="Client.html#event:disconnected">disconnected</a></li><li><a href="Client.html#event:ready">ready</a></li><li><a href="HighLevelProducer.html#event:disconnected">disconnected</a></li><li><a href="HighLevelProducer.html#event:ready">ready</a></li><li><a href="KafkaConsumer.html#event:data">data</a></li><li><a href="KafkaConsumer.html#event:disconnected">disconnected</a></li><li><a href="KafkaConsumer.html#event:ready">ready</a></li><li><a href="Producer.html#event:disconnected">disconnected</a></li><li><a href="Producer.html#event:ready">ready</a></li></ul></li><li class="dropdown"><a class="dropdown-toggle" role="button" data-toggle="dropdown" href="#" onclick="return false;">Tutorials</a><ul class="dropdown-menu" role="menu"><li><a href="tutorial-consumer-flow.html">consumer-flow</a></li><li><a href="tutorial-consumer.html">consumer</a></li><li><a href="tutorial-docker-alpine.html">docker-alpine</a></li><li><a href="tutorial-high-level-producer.html">high-level-producer</a></li><li><a href="tutorial-metadata.html">metadata</a></li><li><a href="tutorial-producer-cluster.html">producer-cluster</a></li><li><a href="tutorial-producer_.html">producer</a></li></ul></li><h3>Global</h3><ul><li><a href="global.html#createAdminClient">createAdminClient</a></li><li><a href="global.html#createSerializer">createSerializer</a></li><li><a href="global.html#RefCounter">RefCounter</a></li><li><a href="global.html#Topic">Topic</a></li><li><a href="global.html#TopicPartition">TopicPartition</a></li></ul>
</ul>
</div>
</div>
</header>
</div>
<!-- /HEADER -->

<div class="body-content">
<div class="grid-container project-container">

<div class="grid-75 push-25">
<h1>Class: ProducerStream</h1>






<section>

<header>

<h2>ProducerStream</h2>


</header>

<article>
<div class="container-overview">





<h4 class="name" id="ProducerStream">
<span class="type-signature"></span>new ProducerStream<span class="signature">(producer, topics, options)</span><span class="type-signature"></span>
</h4>





<div class="description">
<p>Writable stream integrating with the Kafka Producer.

This class is used to write data to Kafka in a streaming way. It takes
buffers of data and puts them into the appropriate Kafka topic. If you need
finer control over partitions or keys, this is probably not the class for
you. In that situation just use the Producer itself.

The stream detects if Kafka is already connected. You can safely begin
writing right away.

This stream does not operate in Object mode and can only be given buffers.</p>
</div>









<div class="clearfix">
<div class="grid-75">
<h4 class="heading-3">Parameters:</h4>
</div>
</div>



<table class="params table table-striped">
<thead>
<tr>

<th>Name</th>


<th>Type</th>





<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name">producer</td>


<td class="type">


<span class="param-type"><a href="Producer.html">Producer</a></span>




</td>





<td class="description last">The Kafka Producer object.</td>
</tr>



<tr>

<td class="name">topics</td>


<td class="type">


<span class="param-type">array</span>




</td>





<td class="description last">Array of topics</td>
</tr>



<tr>

<td class="name">options</td>


<td class="type">


<span class="param-type">object</span>




</td>





<td class="description last">Topic configuration.</td>
</tr>


</tbody>
</table>






<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="pager"><li>
<a href="producer-stream.js.html#line39">producer-stream.js, line 39</a>
</li></ul>
</dd>







</dl>

















</div>


<div class="clearfix">
<div class="grid-75">
<h3 class="heading-2">Extends:</h3>
</div>
<div class="grid-25 top-link">
<small>
<a href="#top" class="inverse">
<i class="icon-chevron-up"></i>
&nbsp;Back to top.
</a>
</small>
</div>
</div>





<ul>
<li>stream.Writable</li>
</ul>



















</article>

</section>




</div>
<div class="grid-25 pull-75">
<div class="navigation-sidebar">
<ul class="nav nav-list">
<li><a href="javascript: void(0);">Classes</a><ul class="nav nav-list" role="menu"><li><a href="AdminClient.html">AdminClient</a></li><li><a href="Client.html">Client</a></li><li><a href="HighLevelProducer.html">HighLevelProducer</a></li><li><a href="KafkaConsumer.html">KafkaConsumer</a></li><li><a href="KafkaConsumerStream.html">KafkaConsumerStream</a></li><li><a href="LibrdKafkaError.html">LibrdKafkaError</a></li><li><a href="Producer.html">Producer</a></li><li><a href="ProducerStream.html">ProducerStream</a></li></ul></li><li><a href="javascript: void(0);">Events</a><ul class="nav nav-list" role="menu"><li><a href="Client.html#event:disconnected">disconnected</a></li><li><a href="Client.html#event:ready">ready</a></li><li><a href="HighLevelProducer.html#event:disconnected">disconnected</a></li><li><a href="HighLevelProducer.html#event:ready">ready</a></li><li><a href="KafkaConsumer.html#event:data">data</a></li><li><a href="KafkaConsumer.html#event:disconnected">disconnected</a></li><li><a href="KafkaConsumer.html#event:ready">ready</a></li><li><a href="Producer.html#event:disconnected">disconnected</a></li><li><a href="Producer.html#event:ready">ready</a></li></ul></li><li><a href="javascript: void(0);">Tutorials</a><ul class="nav nav-list" role="menu"><li><a href="tutorial-consumer-flow.html">consumer-flow</a></li><li><a href="tutorial-consumer.html">consumer</a></li><li><a href="tutorial-docker-alpine.html">docker-alpine</a></li><li><a href="tutorial-high-level-producer.html">high-level-producer</a></li><li><a href="tutorial-metadata.html">metadata</a></li><li><a href="tutorial-producer-cluster.html">producer-cluster</a></li><li><a href="tutorial-producer_.html">producer</a></li></ul></li><h3>Global</h3><ul><li><a href="global.html#createAdminClient">createAdminClient</a></li><li><a href="global.html#createSerializer">createSerializer</a></li><li><a href="global.html#RefCounter">RefCounter</a></li><li><a href="global.html#Topic">Topic</a></li><li><a href="global.html#TopicPartition">TopicPartition</a></li></ul>
</ul>
<!-- <ul class="nav nav-list collapse"> -->
</div>
</div>
</div>

</div>
</div> <!-- /.body-content -->

<br class="clear">

<!-- FOOTER -->
<footer class="footer">
<div class="grid-container">
<div class="footer-content">
<div class="grid-75">
<div class="legal">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc </a> on Wed Apr 10 2024 17:55:29 GMT-0500 (Central Daylight Time)
</div>
</div>
<div class="grid-25">
<span class="blizzard">Blizzard® Entertainment</span>
</div>
</div>
</div>
</footer>
<!-- /FOOTER -->

<script> prettyPrint(); </script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
<script src="toolkit/js/toolkit/toolkit.min.js"> </script>
</body>
</html>
Loading

0 comments on commit f52f49e

Please sign in to comment.