carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC Objective-C: GRXImmediateWriter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC Objective-C
   &#160;<span id="projectnumber">1.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Class Methods</a>  </div>
  <div class="headertitle">
<div class="title">GRXImmediateWriter Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Utility to construct <a class="el" href="interface_g_r_x_writer.html" title="An GRXWriter object can produce, on demand, a sequence of values.">GRXWriter</a> instances from values that are immediately available when required.  
 <a href="interface_g_r_x_immediate_writer.html#details">More...</a></p>

<p><code>#import &lt;<a class="el" href="_g_r_x_immediate_writer_8h_source.html">GRXImmediateWriter.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Class Methods</h2></td></tr>
<tr class="memitem:acdf17bf03814cbd81ba232751d2e88a0"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_immediate_writer.html#acdf17bf03814cbd81ba232751d2e88a0">writerWithEnumerator:</a></td></tr>
<tr class="memdesc:acdf17bf03814cbd81ba232751d2e88a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that pulls values from the passed NSEnumerator instance and pushes them to its writeable.  <a href="interface_g_r_x_immediate_writer.html#acdf17bf03814cbd81ba232751d2e88a0">More...</a><br /></td></tr>
<tr class="separator:acdf17bf03814cbd81ba232751d2e88a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a181562274c8da85d7b4eafeab4b9ca97"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_immediate_writer.html#a181562274c8da85d7b4eafeab4b9ca97">writerWithValueSupplier:</a></td></tr>
<tr class="memdesc:a181562274c8da85d7b4eafeab4b9ca97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that pushes to its writeable the successive values returned by the passed block.  <a href="interface_g_r_x_immediate_writer.html#a181562274c8da85d7b4eafeab4b9ca97">More...</a><br /></td></tr>
<tr class="separator:a181562274c8da85d7b4eafeab4b9ca97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c9996ca138b0d1027adb8975b7120b9"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_immediate_writer.html#a3c9996ca138b0d1027adb8975b7120b9">writerWithContainer:</a></td></tr>
<tr class="memdesc:a3c9996ca138b0d1027adb8975b7120b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that iterates over the values of the passed container and pushes them to its writeable.  <a href="interface_g_r_x_immediate_writer.html#a3c9996ca138b0d1027adb8975b7120b9">More...</a><br /></td></tr>
<tr class="separator:a3c9996ca138b0d1027adb8975b7120b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a5149821d90a5c0b834470a80887075"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_immediate_writer.html#a7a5149821d90a5c0b834470a80887075">writerWithValue:</a></td></tr>
<tr class="memdesc:a7a5149821d90a5c0b834470a80887075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that sends the passed value to its writeable and then finishes (releasing the value).  <a href="interface_g_r_x_immediate_writer.html#a7a5149821d90a5c0b834470a80887075">More...</a><br /></td></tr>
<tr class="separator:a7a5149821d90a5c0b834470a80887075"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1c652c9c760039684d82a2da3063576"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_immediate_writer.html#ae1c652c9c760039684d82a2da3063576">writerWithError:</a></td></tr>
<tr class="memdesc:ae1c652c9c760039684d82a2da3063576"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that, as part of its start method, sends the passed error to the writeable (then releasing the error).  <a href="interface_g_r_x_immediate_writer.html#ae1c652c9c760039684d82a2da3063576">More...</a><br /></td></tr>
<tr class="separator:ae1c652c9c760039684d82a2da3063576"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9257baff2a076a03aa8090093c3c6a2"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_immediate_writer.html#ae9257baff2a076a03aa8090093c3c6a2">emptyWriter</a></td></tr>
<tr class="memdesc:ae9257baff2a076a03aa8090093c3c6a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that, as part of its start method, finishes immediately without sending any values to its writeable.  <a href="interface_g_r_x_immediate_writer.html#ae9257baff2a076a03aa8090093c3c6a2">More...</a><br /></td></tr>
<tr class="separator:ae9257baff2a076a03aa8090093c3c6a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_interface_g_r_x_writer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interface_g_r_x_writer')"><img src="closed.png" alt="-"/>&#160;Instance Methods inherited from <a class="el" href="interface_g_r_x_writer.html">GRXWriter</a></td></tr>
<tr class="memitem:aa76ca568d962fa003c1c0946d39a7a73 inherit pub_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_x_writer.html#aa76ca568d962fa003c1c0946d39a7a73">startWithWriteable:</a></td></tr>
<tr class="memdesc:aa76ca568d962fa003c1c0946d39a7a73 inherit pub_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transition to the Started state, and start sending messages to the writeable (a reference to it is retained).  <a href="interface_g_r_x_writer.html#aa76ca568d962fa003c1c0946d39a7a73">More...</a><br /></td></tr>
<tr class="separator:aa76ca568d962fa003c1c0946d39a7a73 inherit pub_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae65b0e62d3341a6871c0d93fbe2e8e35 inherit pub_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_x_writer.html#ae65b0e62d3341a6871c0d93fbe2e8e35">finishWithError:</a></td></tr>
<tr class="memdesc:ae65b0e62d3341a6871c0d93fbe2e8e35 inherit pub_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send writesFinishedWithError:errorOrNil to the writeable.  <a href="interface_g_r_x_writer.html#ae65b0e62d3341a6871c0d93fbe2e8e35">More...</a><br /></td></tr>
<tr class="separator:ae65b0e62d3341a6871c0d93fbe2e8e35 inherit pub_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8974f26da2c68512d6b0000f591f9630 inherit pub_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_x_writer.html#a8974f26da2c68512d6b0000f591f9630">map:</a></td></tr>
<tr class="memdesc:a8974f26da2c68512d6b0000f591f9630 inherit pub_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that wraps the receiver, and has all the values the receiver would write transformed by the provided mapping function.  <a href="interface_g_r_x_writer.html#a8974f26da2c68512d6b0000f591f9630">More...</a><br /></td></tr>
<tr class="separator:a8974f26da2c68512d6b0000f591f9630 inherit pub_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_interface_g_r_x_writer"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_g_r_x_writer')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interface_g_r_x_writer.html">GRXWriter</a></td></tr>
<tr class="memitem:a9160ff1b22550fe0f0e1ee6f7edd4838 inherit properties_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">GRXWriterState&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_x_writer.html#a9160ff1b22550fe0f0e1ee6f7edd4838">state</a></td></tr>
<tr class="memdesc:a9160ff1b22550fe0f0e1ee6f7edd4838 inherit properties_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">This property can be used to query the current state of the writer, which determines how it might currently use its writeable.  <a href="interface_g_r_x_writer.html#a9160ff1b22550fe0f0e1ee6f7edd4838">More...</a><br /></td></tr>
<tr class="separator:a9160ff1b22550fe0f0e1ee6f7edd4838 inherit properties_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility to construct <a class="el" href="interface_g_r_x_writer.html" title="An GRXWriter object can produce, on demand, a sequence of values.">GRXWriter</a> instances from values that are immediately available when required. </p>
<p>Thread-safety:</p>
<p>An object of this class shouldn't be messaged concurrently by more than one thread. It will start messaging the writeable before |startWithWriteable:| returns, in the same thread. That is the only place where the writer can be paused or stopped prematurely.</p>
<p>If a paused writer of this class is resumed, it will start messaging the writeable, in the same thread, before |setState:| returns. Because the object can't be legally accessed concurrently, that's the only place where it can be paused again (or stopped). </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a id="ae9257baff2a076a03aa8090093c3c6a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9257baff2a076a03aa8090093c3c6a2">&#9670;&nbsp;</a></span>emptyWriter</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *) emptyWriter </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a writer that, as part of its start method, finishes immediately without sending any values to its writeable. </p>

