TcpClientComponentImpl.hpp

Go to the documentation of this file.

// ======================================================================
// \title  TcpClientComponentImpl.hpp
// \author mstarch
// \brief  hpp file for TcpClientComponentImpl component implementation class
//
// \copyright
// Copyright 2009-2020, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef TcpClientComponentImpl_HPP
#define TcpClientComponentImpl_HPP

#include <Drv/Ip/IpSocket.hpp>
#include <Drv/Ip/SocketComponentHelper.hpp>
#include <Drv/Ip/TcpClientSocket.hpp>
#include "Drv/TcpClient/TcpClientComponentAc.hpp"

namespace Drv {

class TcpClientComponentImpl final : public TcpClientComponentBase, public SocketComponentHelper {
    friend class TcpClientTester;

  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    TcpClientComponentImpl(const char* const compName);

    ~TcpClientComponentImpl();

    // ----------------------------------------------------------------------
    // Helper methods to start and stop socket
    // ----------------------------------------------------------------------

    SocketIpStatus configure(const char* hostname,
                             const U16 port,
                             const U32 send_timeout_seconds = SOCKET_SEND_TIMEOUT_SECONDS,
                             const U32 send_timeout_microseconds = SOCKET_SEND_TIMEOUT_MICROSECONDS,
                             FwSizeType buffer_size = 1024);

  protected:
    // ----------------------------------------------------------------------
    // Implementations for socket read task virtual methods
    // ----------------------------------------------------------------------

    IpSocket& getSocketHandler() override;

    Fw::Buffer getBuffer() override;

    void sendBuffer(Fw::Buffer buffer, SocketIpStatus status) override;

    void connected() override;

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------

    Drv::ByteStreamStatus send_handler(const FwIndexType portNum, Fw::Buffer& fwBuffer) override;

    void recvReturnIn_handler(FwIndexType portNum,  
                              Fw::Buffer& fwBuffer  
                              ) override;

    Drv::TcpClientSocket m_socket;  

    // Member variable to store the buffer size
    FwSizeType m_allocation_size;
};

}  // end namespace Drv

#endif  // end TcpClientComponentImpl