123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>José: jose_io_t Struct 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">José
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- </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-attribs">Data Fields</a> </div>
- <div class="headertitle">
- <div class="title">jose_io_t Struct Reference<div class="ingroups"><a class="el" href="group__jose__io.html">IO</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>The interface for chained IO.
- <a href="structjose__io__t.html#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
- Data Fields</h2></td></tr>
- <tr class="memitem:afa8ec8ac8802fd2600466b9477730cfe"><td class="memItemLeft" align="right" valign="top">bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structjose__io__t.html#afa8ec8ac8802fd2600466b9477730cfe">feed</a> )(<a class="el" href="structjose__io__t.html">jose_io_t</a> *io, const void *in, size_t len)</td></tr>
- <tr class="memdesc:afa8ec8ac8802fd2600466b9477730cfe"><td class="mdescLeft"> </td><td class="mdescRight">Pushes data into the IO chain. <a href="#afa8ec8ac8802fd2600466b9477730cfe">More...</a><br /></td></tr>
- <tr class="separator:afa8ec8ac8802fd2600466b9477730cfe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a76d1eac0d05d3604c16686b08bd80aa0"><td class="memItemLeft" align="right" valign="top">bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structjose__io__t.html#a76d1eac0d05d3604c16686b08bd80aa0">done</a> )(<a class="el" href="structjose__io__t.html">jose_io_t</a> *io)</td></tr>
- <tr class="memdesc:a76d1eac0d05d3604c16686b08bd80aa0"><td class="mdescLeft"> </td><td class="mdescRight">Completes the IO chain. <a href="#a76d1eac0d05d3604c16686b08bd80aa0">More...</a><br /></td></tr>
- <tr class="separator:a76d1eac0d05d3604c16686b08bd80aa0"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>The interface for chained IO. </p>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__jose__io.html#gaa3f3eb70079093e1244ffe516fd1627f" title="Creates a new IO object which collects data into a dynamic buffer. ">jose_io_malloc()</a> </dd>
- <dd>
- <a class="el" href="group__jose__io.html#gaf9372e0f4d1c3d6ece6c38f31ea7c48c" title="Creates a new IO object which collects data into a static buffer. ">jose_io_buffer()</a> </dd>
- <dd>
- <a class="el" href="group__jose__io.html#gaa249153384969267f4d3f8d9691e2bef" title="Creates a new IO object which writes data into a FILE. ">jose_io_file()</a> </dd>
- <dd>
- <a class="el" href="group__jose__io.html#ga6ea7adf304754afee8b6ec33597991f7" title="Creates a new IO object which multiplexes data into multiple IO objects. ">jose_io_multiplex()</a> </dd>
- <dd>
- <a class="el" href="group__jose__b64.html#gad72c180de43c9da3456bdb0d166092ff" title="Creates a new IO object which performs URL-safe Base64 encoding. ">jose_b64_enc_io()</a> </dd>
- <dd>
- <a class="el" href="group__jose__b64.html#ga8e16b78e3713aacb5bdcdc16730a3a98" title="Creates a new IO object which performs URL-safe Base64 decoding. ">jose_b64_dec_io()</a> </dd>
- <dd>
- <a class="el" href="group__jose__jws.html#ga73152ceaf852dd2d897154fb250a7860" title="Creates one or more signatures in a JWS object using streaming. ">jose_jws_sig_io()</a> </dd>
- <dd>
- <a class="el" href="group__jose__jws.html#ga35a5d3c37101fc127933f3c856b46cc8" title="Verifies signatures of one or more JWKs in a JWS object using streaming. ">jose_jws_ver_io()</a> </dd>
- <dd>
- <a class="el" href="group__jose__jwe.html#gacd3c7703b57c524bc2683f2c0d0db4b8" title="Unwraps and decrypts ciphertext using streaming. ">jose_jwe_dec_io()</a> </dd>
- <dd>
- <a class="el" href="group__jose__jwe.html#gaf22bbcd02627f938be28fa4b1778e29c" title="Decrypts ciphertext with the CEK using streaming. ">jose_jwe_dec_cek_io()</a> </dd>
- <dd>
- <a class="el" href="group__jose__jwe.html#ga27e44e2144dc81b778158163661b7f9f" title="Wraps and encrypts plaintext using streaming. ">jose_jwe_enc_io()</a> </dd>
- <dd>
- <a class="el" href="group__jose__jwe.html#gae484a56237a35f5c18038a1b24952f0a" title="Encrypts plaintext with the CEK using streaming. ">jose_jwe_enc_cek_io()</a> </dd></dl>
- </div><h2 class="groupheader">Field Documentation</h2>
- <a id="afa8ec8ac8802fd2600466b9477730cfe"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afa8ec8ac8802fd2600466b9477730cfe">◆ </a></span>feed</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool(* jose_io_t::feed) (<a class="el" href="structjose__io__t.html">jose_io_t</a> *io, const void *in, size_t len)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Pushes data into the IO chain. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">io</td><td>The <a class="el" href="structjose__io__t.html" title="The interface for chained IO. ">jose_io_t</a> entity you are using. </td></tr>
- <tr><td class="paramname">in</td><td>The input buffer. </td></tr>
- <tr><td class="paramname">len</td><td>The length of the data in the input buffer. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if all data was consumed, otherwise false. </dd></dl>
- </div>
- </div>
- <a id="a76d1eac0d05d3604c16686b08bd80aa0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a76d1eac0d05d3604c16686b08bd80aa0">◆ </a></span>done</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool(* jose_io_t::done) (<a class="el" href="structjose__io__t.html">jose_io_t</a> *io)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Completes the IO chain. </p>
- <p>Any data stored in internal buffers will be flushed.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">io</td><td>The <a class="el" href="structjose__io__t.html" title="The interface for chained IO. ">jose_io_t</a> entity you are using. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if flushing was successful, otherwise false. </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.13
- </small></address>
- </body>
- </html>
|