[getdns-api] getdns API v0.320 review

[Steagall, Robert]

Hello All,

After the December hackathon, Glen Wiley asked me to review the getdns API, opining that a fresh set of eyes might be useful.  I agreed to take a look, and wrote most of the attached review over my holiday vacation.  Earlier today Neel Goyal asked me to share it with the mailing list, so here it is (after a little bit of polishing).

I approached the review from the perspective of a C++ programmer, thinking about how I might wrap the API in a set of C++ classes.  So naturally, things like const correctness and type safety are important to me.

I've gone out on a limb and implemented the changes suggested by my review in the two attached header files. The first header file, getdns_core.h, reflects the recommendations made in Section 2 of my review, while the second header file, vdns_core.h, implements the overall refactoring recommended in Section 3 of my review.

I realize Section 3 proposes some big cosmetic changes, and so I hope it leads to some useful discussions.

Thanks,
--Bob



Bob Steagall
Senior Engineer
rsteagall at verisign.com<mailto:rsteagall at verisign.com>

T: 703-948-4476
12061 Bluemont Way
Reston, VA 20190

VerisignInc.com<http://www.verisigninc.com/>

[Description: Description: Verisign(tm)]



"This message (including any attachments) is intended only for the use of the individual or entity to which it is addressed, and may contain information that is non-public, proprietary, privileged, confidential and exempt from disclosure under applicable law or may be constituted as attorney work product. If you are not the intended recipient, you are hereby notified that any use, dissemination, distribution, or copying of this communication is strictly prohibited. If you have received this message in error, notify sender immediately and delete this message immediately."
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.vpnc.org/pipermail/getdns-api/attachments/20140122/f1d8ef6f/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image001.gif
Type: image/gif
Size: 131 bytes
Desc: image001.gif
URL: <http://www.vpnc.org/pipermail/getdns-api/attachments/20140122/f1d8ef6f/attachment-0002.gif>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image002.gif
Type: image/gif
Size: 3105 bytes
Desc: image002.gif
URL: <http://www.vpnc.org/pipermail/getdns-api/attachments/20140122/f1d8ef6f/attachment-0003.gif>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: getdns API review 2014-01-22.pdf
Type: application/pdf
Size: 355023 bytes
Desc: getdns API review 2014-01-22.pdf
URL: <http://www.vpnc.org/pipermail/getdns-api/attachments/20140122/f1d8ef6f/attachment-0001.pdf>
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: getdns_core.h
URL: <http://www.vpnc.org/pipermail/getdns-api/attachments/20140122/f1d8ef6f/attachment-0002.h>
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: vdns_core.h
URL: <http://www.vpnc.org/pipermail/getdns-api/attachments/20140122/f1d8ef6f/attachment-0003.h>