<p>Implements <a class="el" href="interface_g_r_x_writer.html#a42bd3df3cd21b320f1255a36b23d13f6">GRXWriter</a>.</p>

</div>
</div>
<a id="a3c9996ca138b0d1027adb8975b7120b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c9996ca138b0d1027adb8975b7120b9">&#9670;&nbsp;</a></span>writerWithContainer:</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *) writerWithContainer: </td>
          <td></td>
          <td class="paramtype">(id&lt; NSFastEnumeration &gt;)&#160;</td>
          <td class="paramname"><em>container</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a writer that iterates over the values of the passed container and pushes them to its writeable. </p>
<p>The container is released when the iteration is over.</p>
<p>Note that the usual speed gain of NSFastEnumeration over NSEnumerator results from not having to call one method per element. Because <a class="el" href="interface_g_r_x_writeable.html" title="Utility to create objects that conform to the GRXWriteable protocol, from blocks that handle each of ...">GRXWriteable</a> instances accept values one by one, that speed gain doesn't happen here. </p>

<p>Implements <a class="el" href="interface_g_r_x_writer.html#a2280d44f0ebd30ee4b5d53b4709ed828">GRXWriter</a>.</p>

</div>
</div>
<a id="acdf17bf03814cbd81ba232751d2e88a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdf17bf03814cbd81ba232751d2e88a0">&#9670;&nbsp;</a></span>writerWithEnumerator:</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *) writerWithEnumerator: </td>
          <td></td>
          <td class="paramtype">(NSEnumerator *)&#160;</td>
          <td class="paramname"><em>enumerator</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a writer that pulls values from the passed NSEnumerator instance and pushes them to its writeable. </p>
