md_doc_cpp_pending_api_cleanups.html 4.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: pending_api_cleanups</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="PageDoc"><div class="header">
  63. <div class="headertitle">
  64. <div class="title">pending_api_cleanups </div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <div class="textblock"><p>There are times when we make changes that include a temporary shim for backward-compatibility (e.g., a macro or some other function to preserve the original API) to avoid having to bump the major version number in the next release. However, when we do eventually want to release a feature that does change the API in a non-backward-compatible way, we will wind up bumping the major version number anyway, at which point we can take the opportunity to clean up any pending backward-compatibility shims.</p>
  68. <p>This file lists all pending backward-compatibility changes that should be cleaned up the next time we are going to bump the major version number:</p>
  69. <ul>
  70. <li>remove <code>ServerBuilder::SetMaxMessageSize()</code> method from <code>include/grpc++/server_builder.h</code> (commit <code>6980362</code>)</li>
  71. <li>remove <code>ClientContext::set_fail_fast()</code> method from <code>include/grpc++/impl/codegen/client_context.h</code> (commit <code>9477724</code>)</li>
  72. <li>remove directory <code>include/grpc++</code> and all headers in it (commit <code>eb06572</code>)</li>
  73. <li>make all <code>Request</code> and <code>Mark</code> methods in <code><a class="el" href="classgrpc_1_1_service.html" title="Desriptor of an RPC service and its various RPC methods.">grpc::Service</a></code> take a <code>size_t</code> argument for <code>index</code> rather than <code>int</code> (since that is only used as a vector index) </li>
  74. </ul>
  75. </div></div><!-- contents -->
  76. </div><!-- PageDoc -->
  77. <!-- start footer part -->
  78. <hr class="footer"/><address class="footer"><small>
  79. Generated on Wed Mar 3 2021 19:17:22 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  80. <img class="footer" src="doxygen.png" alt="doxygen"/>
  81. </a> 1.8.17
  82. </small></address>
  83. </body>
  84. </html>