SocketComponentHelper.hpp

Go to the documentation of this file.

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

#include <Fw/Buffer/Buffer.hpp>
#include <Drv/Ip/IpSocket.hpp>
#include <Os/Task.hpp>
#include <Os/Mutex.hpp>

namespace Drv {
class SocketComponentHelper {
  public:
    enum OpenState{
        NOT_OPEN,
        OPENING,
        OPEN,
        SKIP
    };
    SocketComponentHelper();

    virtual ~SocketComponentHelper();

    void start(const Fw::StringBase &name,
               const Os::Task::ParamType priority = Os::Task::TASK_DEFAULT,
               const Os::Task::ParamType stack = Os::Task::TASK_DEFAULT,
               const Os::Task::ParamType cpuAffinity = Os::Task::TASK_DEFAULT);

    SocketIpStatus open();

    bool isOpened();

    void setAutomaticOpen(bool auto_open);

    SocketIpStatus send(const U8* const data, const U32 size);

    SocketIpStatus recv(U8* data, U32 &size);

    void close();

    void shutdown();

    bool running();

    void stop();

    Os::Task::Status join();

  PROTECTED:
    virtual void readLoop();
    virtual IpSocket& getSocketHandler() = 0;

    virtual Fw::Buffer getBuffer() = 0;

    virtual void sendBuffer(Fw::Buffer buffer, SocketIpStatus status) = 0;

    virtual void connected() = 0;


    static void readTask(void* pointer);

  PRIVATE:
    SocketIpStatus reopen();

  PROTECTED:
    Os::Task m_task;
    Os::Mutex m_lock;
    SocketDescriptor m_descriptor;
    bool m_reopen = true; 
    bool m_stop = true; 
    OpenState m_open = OpenState::NOT_OPEN; 
};
}
#endif  // DRV_SocketComponentHelper_HPP