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/SocketReadTask.hpp>
#include <Drv/Ip/TcpClientSocket.hpp>
#include "Drv/ByteStreamDriverModel/ByteStreamDriverComponentAc.hpp"
 
namespace Drv {
 
class TcpClientComponentImpl : public ByteStreamDriverModelComponentBase, public SocketReadTask {
  public:
    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
    TcpClientComponentImpl(const char* const compName);
 
 
    void init(const NATIVE_INT_TYPE instance = 0);
 
    ~TcpClientComponentImpl(void);
 
    // ----------------------------------------------------------------------
    // 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);
 
  PROTECTED:
    // ----------------------------------------------------------------------
    // Implementations for socket read task virtual methods
    // ----------------------------------------------------------------------
 
    IpSocket& getSocketHandler();
 
    Fw::Buffer getBuffer();
 
    void sendBuffer(Fw::Buffer buffer, SocketIpStatus status);
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------
 
    Drv::SendStatus send_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer);
 
    Drv::PollStatus poll_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer);
 
    Drv::TcpClientSocket m_socket; 
};
 
}  // end namespace Drv
 
#endif // end TcpClientComponentImpl