static/api/python/.x/pulsar.functions.function.html - pulsar-site - Git at Google

 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
           "DTD/xhtml1-strict.dtd">
 <html>


   <head>

     <title>pulsar.functions.function</title>
     <meta name="generator" content="pydoctor 23.4.0.dev0">

     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
     <link rel="stylesheet" type="text/css" href="apidocs.css" />
     <link rel="stylesheet" type="text/css" href="readthedocstheme.css" />
     <link rel="stylesheet" type="text/css" href="extra.css" />
 </head>

   <body>


     <nav class="navbar navbar-default mainnavbar">


   <div class="container-fluid">


     <div class="navbar-header">

       <div class="navlinks">
         <span class="navbar-brand">
           pulsar <a href="index.html">API Documentation</a>
         </span>

         <a href="moduleIndex.html">
           Modules
         </a>

         <a href="classIndex.html">
           Classes
         </a>

         <a href="nameIndex.html">
           Names
         </a>

         <div id="search-box-container">
           <div class="input-group">
             <input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />

             <span class="input-group-btn">
               <a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
               <a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
             </span>
           </div>
         </div>

       </div>

     </div>

   </div>


         <!-- Side navigation -->
       <div class="sidebarcontainer">
         <nav class="sidebar">


   <div>

       <div class="thingTitle">
         <span>Module</span>
         <code class="thisobject"><a href="pulsar.functions.function.html" class="internal-link" title="This module">function</a></code>
       </div>

       <div>


         <div class="childrenKindTitle">Classes</div>
         <ul>

     <li class="">


             <div class="itemName"><code><a href="pulsar.functions.function.Function.html" class="internal-link" title="pulsar.functions.function.Function"><wbr></wbr>Function</a></code>
             </div>


     </li>
 </ul>


       </div>
   </div><div>

       <div class="thingTitle">
         <span>Package</span>
         <code><a href="pulsar.functions.html" class="internal-link" title="The parent of this module">functions</a></code>
       </div>

       <div>


         <div class="childrenKindTitle">Modules</div>
         <ul>

     <li class="">


             <div class="itemName"><code><a href="pulsar.functions.context.html" class="internal-link" title="pulsar.functions.context">context</a></code>
             </div>


     </li><li class=" thisobject">


             <div class="itemName"><code><a href="pulsar.functions.function.html" class="internal-link" title="pulsar.functions.function">function</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.functions.serde.html" class="internal-link" title="pulsar.functions.serde">serde</a></code>
             </div>


     </li>
 </ul>


       </div>
   </div>

 </nav>
         <!-- No sidebar toggle for read the docs theme, the sidebar is always
           visible when the screen is width enough.
         -->
       </div>

     </nav>

     <div class="container-fluid">

       <div id="main" class="">


         <div id="search-results-container" style="display: none;">

           <div id="search-buttons">
             <span class="label label-default" id="search-docstrings-button">
             <label class="checkbox-inline">
               <input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
                 search in docstrings
               </input>
             </label>
             </span>

           </div>

           <noscript>
               <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
           </noscript>

           <div class="hint" id="search-help-box">
             <p class="rst-last">

               Search bar offers the following options:
               <ul>
                   <li>
                     <strong>Term presence.</strong> The below example searches for documents that
                       must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
                   </li>

                   <li>
                     <strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
                   </li>

                   <li>
                     <strong>Search in specific fields.</strong> The following search matches all objects
                     in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>

                     <p>
                       Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
                       Last two fields are only applicable if "search in docstrings" is enabled.
                     </p>
                   </li>

                   <li>
                     <strong>Fuzzy matches.</strong> The following search matches all documents
                     that have a word within 1 edit distance of “foo”: <code>foo~1</code>
                   </li>
               </ul>

             </p>
           </div>

           <div id="search-status"> </div>

           <div class="warning" id="search-warn-box" style="display: none;">
             <p class="rst-last"><span id="search-warn"></span></p>
           </div>

           <table id="search-results">
             <!-- Filled dynamically by JS -->
           </table>

           <div style="margin-top: 8px;">
             <p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
           </div>
         </div>

         <div class="page-header">
           <h1 class="module"><code><code><a href="index.html" class="internal-link">pulsar</a></code><wbr></wbr>.<code><a href="pulsar.functions.html" class="internal-link" title="pulsar.functions">functions</a></code><wbr></wbr>.<code><a href="pulsar.functions.function.html" class="internal-link" title="pulsar.functions.function">function</a></code></code></h1>
           <div id="showPrivate">
             <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
           </div>
         </div>

         <div class="categoryHeader">
           module documentation
         </div>

         <div class="extrasDocstring">
           <a href="https://github.com/apache/pulsar-client-python/tree/v.0/pulsar/functions/function.py" class="sourceLink">(source)</a>
           <p></p>
         </div>

         <div class="moduleDocstring">
           <div><p>This is the core interface of the function api.</p>
 <p>The process method is called for every message of the input topic of the
 function. The incoming input bytes are deserialized using the serde.
 The process function can optionally emit an output</p>
 </div>
         </div>

         <div id="splitTables">
           <table class="children sortable" id="id7">


   <tr class="class">

     <td>Class</td>
     <td><code><a href="pulsar.functions.function.Function.html" class="internal-link" title="pulsar.functions.function.Function"><wbr></wbr>Function</a></code></td>
     <td>Interface for Pulsar Function</td>
   </tr>
 </table>


         </div>

         <div id="childList">

         </div>

       </div>
     </div>

     <footer class="navbar navbar-default">
     <hr />


     <div class="container">
       <a href="index.html">API Documentation</a> for pulsar,
     generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
       23.4.0.dev0 at 2023-06-05 15:41:56.
     </div>

     <script src="ajax.js" type="text/javascript"></script>
     <script src="searchlib.js" type="text/javascript"></script>
     <script src="search.js" type="text/javascript"></script>

   </footer>

     <script src="pydoctor.js" type="text/javascript"></script>

   </body>
 </html>
	<?xml version="1.0" encoding="utf-8"?>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
	"DTD/xhtml1-strict.dtd">
	<html>


	<head>

	<title>pulsar.functions.function</title>
	<meta name="generator" content="pydoctor 23.4.0.dev0">

	</meta>
	<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
	<link rel="stylesheet" type="text/css" href="apidocs.css" />
	<link rel="stylesheet" type="text/css" href="readthedocstheme.css" />
	<link rel="stylesheet" type="text/css" href="extra.css" />
	</head>

	<body>



	<nav class="navbar navbar-default mainnavbar">


	<div class="container-fluid">


	<div class="navbar-header">

	<div class="navlinks">
	<span class="navbar-brand">
	pulsar <a href="index.html">API Documentation</a>
	</span>

	<a href="moduleIndex.html">
	Modules
	</a>

	<a href="classIndex.html">
	Classes
	</a>

	<a href="nameIndex.html">
	Names
	</a>

	<div id="search-box-container">
	<div class="input-group">
	<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />

	<span class="input-group-btn">
	<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
	<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
	</span>
	</div>
	</div>

	</div>

	</div>

	</div>


	<!-- Side navigation -->
	<div class="sidebarcontainer">
	<nav class="sidebar">


	<div>

	<div class="thingTitle">
	<span>Module</span>
	<code class="thisobject"><a href="pulsar.functions.function.html" class="internal-link" title="This module">function</a></code>
	</div>

	<div>





	<div class="childrenKindTitle">Classes</div>
	<ul>

	<li class="">





	<div class="itemName"><code><a href="pulsar.functions.function.Function.html" class="internal-link" title="pulsar.functions.function.Function"><wbr></wbr>Function</a></code>
	</div>


	</li>
	</ul>













	</div>
	</div><div>

	<div class="thingTitle">
	<span>Package</span>
	<code><a href="pulsar.functions.html" class="internal-link" title="The parent of this module">functions</a></code>
	</div>

	<div>


	<div class="childrenKindTitle">Modules</div>
	<ul>

	<li class="">





	<div class="itemName"><code><a href="pulsar.functions.context.html" class="internal-link" title="pulsar.functions.context">context</a></code>
	</div>


	</li><li class=" thisobject">





	<div class="itemName"><code><a href="pulsar.functions.function.html" class="internal-link" title="pulsar.functions.function">function</a></code>
	</div>


	</li><li class="">





	<div class="itemName"><code><a href="pulsar.functions.serde.html" class="internal-link" title="pulsar.functions.serde">serde</a></code>
	</div>


	</li>
	</ul>
















	</div>
	</div>

	</nav>
	<!-- No sidebar toggle for read the docs theme, the sidebar is always
	visible when the screen is width enough.
	-->
	</div>

	</nav>

	<div class="container-fluid">

	<div id="main" class="">




	<div id="search-results-container" style="display: none;">

	<div id="search-buttons">
	<span class="label label-default" id="search-docstrings-button">
	<label class="checkbox-inline">
	<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
	search in docstrings
	</input>
	</label>
	</span>

	</div>

	<noscript>
	<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
	</noscript>

	<div class="hint" id="search-help-box">
	<p class="rst-last">

	Search bar offers the following options:
	<ul>
	<li>
	<strong>Term presence.</strong> The below example searches for documents that
	must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
	</li>

	<li>
	<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
	</li>

	<li>
	<strong>Search in specific fields.</strong> The following search matches all objects
	in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>

	<p>
	Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
	Last two fields are only applicable if "search in docstrings" is enabled.
	</p>
	</li>

	<li>
	<strong>Fuzzy matches.</strong> The following search matches all documents
	that have a word within 1 edit distance of “foo”: <code>foo~1</code>
	</li>
	</ul>

	</p>
	</div>

	<div id="search-status"> </div>

	<div class="warning" id="search-warn-box" style="display: none;">
	<p class="rst-last"><span id="search-warn"></span></p>
	</div>

	<table id="search-results">
	<!-- Filled dynamically by JS -->
	</table>

	<div style="margin-top: 8px;">
	<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
	</div>
	</div>

	<div class="page-header">
	<h1 class="module"><code><code><a href="index.html" class="internal-link">pulsar</a></code><wbr></wbr>.<code><a href="pulsar.functions.html" class="internal-link" title="pulsar.functions">functions</a></code><wbr></wbr>.<code><a href="pulsar.functions.function.html" class="internal-link" title="pulsar.functions.function">function</a></code></code></h1>
	<div id="showPrivate">
	<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
	</div>
	</div>

	<div class="categoryHeader">
	module documentation
	</div>

	<div class="extrasDocstring">
	<a href="https://github.com/apache/pulsar-client-python/tree/v.0/pulsar/functions/function.py" class="sourceLink">(source)</a>
	<p></p>
	</div>

	<div class="moduleDocstring">
	<div><p>This is the core interface of the function api.</p>
	<p>The process method is called for every message of the input topic of the
	function. The incoming input bytes are deserialized using the serde.
	The process function can optionally emit an output</p>
	</div>
	</div>

	<div id="splitTables">
	<table class="children sortable" id="id7">


	<tr class="class">

	<td>Class</td>
	<td><code><a href="pulsar.functions.function.Function.html" class="internal-link" title="pulsar.functions.function.Function"><wbr></wbr>Function</a></code></td>
	<td>Interface for Pulsar Function</td>
	</tr>
	</table>



	</div>

	<div id="childList">

	</div>

	</div>
	</div>

	<footer class="navbar navbar-default">
	<hr />


	<div class="container">
	<a href="index.html">API Documentation</a> for pulsar,
	generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
	23.4.0.dev0 at 2023-06-05 15:41:56.
	</div>

	<script src="ajax.js" type="text/javascript"></script>
	<script src="searchlib.js" type="text/javascript"></script>
	<script src="search.js" type="text/javascript"></script>

	</footer>

	<script src="pydoctor.js" type="text/javascript"></script>

	</body>
	</html>