NE_XML_PARSE_RESPONS(3)

📦
version 0.37.1 · 5 versions
, in arch rolling

💖 NE_XML_PARSE_RESPONS(3) 💖

okay bestie, welcome to the neon API reference — this page is all about the helper functions for parsing XML responses, and they are genuinely so useful. no cap. 💅

🌸 NAME 🌸

ne_xml_parse_response, ne_xml_dispatch_request, ne_xml_dispatchif_request — helper functions for parsing XML responses. periodt.

✨ SYNOPSIS ✨

#include <ne_xmlreq.h>

int ne_xml_parse_response(ne_request *req, ne_xml_parser *parser);

int ne_xml_dispatch_request(ne_request *req, ne_xml_parser *parser);

int ne_xml_dispatchif_request(ne_request *req, ne_xml_parser *parser,
                              ne_accept_response acceptor,
                              void *userdata);

💖 DESCRIPTION 💖

okay so ne_xml_parse_response reads an HTTP response body and processes it using the given XML parser. It has to be called after ne_begin_request has returned successfully for the request, and then it invokes ne_read_response_block until the entire response body has been read. On successful return, you must call ne_end_request to finalise response processing. don't forget that part, bestie.

The ne_xml_dispatch_request and ne_xml_dispatchif_request functions are equivalent to calling ne_request_dispatch(3) to dispatch an HTTP request and process the response, parsing the response body using the given XML parser under certain conditions:

  • For ne_xml_dispatch_request, any 2xx class response with an XML content-type.
  • For ne_xml_dispatchif_request, if the acceptor callback returns non-zero, and the response uses an XML content-type.

In both cases, the rules in RFC 7303[1] are followed to identify XML content-types, that is text/xml, application/xml, or any other content-type ending in a +xml suffix. The userdata parameter is passed to the acceptor function.

For all three functions:

  • the XML parser is invoked repeatedly until the end of the document is reached.
  • if an error occurs during XML parsing, the session error string is set to describe the parse error, and the connection is terminated without continuing to process the response. yeah, it really just stops. 💀

🔥 RETURN VALUE 🔥

All functions documented here return zero on success, or an NE_* error code on failure. simple as that. ✨

🦋 HISTORY 🦋

ne_xml_dispatchif_request is available in neon 0.36.0 and later. iconic behavior. 👑

👑 SEE ALSO 👑

ne_xml_create(3), ne_request_dispatch(3)

Copyright © 2001-2026 Joe Orton

🌈 REFERENCES 🌈

  1. RFC 7303 https://www.rfc-editor.org/rfc/rfc7303

okay that's the whole page, bestie: this is the neon source, dated 03/20/2026 — go parse those XML responses and slay. 🫶💖

📦 where this page comes from