Clarified documentation on BamReader::GetNextAlignmentCore

[bamtools.git] / src / api / internal / io / TcpSocketEngine_p.h

diff --git a/src/api/internal/io/TcpSocketEngine_p.h b/src/api/internal/io/TcpSocketEngine_p.h
index a87eafebee0340a322c16ffec10ac0f6aeed28cb..9218278b6342de7675528a4fdab0ddc773af9c03 100644 (file)
--- a/src/api/internal/io/TcpSocketEngine_p.h
+++ b/src/api/internal/io/TcpSocketEngine_p.h
@@ -1,9 +1,32 @@
+// ***************************************************************************
+// TcpSocketEngine_p.h (c) 2011 Derek Barnett
+// Marth Lab, Department of Biology, Boston College
+// ---------------------------------------------------------------------------
+// Last modified: 8 December 2011 (DB)
+// ---------------------------------------------------------------------------
+// Provides low-level implementation of TCP I/O
+// ***************************************************************************
+
 #ifndef TCPSOCKETENGINE_P_H
 #define TCPSOCKETENGINE_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.
+
 #include "api/internal/io/HostAddress_p.h"
 #include "api/internal/io/TcpSocket_p.h"
 
+#ifdef _WIN32
+#  include "api/internal/io/NetWin_p.h"
+#endif
+
 namespace BamTools {
 namespace Internal {
 
@@ -51,8 +74,7 @@ struct TcpSocketEngine {
         bool    nativeConnect(const HostAddress& address, const uint16_t port);
         bool    nativeCreateSocket(HostAddress::NetworkProtocol protocol);
         void    nativeDisconnect(void);
-        bool    nativeFetchConnectionParameters(void);
-        int64_t  nativeNumBytesAvailable(void) const;
+        int64_t nativeNumBytesAvailable(void) const;
         int64_t nativeRead(char* dest, size_t max);
         int     nativeSelect(int msecs, bool isRead) const;
         int64_t nativeWrite(const char* data, size_t length);
@@ -69,6 +91,10 @@ struct TcpSocketEngine {
         TcpSocket::SocketError m_socketError;
         TcpSocket::SocketState m_socketState;
         std::string m_errorString;
+
+#ifdef _WIN32
+        WindowsSockInit m_win;
+#endif
 };
 
 } // namespace Internal