]> git.donarmstrong.com Git - bamtools.git/blobdiff - src/api/internal/io/NetWin_p.h
Removed use of std::map::at() in HttpHeader, not a standard STL method
[bamtools.git] / src / api / internal / io / NetWin_p.h
index fb138b241e559452d545fc97352400610193c5b7..3796e01e761a27d80771f850163476b10751db13 100644 (file)
@@ -1,6 +1,27 @@
+// ***************************************************************************
+// NetWin_p.h (c) 2011 Derek Barnett
+// Marth Lab, Department of Biology, Boston College
+// ---------------------------------------------------------------------------
+// Last modified: 8 December 2011 (DB)
+// ---------------------------------------------------------------------------
+// Provides common networking-related includes, etc. for Windows systems
+//
+// Note: requires Windows XP or later
+// ***************************************************************************
+
 #ifndef NETWIN_P_H
 #define NETWIN_P_H
 
+//  -------------
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the BamTools API.  It exists purely as an
+// implementation detail. This header file may change from version to version
+// without notice, or even be removed.
+//
+// We mean it.
+
 #ifdef _WIN32 // <-- source files only include the proper Net*_p.h, but this is a double-check
 
 #include <winsock2.h>  // <-- should bring 'windows.h' along with it
@@ -17,7 +38,7 @@
 namespace BamTools {
 namespace Internal {
 
-// use RAII to ensure WSA is en
+// use RAII to ensure WSA is initialized
 class WindowsSockInit {
     public:
         WindowsSockInit(void) {