TCPConnector.h

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * TCPConnector.h.h
 * Copyright (C) 2012 Simon Newton
 */

#ifndef INCLUDE_OLA_NETWORK_TCPCONNECTOR_H_
#define INCLUDE_OLA_NETWORK_TCPCONNECTOR_H_

#include <ola/Callback.h>
#include <ola/Clock.h>
#include <ola/base/Macro.h>
#include <ola/io/Descriptor.h>
#include <ola/io/SelectServerInterface.h>
#include <ola/network/IPV4Address.h>
#include <ola/network/SocketAddress.h>
#include <ola/network/TCPSocket.h>
#include <set>
#include <vector>

namespace ola {
namespace network {

class TCPConnector {
 public:
  typedef ola::SingleUseCallback2<void, int, int> TCPConnectCallback;

  typedef const void* TCPConnectionID;

  explicit TCPConnector(ola::io::SelectServerInterface *ss);

  ~TCPConnector();

  TCPConnectionID Connect(const IPV4SocketAddress &endpoint,
                          const ola::TimeInterval &timeout,
                          TCPConnectCallback *callback);

  bool Cancel(TCPConnectionID id);

  void CancelAll();

  unsigned int ConnectionsPending() const { return m_connections.size(); }

 private:
  class PendingTCPConnection: public ola::io::WriteFileDescriptor {
   public:
    PendingTCPConnection(TCPConnector *connector,
                         const IPV4Address &ip,
                         int fd,
                         TCPConnectCallback *callback);

    ola::io::DescriptorHandle WriteDescriptor() const { return m_handle; }

    void PerformWrite();
    void Close();

    const IPV4Address ip_address;
    TCPConnectCallback *callback;
    ola::thread::timeout_id timeout_id;

   private:
    TCPConnector *m_connector;
    ola::io::DescriptorHandle m_handle;
  };

  typedef std::set<PendingTCPConnection*> ConnectionSet;
  typedef std::vector<PendingTCPConnection*> ConnectionList;

  ola::io::SelectServerInterface *m_ss;
  ConnectionSet m_connections;
  ConnectionList m_orphaned_connections;

  void SocketWritable(PendingTCPConnection *connection);
  void FreePendingConnection(PendingTCPConnection *connection);
  void Timeout(const ConnectionSet::iterator &iter);
  void TimeoutEvent(PendingTCPConnection *connection);
  void CleanUpOrphans();

  DISALLOW_COPY_AND_ASSIGN(TCPConnector);
};
}  // namespace network
}  // namespace ola
#endif  // INCLUDE_OLA_NETWORK_TCPCONNECTOR_H_