fsfw/osal/common/UdpTcPollingTask.h

66 lines
2.0 KiB
C
Raw Normal View History

2020-09-06 15:46:49 +02:00
#ifndef FSFW_OSAL_WINDOWS_TCSOCKETPOLLINGTASK_H_
#define FSFW_OSAL_WINDOWS_TCSOCKETPOLLINGTASK_H_
#include "UdpTmTcBridge.h"
2020-09-06 15:46:49 +02:00
#include "../../objectmanager/SystemObject.h"
#include "../../tasks/ExecutableObjectIF.h"
#include "../../storagemanager/StorageManagerIF.h"
#include <vector>
/**
* @brief This class can be used to implement the polling of a Unix socket,
* using UDP for now.
* @details
* The task will be blocked while the specified number of bytes has not been
* received, so TC reception is handled inside a separate task.
* This class caches the IP address of the sender. It is assumed there
* is only one sender for now.
*/
class UdpTcPollingTask:
public TcpIpBase,
public SystemObject,
2020-09-06 15:46:49 +02:00
public ExecutableObjectIF {
friend class TmTcWinUdpBridge;
public:
static constexpr size_t DEFAULT_MAX_FRAME_SIZE = 2048;
//! 0.5 default milliseconds timeout for now.
2021-03-07 01:35:55 +01:00
static constexpr timeval DEFAULT_TIMEOUT = {0, 500};
2020-09-06 15:46:49 +02:00
UdpTcPollingTask(object_id_t objectId, object_id_t tmtcUnixUdpBridge,
2020-09-06 15:46:49 +02:00
size_t frameSize = 0, double timeoutSeconds = -1);
virtual~ UdpTcPollingTask();
2020-09-06 15:46:49 +02:00
/**
* Turn on optional timeout for UDP polling. In the default mode,
* the receive function will block until a packet is received.
* @param timeoutSeconds
*/
void setTimeout(double timeoutSeconds);
virtual ReturnValue_t performOperation(uint8_t opCode) override;
virtual ReturnValue_t initialize() override;
virtual ReturnValue_t initializeAfterTaskCreation() override;
protected:
StorageManagerIF* tcStore = nullptr;
private:
//! TMTC bridge is cached.
object_id_t tmtcBridgeId = objects::NO_OBJECT;
UdpTmTcBridge* tmtcBridge = nullptr;
2020-09-06 15:46:49 +02:00
MessageQueueId_t targetTcDestination = MessageQueueIF::NO_QUEUE;
2021-03-12 02:15:21 +01:00
//! See: https://docs.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-recvfrom
2020-09-06 15:46:49 +02:00
int receptionFlags = 0;
std::vector<uint8_t> receptionBuffer;
size_t frameSize = 0;
timeval receptionTimeout;
ReturnValue_t handleSuccessfullTcRead(size_t bytesRead);
};
#endif /* FRAMEWORK_OSAL_LINUX_TCSOCKETPOLLINGTASK_H_ */