BotaTransfer Struct ReferenceBOTA Sender API
Detailed Description
Structure describing a single BOTA transfer.
Data Fields | |
| BotaTransferId | transferId |
| ID of the transfer. More... | |
| EMBENET_IPV6 | recipientAddr |
| IPv6 address of the recipient (can be multicast) More... | |
| uint16_t | recipientPort |
| Recipient port number. More... | |
| BotaReadFunc | readFunc |
| Read function to read bulk memory. More... | |
| BotaMemoryAddr | readAddr |
| Address in Bulk memory where the bulk data starts. More... | |
| size_t | size |
| Size of the bulk data to transfer. More... | |
| BotaOnTransferAcceptedCallback | onTransferAcceptedCallback |
| Callback function to call when the transfer is accepted. More... | |
| BotaOnTransferFinishedCallback | onTransferFinishedCallback |
| Callback function to call when the transfer is finished. More... | |
| uint8_t | transferInfo [BOTA_MAX_TRANSFER_INFO_SIZE] |
| User defined data associated with the transfer. More... | |
| size_t | transferInfoSize |
| Size of the transferInfo. More... | |
| struct BotaRecipientRegistry * | recipientRegistry |
| Recipient registry. More... | |
| BotaSenderTransferState | state |
| State of the transfer. More... | |
| size_t | transferRequestSentCount |
| Number of TRANSFER.request packets sent during this transfer. More... | |
| size_t | validateRequestSentCount |
| Number of VALIDATE.request packets sent during this transfer. More... | |
| BotaSenderMissingChunk | missingChunks [BOTA_SENDER_MAX_MISSING_CHUNKS] |
| Array holding the information about missing data chunks. More... | |
| uint64_t | lastSentPacketTime |
| Time at which the last packet was sent. More... | |
| uint64_t | lastSentOrReceivedPacketTime |
| Time at which the last packet was received. More... | |
| uint32_t | amountOfDataThatWasSent |
| Counter that aggregates the amount of bytes that were already sent in the transfer. More... | |
| uint32_t | crc32 |
| CRC of the data that was already sent. More... | |
| BotaSenderTransferPolicy | policy |
| Transfer policy (settings) More... | |
| size_t | retryCount |
| Number of retries. More... | |
Field Documentation
◆ transferId
| BotaTransferId BotaTransfer::transferId |
ID of the transfer.
◆ recipientAddr
| EMBENET_IPV6 BotaTransfer::recipientAddr |
IPv6 address of the recipient (can be multicast)
◆ recipientPort
| uint16_t BotaTransfer::recipientPort |
Recipient port number.
◆ readFunc
| BotaReadFunc BotaTransfer::readFunc |
Read function to read bulk memory.
◆ readAddr
| BotaMemoryAddr BotaTransfer::readAddr |
Address in Bulk memory where the bulk data starts.
◆ size
| size_t BotaTransfer::size |
Size of the bulk data to transfer.
◆ onTransferAcceptedCallback
| BotaOnTransferAcceptedCallback BotaTransfer::onTransferAcceptedCallback |
Callback function to call when the transfer is accepted.
◆ onTransferFinishedCallback
| BotaOnTransferFinishedCallback BotaTransfer::onTransferFinishedCallback |
Callback function to call when the transfer is finished.
◆ transferInfo
| uint8_t BotaTransfer::transferInfo[BOTA_MAX_TRANSFER_INFO_SIZE] |
User defined data associated with the transfer.
◆ transferInfoSize
| size_t BotaTransfer::transferInfoSize |
Size of the transferInfo.
◆ recipientRegistry
| struct BotaRecipientRegistry* BotaTransfer::recipientRegistry |
Recipient registry.
◆ state
| BotaSenderTransferState BotaTransfer::state |
State of the transfer.
◆ transferRequestSentCount
| size_t BotaTransfer::transferRequestSentCount |
Number of TRANSFER.request packets sent during this transfer.
◆ validateRequestSentCount
| size_t BotaTransfer::validateRequestSentCount |
Number of VALIDATE.request packets sent during this transfer.
◆ missingChunks
| BotaSenderMissingChunk BotaTransfer::missingChunks[BOTA_SENDER_MAX_MISSING_CHUNKS] |
Array holding the information about missing data chunks.
◆ lastSentPacketTime
| uint64_t BotaTransfer::lastSentPacketTime |
Time at which the last packet was sent.
◆ lastSentOrReceivedPacketTime
| uint64_t BotaTransfer::lastSentOrReceivedPacketTime |
Time at which the last packet was received.
◆ amountOfDataThatWasSent
| uint32_t BotaTransfer::amountOfDataThatWasSent |
Counter that aggregates the amount of bytes that were already sent in the transfer.
◆ crc32
| uint32_t BotaTransfer::crc32 |
CRC of the data that was already sent.
◆ policy
| BotaSenderTransferPolicy BotaTransfer::policy |
Transfer policy (settings)
◆ retryCount
| size_t BotaTransfer::retryCount |
Number of retries.
The documentation for this struct was generated from the following file:
Generated on Wed Feb 8 2023 19:52:39 for BOTA Bulk-Over-The-Air service by
1.9.3