1 // ***************************************************************************
2 // TcpSocketEngine_p.cpp (c) 2011 Derek Barnett
3 // Marth Lab, Department of Biology, Boston College
4 // ---------------------------------------------------------------------------
5 // Last modified: 10 November 2011 (DB)
6 // ---------------------------------------------------------------------------
7 // Provides low-level implementation of TCP I/O
8 // ***************************************************************************
10 // N.B. - this file contains the top-level, platform-independent logic. "Native" methods
11 // are called as needed from the TcpSocketEngine_<X>.cpp files. Selection of the proper
12 // native method file should have been handled at build-time by CMake.
14 #include "api/internal/io/HostInfo_p.h"
15 #include "api/internal/io/TcpSocketEngine_p.h"
16 using namespace BamTools;
17 using namespace BamTools::Internal;
19 TcpSocketEngine::TcpSocketEngine(void)
20 : m_socketDescriptor(-1)
23 , m_socketError(TcpSocket::UnknownSocketError)
24 , m_socketState(TcpSocket::UnconnectedState)
27 TcpSocketEngine::TcpSocketEngine(const TcpSocketEngine& other)
28 : m_socketDescriptor(other.m_socketDescriptor)
29 // , m_localAddress(other.m_localAddress)
30 , m_remoteAddress(other.m_remoteAddress)
31 // , m_localPort(other.m_localPort)
32 , m_remotePort(other.m_remotePort)
33 , m_socketError(other.m_socketError)
34 , m_socketState(other.m_socketState)
35 , m_errorString(other.m_errorString)
38 TcpSocketEngine::~TcpSocketEngine(void) {
42 void TcpSocketEngine::Close(void) {
44 // close socket if we have valid FD
45 if ( m_socketDescriptor != -1 ) {
47 m_socketDescriptor = -1;
51 m_socketState = TcpSocket::UnconnectedState;
52 // m_localAddress.Clear();
53 m_remoteAddress.Clear();
58 bool TcpSocketEngine::Connect(const HostAddress& address, const uint16_t port) {
60 // return failure if invalid FD or already connected
61 if ( !IsValid() || (m_socketState == TcpSocket::ConnectedState) ) {
62 // TODO: set error string
66 // attempt to connect to host address on requested port
67 if ( !nativeConnect(address, port) ) {
68 // TODO: set error string
72 // if successful, store remote host address port & return success
73 // TODO: (later) fetch proxied remote & local host/port here
74 m_remoteAddress = address;
79 std::string TcpSocketEngine::GetErrorString(void) const {
83 //HostAddress TcpSocketEngine::GetLocalAddress(void) const {
84 // return m_localAddress;
87 //uint16_t TcpSocketEngine::GetLocalPort(void) const {
88 // return m_localPort;
91 HostAddress TcpSocketEngine::GetRemoteAddress(void) const {
92 return m_remoteAddress;
95 uint16_t TcpSocketEngine::GetRemotePort(void) const {
99 int TcpSocketEngine::GetSocketDescriptor(void) const {
100 return m_socketDescriptor;
103 TcpSocket::SocketError TcpSocketEngine::GetSocketError(void) {
104 return m_socketError;
107 TcpSocket::SocketState TcpSocketEngine::GetSocketState(void) {
108 return m_socketState;
111 bool TcpSocketEngine::Initialize(HostAddress::NetworkProtocol protocol) {
113 // close current socket if we have one open
117 // attempt to create new socket
118 return nativeCreateSocket(protocol);
121 bool TcpSocketEngine::IsValid(void) const {
122 return (m_socketDescriptor != -1);
125 int64_t TcpSocketEngine::NumBytesAvailable(void) const {
127 // return 0 if socket FD is invalid
129 // TODO: set error string
133 // otherwise check socket to see how much is ready
134 return nativeNumBytesAvailable();
137 int64_t TcpSocketEngine::Read(char* dest, size_t max) {
139 // return failure if can't read
140 if ( !IsValid() || (m_socketState != TcpSocket::ConnectedState) )
143 // otherwise return number of bytes read
144 return nativeRead(dest, max);
147 bool TcpSocketEngine::WaitForRead(int msec, bool* timedOut) {
149 // reset timedOut flag
152 // need to wait for our socket to be ready to read
153 int ret = nativeSelect(msec, true);
158 m_socketError = TcpSocket::SocketTimeoutError;
159 m_errorString = "socket timed out";
162 // return if any sockets available for reading
166 bool TcpSocketEngine::WaitForWrite(int msec, bool* timedOut) {
168 // reset timedOut flag
171 // need to wait for our socket to be ready to write
172 int ret = nativeSelect(msec, false);
177 m_socketError = TcpSocket::SocketTimeoutError;
178 m_errorString = "socket timed out";
181 // return if any sockets available for reading
185 int64_t TcpSocketEngine::Write(const char* data, size_t length) {
187 // return failure if can't write
188 if ( !IsValid() || (m_socketState != TcpSocket::ConnectedState) ) {
189 // TODO: set error string
193 // otherwise return number of bytes written
194 return nativeWrite(data, length);