<p>The NSEnumerator is released when it finishes. </p>

<p>Implements <a class="el" href="interface_g_r_x_writer.html#a085c38cbcf5e24fab202b10e7d688231">GRXWriter</a>.</p>

</div>
</div>
<a id="ae1c652c9c760039684d82a2da3063576"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1c652c9c760039684d82a2da3063576">&#9670;&nbsp;</a></span>writerWithError:</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *) writerWithError: </td>
          <td></td>
          <td class="paramtype">(NSError *)&#160;</td>
          <td class="paramname"><em>error</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a writer that, as part of its start method, sends the passed error to the writeable (then releasing the error). </p>

<p>Implements <a class="el" href="interface_g_r_x_writer.html#a147e6a76005690ff89a710162c072630">GRXWriter</a>.</p>

</div>
</div>
<a id="a7a5149821d90a5c0b834470a80887075"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a5149821d90a5c0b834470a80887075">&#9670;&nbsp;</a></span>writerWithValue:</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *) writerWithValue: </td>
          <td></td>
          <td class="paramtype">(id)&#160;</td>
          <td class="paramname"><em>value</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a writer that sends the passed value to its writeable and then finishes (releasing the value). </p>

<p>Implements <a class="el" href="interface_g_r_x_writer.html#a20c40669544f1987dc524397b94dc99d">GRXWriter</a>.</p>

<p>Implemented in <a class="el" href="interface_g_r_x_immediate_single_writer.html#aecf282d1233640abb234f8dbd8f09fee">GRXImmediateSingleWriter</a>.</p>

</div>
</div>
<a id="a181562274c8da85d7b4eafeab4b9ca97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a181562274c8da85d7b4eafeab4b9ca97">&#9670;&nbsp;</a></span>writerWithValueSupplier:</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *) writerWithValueSupplier: </td>
          <td></td>
          <td class="paramtype">(id(^)(void))&#160;</td>
          <td class="paramname"><em>block</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a writer that pushes to its writeable the successive values returned by the passed block. </p>
<p>When the block first returns nil, it is released. </p>

<p>Implements <a class="el" href="interface_g_r_x_writer.html#ac51760afcaefbc72a0de9c3c4e7f06fa">GRXWriter</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/objective-c/RxLibrary/<a class="el" href="_g_r_x_immediate_writer_8h_source.html">GRXImmediateWriter.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>