F´ Flight Software - C/C++ Documentation devel
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TcpClientComponentImpl.cpp
Go to the documentation of this file.
1// ======================================================================
2// \title TcpClientComponentImpl.cpp
3// \author mstarch
4// \brief cpp file for TcpClientComponentImpl component implementation class
5//
6// \copyright
7// Copyright 2009-2020, by the California Institute of Technology.
8// ALL RIGHTS RESERVED. United States Government Sponsorship
9// acknowledged.
10//
11// ======================================================================
12
14#include <FpConfig.hpp>
15#include "Fw/Types/Assert.hpp"
16
17
18namespace Drv {
19
20// ----------------------------------------------------------------------
21// Construction, initialization, and destruction
22// ----------------------------------------------------------------------
23
27
29 const U16 port,
30 const U32 send_timeout_seconds,
31 const U32 send_timeout_microseconds) {
32 return m_socket.configure(hostname, port, send_timeout_seconds, send_timeout_microseconds);
33}
34
36
37// ----------------------------------------------------------------------
38// Implementations for socket read task virtual methods
39// ----------------------------------------------------------------------
40
44
48
51 this->recv_out(0, buffer, recvStatus);
52}
53
56 this->ready_out(0);
57 }
58
59}
60
61// ----------------------------------------------------------------------
62// Handler implementations for user-defined typed input ports
63// ----------------------------------------------------------------------
64
65Drv::SendStatus TcpClientComponentImpl::send_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer) {
66 Drv::SocketIpStatus status = m_socket.send(fwBuffer.getData(), fwBuffer.getSize());
67 // Only deallocate buffer when the caller is not asked to retry
68 if (status == SOCK_INTERRUPTED_TRY_AGAIN) {
70 } else if (status != SOCK_SUCCESS) {
71 deallocate_out(0, fwBuffer);
73 }
74 deallocate_out(0, fwBuffer);
76}
77
78} // end namespace Drv
PlatformIntType NATIVE_INT_TYPE
Definition BasicTypes.h:51
C++-compatible configuration header for fprime configuration.
Helper base-class for setting up Berkeley sockets.
Definition IpSocket.hpp:46
SocketIpStatus send(const U8 *const data, const U32 size)
send data out the IP socket from the given buffer
Definition IpSocket.cpp:160
SocketIpStatus configure(const char *hostname, const U16 port, const U32 send_timeout_seconds, const U32 send_timeout_microseconds)
configure the ip socket with host and transmission timeouts
Definition IpSocket.cpp:53
Status associated with the received data.
@ RECV_OK
Receive worked as expected.
@ RECV_ERROR
Receive error occurred retrying may succeed.
Status returned by the send call.
@ SEND_ERROR
Send error occurred retrying may succeed.
@ SEND_RETRY
Data send should be retried.
@ SEND_OK
Send worked as expected.
supports a task to read a given socket adaptation
Auto-generated base for TcpClient component.
void deallocate_out(NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
Invoke output port deallocate.
void recv_out(NATIVE_INT_TYPE portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
Invoke output port recv.
void ready_out(NATIVE_INT_TYPE portNum)
Invoke output port ready.
bool isConnected_ready_OutputPort(NATIVE_INT_TYPE portNum)
Fw::Buffer allocate_out(NATIVE_INT_TYPE portNum, U32 size)
Invoke output port allocate.
TcpClientComponentImpl(const char *const compName)
construct the TcpClient component.
void connected()
called when the IPv4 system has been connected
void sendBuffer(Fw::Buffer buffer, SocketIpStatus status)
sends a buffer to be filled with data
IpSocket & getSocketHandler()
returns a reference to the socket handler
Fw::Buffer getBuffer()
returns a buffer to fill with data
~TcpClientComponentImpl()
Destroy the component.
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)
Configures the TcpClient settings but does not open the connection.
U8 * getData() const
Definition Buffer.cpp:68
U32 getSize() const
Definition Buffer.cpp:72
SocketIpStatus
Status enumeration for socket return values.
Definition IpSocket.hpp:23
@ SOCK_SUCCESS
Socket operation successful.
Definition IpSocket.hpp:24
@ SOCK_INTERRUPTED_TRY_AGAIN
Interrupted status for retries.
Definition IpSocket.hpp:30