1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>http::basic_parser::on_field_impl</title> 5<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Beast"> 8<link rel="up" href="../boost__beast__http__basic_parser.html" title="http::basic_parser"> 9<link rel="prev" href="on_response_impl.html" title="http::basic_parser::on_response_impl"> 10<link rel="next" href="on_header_impl.html" title="http::basic_parser::on_header_impl"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="on_response_impl.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_parser.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="on_header_impl.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="beast.ref.boost__beast__http__basic_parser.on_field_impl"></a><a class="link" href="on_field_impl.html" title="http::basic_parser::on_field_impl">http::basic_parser::on_field_impl</a> 28</h5></div></div></div> 29<p> 30 <a class="indexterm" name="idm46057547303424"></a> 31 </p> 32<p> 33 Called once for each complete field in the HTTP header. 34 </p> 35<h6> 36<a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.h0"></a> 37 <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.synopsis"></a></span><a class="link" href="on_field_impl.html#beast.ref.boost__beast__http__basic_parser.on_field_impl.synopsis">Synopsis</a> 38 </h6> 39<pre class="programlisting"><span class="keyword">void</span> 40<span class="identifier">on_field_impl</span><span class="special">(</span> 41 <span class="identifier">field</span> <span class="identifier">name</span><span class="special">,</span> 42 <span class="identifier">string_view</span> <span class="identifier">name_string</span><span class="special">,</span> 43 <span class="identifier">string_view</span> <span class="identifier">value</span><span class="special">,</span> 44 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 45</pre> 46<h6> 47<a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.h1"></a> 48 <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.description"></a></span><a class="link" href="on_field_impl.html#beast.ref.boost__beast__http__basic_parser.on_field_impl.description">Description</a> 49 </h6> 50<p> 51 This virtual function is invoked for each field that is received while 52 parsing an HTTP message. 53 </p> 54<h6> 55<a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.h2"></a> 56 <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.parameters"></a></span><a class="link" href="on_field_impl.html#beast.ref.boost__beast__http__basic_parser.on_field_impl.parameters">Parameters</a> 57 </h6> 58<div class="informaltable"><table class="table"> 59<colgroup> 60<col> 61<col> 62</colgroup> 63<thead><tr> 64<th> 65 <p> 66 Name 67 </p> 68 </th> 69<th> 70 <p> 71 Description 72 </p> 73 </th> 74</tr></thead> 75<tbody> 76<tr> 77<td> 78 <p> 79 <code class="computeroutput"><span class="identifier">name</span></code> 80 </p> 81 </td> 82<td> 83 <p> 84 The known field enum value. If the name of the field is not recognized, 85 this value will be <a class="link" href="../boost__beast__http__field.html" title="http::field"><code class="computeroutput"><span class="identifier">field</span><span class="special">::</span><span class="identifier">unknown</span></code></a>. 86 </p> 87 </td> 88</tr> 89<tr> 90<td> 91 <p> 92 <code class="computeroutput"><span class="identifier">name_string</span></code> 93 </p> 94 </td> 95<td> 96 <p> 97 The exact name of the field as received from the input, represented 98 as a string. 99 </p> 100 </td> 101</tr> 102<tr> 103<td> 104 <p> 105 <code class="computeroutput"><span class="identifier">value</span></code> 106 </p> 107 </td> 108<td> 109 <p> 110 A string holding the value of the field. 111 </p> 112 </td> 113</tr> 114<tr> 115<td> 116 <p> 117 <code class="computeroutput"><span class="identifier">ec</span></code> 118 </p> 119 </td> 120<td> 121 <p> 122 An output parameter which the function may set to indicate an 123 error. The error will be clear before this function is invoked. 124 </p> 125 </td> 126</tr> 127</tbody> 128</table></div> 129</div> 130<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 131<td align="left"></td> 132<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 133 Falco<p> 134 Distributed under the Boost Software License, Version 1.0. (See accompanying 135 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 136 </p> 137</div></td> 138</tr></table> 139<hr> 140<div class="spirit-nav"> 141<a accesskey="p" href="on_response_impl.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_parser.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="on_header_impl.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 142</div> 143</body> 144</html> 145
