Skip to content

Commit 6c28064

Browse files
committed
Update API documentation for commit seladb/PcapPlusPlus@699f7b0
1 parent 15665f5 commit 6c28064

File tree

1,516 files changed

+20708
-19729
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,516 files changed

+20708
-19729
lines changed

static/api-docs/next/_arp_layer_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@
149149
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
150150
<ul>
151151
<li class="navelem"><a class="el" href="dir_a0102b96c48c4cdcedcedf8f364687c5.html">Packet++</a></li><li class="navelem"><a class="el" href="dir_fe1d50cd56397826e8c67fd39e5ee46e.html">header</a></li><li class="navelem"><a class="el" href="_arp_layer_8h.html">ArpLayer.h</a></li>
152-
<li class="footer">Generated on Mon Aug 4 2025 08:59:58 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
152+
<li class="footer">Generated on Fri Aug 15 2025 08:38:31 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
153153
</ul>
154154
</div>
155155
</body>

static/api-docs/next/_arp_layer_8h_source.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@
175175
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; {</div>
176176
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keyword">public</span>:</div>
177177
<div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="classpcpp_1_1_arp_layer.html#aa067af1ff96f04fa052ce58b48fedf16"> 151</a></span>&#160; <a class="code" href="classpcpp_1_1_arp_layer.html#aa067af1ff96f04fa052ce58b48fedf16">ArpLayer</a>(uint8_t* data, <span class="keywordtype">size_t</span> dataLen, <a class="code" href="classpcpp_1_1_layer.html">Layer</a>* prevLayer, <a class="code" href="classpcpp_1_1_packet.html">Packet</a>* packet)</div>
178-
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; : <a class="code" href="classpcpp_1_1_layer.html">Layer</a>(data, dataLen, prevLayer, packet, <a class="code" href="namespacepcpp.html#aead5ebeefddfe9c93b70ede2c99cea9d">ARP</a>)</div>
178+
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; : <a class="code" href="classpcpp_1_1_layer.html">Layer</a>(data, dataLen, prevLayer, packet, <a class="code" href="group___protocol_types.html#gaead5ebeefddfe9c93b70ede2c99cea9d">ARP</a>)</div>
179179
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; {</div>
180180
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; m_DataLen = <span class="keyword">sizeof</span>(<a class="code" href="structpcpp_1_1arphdr.html">arphdr</a>);</div>
181181
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; }</div>
@@ -282,13 +282,13 @@
282282
<div class="ttc" id="aclasspcpp_1_1_layer_html"><div class="ttname"><a href="classpcpp_1_1_layer.html">pcpp::Layer</a></div><div class="ttdef"><b>Definition:</b> Layer.h:62</div></div>
283283
<div class="ttc" id="aclasspcpp_1_1_mac_address_html"><div class="ttname"><a href="classpcpp_1_1_mac_address.html">pcpp::MacAddress</a></div><div class="ttdef"><b>Definition:</b> MacAddress.h:24</div></div>
284284
<div class="ttc" id="aclasspcpp_1_1_packet_html"><div class="ttname"><a href="classpcpp_1_1_packet.html">pcpp::Packet</a></div><div class="ttdef"><b>Definition:</b> Packet.h:22</div></div>
285+
<div class="ttc" id="agroup___protocol_types_html_gaead5ebeefddfe9c93b70ede2c99cea9d"><div class="ttname"><a href="group___protocol_types.html#gaead5ebeefddfe9c93b70ede2c99cea9d">pcpp::ARP</a></div><div class="ttdeci">const ProtocolType ARP</div><div class="ttdoc">ARP protocol.</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:72</div></div>
285286
<div class="ttc" id="anamespacepcpp_html"><div class="ttname"><a href="namespacepcpp.html">pcpp</a></div><div class="ttdoc">The main namespace for the PcapPlusPlus lib.</div></div>
286287
<div class="ttc" id="anamespacepcpp_html_a078cb0044494dbde4a73f32cbff6184e"><div class="ttname"><a href="namespacepcpp.html#a078cb0044494dbde4a73f32cbff6184e">pcpp::ArpOpcode</a></div><div class="ttdeci">ArpOpcode</div><div class="ttdoc">An enum for ARP message type.</div><div class="ttdef"><b>Definition:</b> ArpLayer.h:45</div></div>
287288
<div class="ttc" id="anamespacepcpp_html_a078cb0044494dbde4a73f32cbff6184ea1af8ec60de1d0747f88beedec5bd7d87"><div class="ttname"><a href="namespacepcpp.html#a078cb0044494dbde4a73f32cbff6184ea1af8ec60de1d0747f88beedec5bd7d87">pcpp::ARP_REQUEST</a></div><div class="ttdeci">@ ARP_REQUEST</div><div class="ttdoc">ARP request.</div><div class="ttdef"><b>Definition:</b> ArpLayer.h:46</div></div>
288289
<div class="ttc" id="anamespacepcpp_html_a078cb0044494dbde4a73f32cbff6184ea454be5e5734b03b8e54c8c419e030f09"><div class="ttname"><a href="namespacepcpp.html#a078cb0044494dbde4a73f32cbff6184ea454be5e5734b03b8e54c8c419e030f09">pcpp::ARP_REPLY</a></div><div class="ttdeci">@ ARP_REPLY</div><div class="ttdoc">ARP reply (response)</div><div class="ttdef"><b>Definition:</b> ArpLayer.h:47</div></div>
289-
<div class="ttc" id="anamespacepcpp_html_a69e2ee6a9dc68797612cf8dc38461025"><div class="ttname"><a href="namespacepcpp.html#a69e2ee6a9dc68797612cf8dc38461025">pcpp::OsiModelLayer</a></div><div class="ttdeci">OsiModelLayer</div><div class="ttdoc">An enum representing OSI model layers.</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:228</div></div>
290-
<div class="ttc" id="anamespacepcpp_html_a69e2ee6a9dc68797612cf8dc38461025a94d470045f06f720e3cd7db069535412"><div class="ttname"><a href="namespacepcpp.html#a69e2ee6a9dc68797612cf8dc38461025a94d470045f06f720e3cd7db069535412">pcpp::OsiModelNetworkLayer</a></div><div class="ttdeci">@ OsiModelNetworkLayer</div><div class="ttdoc">Network layer (layer 3)</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:234</div></div>
291-
<div class="ttc" id="anamespacepcpp_html_aead5ebeefddfe9c93b70ede2c99cea9d"><div class="ttname"><a href="namespacepcpp.html#aead5ebeefddfe9c93b70ede2c99cea9d">pcpp::ARP</a></div><div class="ttdeci">const ProtocolType ARP</div><div class="ttdoc">ARP protocol.</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:50</div></div>
290+
<div class="ttc" id="anamespacepcpp_html_a69e2ee6a9dc68797612cf8dc38461025"><div class="ttname"><a href="namespacepcpp.html#a69e2ee6a9dc68797612cf8dc38461025">pcpp::OsiModelLayer</a></div><div class="ttdeci">OsiModelLayer</div><div class="ttdoc">An enum representing OSI model layers.</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:258</div></div>
291+
<div class="ttc" id="anamespacepcpp_html_a69e2ee6a9dc68797612cf8dc38461025a94d470045f06f720e3cd7db069535412"><div class="ttname"><a href="namespacepcpp.html#a69e2ee6a9dc68797612cf8dc38461025a94d470045f06f720e3cd7db069535412">pcpp::OsiModelNetworkLayer</a></div><div class="ttdeci">@ OsiModelNetworkLayer</div><div class="ttdoc">Network layer (layer 3)</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:264</div></div>
292292
<div class="ttc" id="anamespacepcpp_html_afbe9bd8f96381b2738b21806783fd710"><div class="ttname"><a href="namespacepcpp.html#afbe9bd8f96381b2738b21806783fd710">pcpp::ArpMessageType</a></div><div class="ttdeci">ArpMessageType</div><div class="ttdoc">An enum representing the ARP message type.</div><div class="ttdef"><b>Definition:</b> ArpLayer.h:52</div></div>
293293
<div class="ttc" id="anamespacepcpp_html_afbe9bd8f96381b2738b21806783fd710a15c2d85f1fae22a3c3a0594510a1f611"><div class="ttname"><a href="namespacepcpp.html#afbe9bd8f96381b2738b21806783fd710a15c2d85f1fae22a3c3a0594510a1f611">pcpp::ArpMessageType::Request</a></div><div class="ttdeci">@ Request</div><div class="ttdoc">ARP request.</div></div>
294294
<div class="ttc" id="anamespacepcpp_html_afbe9bd8f96381b2738b21806783fd710a25d8df6e580905091a0d5ef5b9e05bf0"><div class="ttname"><a href="namespacepcpp.html#afbe9bd8f96381b2738b21806783fd710a25d8df6e580905091a0d5ef5b9e05bf0">pcpp::ArpMessageType::Reply</a></div><div class="ttdeci">@ Reply</div><div class="ttdoc">ARP reply.</div></div>
@@ -319,7 +319,7 @@
319319
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
320320
<ul>
321321
<li class="navelem"><a class="el" href="dir_a0102b96c48c4cdcedcedf8f364687c5.html">Packet++</a></li><li class="navelem"><a class="el" href="dir_fe1d50cd56397826e8c67fd39e5ee46e.html">header</a></li><li class="navelem"><a class="el" href="_arp_layer_8h.html">ArpLayer.h</a></li>
322-
<li class="footer">Generated on Mon Aug 4 2025 08:59:58 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
322+
<li class="footer">Generated on Fri Aug 15 2025 08:38:31 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
323323
</ul>
324324
</div>
325325
</body>

static/api-docs/next/_asn1_codec_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#afc72f6fcbe79f8150a6c7f8d
258258
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
259259
<ul>
260260
<li class="navelem"><a class="el" href="dir_a0102b96c48c4cdcedcedf8f364687c5.html">Packet++</a></li><li class="navelem"><a class="el" href="dir_fe1d50cd56397826e8c67fd39e5ee46e.html">header</a></li><li class="navelem"><a class="el" href="_asn1_codec_8h.html">Asn1Codec.h</a></li>
261-
<li class="footer">Generated on Mon Aug 4 2025 08:59:58 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
261+
<li class="footer">Generated on Fri Aug 15 2025 08:38:31 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
262262
</ul>
263263
</div>
264264
</body>

static/api-docs/next/_asn1_codec_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -944,7 +944,7 @@
944944
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
945945
<ul>
946946
<li class="navelem"><a class="el" href="dir_a0102b96c48c4cdcedcedf8f364687c5.html">Packet++</a></li><li class="navelem"><a class="el" href="dir_fe1d50cd56397826e8c67fd39e5ee46e.html">header</a></li><li class="navelem"><a class="el" href="_asn1_codec_8h.html">Asn1Codec.h</a></li>
947-
<li class="footer">Generated on Mon Aug 4 2025 08:59:58 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
947+
<li class="footer">Generated on Fri Aug 15 2025 08:38:31 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
948948
</ul>
949949
</div>
950950
</body>

static/api-docs/next/_bgp_layer_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@
140140
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
141141
<ul>
142142
<li class="navelem"><a class="el" href="dir_a0102b96c48c4cdcedcedf8f364687c5.html">Packet++</a></li><li class="navelem"><a class="el" href="dir_fe1d50cd56397826e8c67fd39e5ee46e.html">header</a></li><li class="navelem"><a class="el" href="_bgp_layer_8h.html">BgpLayer.h</a></li>
143-
<li class="footer">Generated on Mon Aug 4 2025 08:59:58 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
143+
<li class="footer">Generated on Fri Aug 15 2025 08:38:31 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
144144
</ul>
145145
</div>
146146
</body>

static/api-docs/next/_bgp_layer_8h_source.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@
151151
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <a class="code" href="classpcpp_1_1_bgp_layer.html">BgpLayer</a>()</div>
152152
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; {}</div>
153153
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <a class="code" href="classpcpp_1_1_bgp_layer.html">BgpLayer</a>(uint8_t* data, <span class="keywordtype">size_t</span> dataLen, <a class="code" href="classpcpp_1_1_layer.html">Layer</a>* prevLayer, <a class="code" href="classpcpp_1_1_packet.html">Packet</a>* packet)</div>
154-
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; : <a class="code" href="classpcpp_1_1_layer.html">Layer</a>(data, dataLen, prevLayer, packet, <a class="code" href="namespacepcpp.html#a55e4061b1046f18acbdeb81960d2ae81">BGP</a>)</div>
154+
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; : <a class="code" href="classpcpp_1_1_layer.html">Layer</a>(data, dataLen, prevLayer, packet, <a class="code" href="group___protocol_types.html#ga55e4061b1046f18acbdeb81960d2ae81">BGP</a>)</div>
155155
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; {}</div>
156156
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
157157
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; bgp_common_header* getBasicHeader()<span class="keyword"> const</span></div>
@@ -492,10 +492,10 @@
492492
<div class="ttc" id="aclasspcpp_1_1_i_pv4_address_html"><div class="ttname"><a href="classpcpp_1_1_i_pv4_address.html">pcpp::IPv4Address</a></div><div class="ttdef"><b>Definition:</b> IpAddress.h:30</div></div>
493493
<div class="ttc" id="aclasspcpp_1_1_layer_html"><div class="ttname"><a href="classpcpp_1_1_layer.html">pcpp::Layer</a></div><div class="ttdef"><b>Definition:</b> Layer.h:62</div></div>
494494
<div class="ttc" id="aclasspcpp_1_1_packet_html"><div class="ttname"><a href="classpcpp_1_1_packet.html">pcpp::Packet</a></div><div class="ttdef"><b>Definition:</b> Packet.h:22</div></div>
495+
<div class="ttc" id="agroup___protocol_types_html_ga55e4061b1046f18acbdeb81960d2ae81"><div class="ttname"><a href="group___protocol_types.html#ga55e4061b1046f18acbdeb81960d2ae81">pcpp::BGP</a></div><div class="ttdeci">const ProtocolType BGP</div><div class="ttdoc">Border Gateway Protocol (BGP) version 4 protocol.</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:165</div></div>
495496
<div class="ttc" id="anamespacepcpp_html"><div class="ttname"><a href="namespacepcpp.html">pcpp</a></div><div class="ttdoc">The main namespace for the PcapPlusPlus lib.</div></div>
496-
<div class="ttc" id="anamespacepcpp_html_a55e4061b1046f18acbdeb81960d2ae81"><div class="ttname"><a href="namespacepcpp.html#a55e4061b1046f18acbdeb81960d2ae81">pcpp::BGP</a></div><div class="ttdeci">const ProtocolType BGP</div><div class="ttdoc">Border Gateway Protocol (BGP) version 4 protocol.</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:143</div></div>
497-
<div class="ttc" id="anamespacepcpp_html_a69e2ee6a9dc68797612cf8dc38461025"><div class="ttname"><a href="namespacepcpp.html#a69e2ee6a9dc68797612cf8dc38461025">pcpp::OsiModelLayer</a></div><div class="ttdeci">OsiModelLayer</div><div class="ttdoc">An enum representing OSI model layers.</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:228</div></div>
498-
<div class="ttc" id="anamespacepcpp_html_a69e2ee6a9dc68797612cf8dc38461025a56f0bba682cc695d49efecf8a0152270"><div class="ttname"><a href="namespacepcpp.html#a69e2ee6a9dc68797612cf8dc38461025a56f0bba682cc695d49efecf8a0152270">pcpp::OsiModelApplicationLayer</a></div><div class="ttdeci">@ OsiModelApplicationLayer</div><div class="ttdoc">Application layer (layer 7)</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:242</div></div>
497+
<div class="ttc" id="anamespacepcpp_html_a69e2ee6a9dc68797612cf8dc38461025"><div class="ttname"><a href="namespacepcpp.html#a69e2ee6a9dc68797612cf8dc38461025">pcpp::OsiModelLayer</a></div><div class="ttdeci">OsiModelLayer</div><div class="ttdoc">An enum representing OSI model layers.</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:258</div></div>
498+
<div class="ttc" id="anamespacepcpp_html_a69e2ee6a9dc68797612cf8dc38461025a56f0bba682cc695d49efecf8a0152270"><div class="ttname"><a href="namespacepcpp.html#a69e2ee6a9dc68797612cf8dc38461025a56f0bba682cc695d49efecf8a0152270">pcpp::OsiModelApplicationLayer</a></div><div class="ttdeci">@ OsiModelApplicationLayer</div><div class="ttdoc">Application layer (layer 7)</div><div class="ttdef"><b>Definition:</b> ProtocolType.h:272</div></div>
499499
<div class="ttc" id="astructpcpp_1_1_bgp_layer_1_1bgp__common__header_html"><div class="ttname"><a href="structpcpp_1_1_bgp_layer_1_1bgp__common__header.html">pcpp::BgpLayer::bgp_common_header</a></div><div class="ttdef"><b>Definition:</b> BgpLayer.h:43</div></div>
500500
<div class="ttc" id="astructpcpp_1_1_bgp_layer_1_1bgp__common__header_html_a498670976c145733e0ce2236ec470f61"><div class="ttname"><a href="structpcpp_1_1_bgp_layer_1_1bgp__common__header.html#a498670976c145733e0ce2236ec470f61">pcpp::BgpLayer::bgp_common_header::messageType</a></div><div class="ttdeci">uint8_t messageType</div><div class="ttdoc">BGP message type.</div><div class="ttdef"><b>Definition:</b> BgpLayer.h:49</div></div>
501501
<div class="ttc" id="astructpcpp_1_1_bgp_layer_1_1bgp__common__header_html_a8711a66edadafc0377351705bf632416"><div class="ttname"><a href="structpcpp_1_1_bgp_layer_1_1bgp__common__header.html#a8711a66edadafc0377351705bf632416">pcpp::BgpLayer::bgp_common_header::marker</a></div><div class="ttdeci">uint8_t marker[16]</div><div class="ttdoc">16-octet marker</div><div class="ttdef"><b>Definition:</b> BgpLayer.h:45</div></div>
@@ -537,7 +537,7 @@
537537
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
538538
<ul>
539539
<li class="navelem"><a class="el" href="dir_a0102b96c48c4cdcedcedf8f364687c5.html">Packet++</a></li><li class="navelem"><a class="el" href="dir_fe1d50cd56397826e8c67fd39e5ee46e.html">header</a></li><li class="navelem"><a class="el" href="_bgp_layer_8h.html">BgpLayer.h</a></li>
540-
<li class="footer">Generated on Mon Aug 4 2025 08:59:58 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
540+
<li class="footer">Generated on Fri Aug 15 2025 08:38:31 for PcapPlusPlus by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
541541
</ul>
542542
</div>
543543
</body>

0 commit comments

Comments
 (0)