UdpSocket.hpp

Go to the documentation of this file.

// ======================================================================
// \title  UdpSocket.hpp
// \author mstarch
// \brief  hpp file for UdpSocket core implementation classes
//
// \copyright
// Copyright 2009-2020, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
#ifndef DRV_IP_UDPSOCKET_HPP_
#define DRV_IP_UDPSOCKET_HPP_

#include <Drv/Ip/IpSocket.hpp>
#include <Fw/FPrimeBasicTypes.hpp>
#include <config/IpCfg.hpp>

// Include system headers for sockaddr_in
#ifdef TGT_OS_TYPE_VXWORKS
#include <inetLib.h>
#include <socket.h>

// Undefine these Vxworks-defined macros because
// they collide with member variables in F Prime.
// These macros are defined somewhere in inetLib.h.
#undef m_type
#undef m_data

#else
#include <arpa/inet.h>
#include <sys/socket.h>
#endif

namespace Drv {

class UdpSocket : public IpSocket {
  public:
    UdpSocket();
    virtual ~UdpSocket();

    SocketIpStatus configure(const char* hostname,
                             const U16 port,
                             const U32 send_timeout_seconds,
                             const U32 send_timeout_microseconds) override;

    SocketIpStatus configureSend(const char* hostname,
                                 const U16 port,
                                 const U32 send_timeout_seconds,
                                 const U32 send_timeout_microseconds);

    SocketIpStatus configureRecv(const char* hostname, const U16 port);

    U16 getRecvPort();

    SocketIpStatus send(const SocketDescriptor& socketDescriptor, const U8* const data, const FwSizeType size) override;

  protected:
    SocketIpStatus bind(const int fd);
    SocketIpStatus openProtocol(SocketDescriptor& socketDescriptor) override;
    FwSignedSizeType sendProtocol(const SocketDescriptor& socketDescriptor,
                                  const U8* const data,
                                  const FwSizeType size) override;
    FwSignedSizeType recvProtocol(const SocketDescriptor& socketDescriptor,
                                  U8* const data,
                                  const FwSizeType size) override;
    SocketIpStatus handleZeroReturn() override;

  private:
    struct sockaddr_in m_addr_send;  
    struct sockaddr_in m_addr_recv;  
    bool m_recv_configured;          
};
}  // namespace Drv

#endif /* DRV_IP_UDPSOCKET_HPP_ */