eive/eive-obsw
eive/eive-obsw
13
4
Fork 0
Code Issues 4 Pull Requests 1 Releases 120 Wiki Activity

better docs
All checks were successful
EIVE/eive-obsw/pipeline/pr-cfdp-source-handler This commit looks good
Details

Browse Source
This commit is contained in:
Robin Müller 2023-10-13 16:55:19 +02:00
parent ce60a639ce
commit d486c04634
Signed by: muellerr
GPG Key ID: FCE0B2BD2195142F
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
linux/ipcore/PapbVcInterface.h
View File

@ -35,18 +35,13 @@ class PapbVcInterface : public VirtualChannelIF {
size_t maxPacketSize); size_t maxPacketSize);
virtual ~PapbVcInterface(); virtual ~PapbVcInterface();
// See interface function documentation for docs on these functions.
bool isBusy() const override; bool isBusy() const override;
/**
*
* @param data
* @param size
* @return returnvalue::OK on successfull write, PAPB_BUSY if PAPB is busy.
*/
ReturnValue_t write(const uint8_t* data, size_t size, size_t& writtenSize) override; ReturnValue_t write(const uint8_t* data, size_t size, size_t& writtenSize) override;
ReturnValue_t advanceWrite(size_t& remainingSize) override; ReturnValue_t advanceWrite(size_t& remainingSize) override;
// ReturnValue_t finishWriteInternal(const uint8_t* data, size_t start, size_t remainingSize,
// size_t& writtenSize, bool abortOnPartialWrite);
void cancelTransfer() override; void cancelTransfer() override;

6
mission/tmtc/DirectTmSinkIF.h
View File

@ -37,9 +37,15 @@ class DirectTmSinkIF {
* @param writtenSize * @param writtenSize
* @return returnvalue::OK if the packet write process is complete, PARTIALLY_WRITTEN if * @return returnvalue::OK if the packet write process is complete, PARTIALLY_WRITTEN if
* some bytes were written but the transfer is not complete yet. * some bytes were written but the transfer is not complete yet.
* NO_WRITE_ACTIVE if this is called without a valid previous write call.
*/ */
virtual ReturnValue_t advanceWrite(size_t& writtenSize) = 0; virtual ReturnValue_t advanceWrite(size_t& writtenSize) = 0;
/**
* Is busy, so no write operation can not be started and write advancement
* is not possible.
* @return
*/
virtual bool isBusy() const = 0; virtual bool isBusy() const = 0;
/** /**
* The PAPB interface is currently busy writing a packet and a new packet can not be written yet. * The PAPB interface is currently busy writing a packet and a new packet can not be written yet.