BotaRecipientTransfer Struct ReferenceBOTA Recipient API
Detailed Description
Structure describing a single BOTA transfer at the recipient side.
Data Fields | |
| BotaTransferId | transferId |
| ID of the transfer. More... | |
| EMBENET_IPV6 | senderIPv6 |
| Sender IPv6 address. More... | |
| uint16_t | senderPort |
| Sender port. More... | |
| size_t | totalSize |
| Total size (number of bytes) of the bulk data that should be transfered in this transfer. More... | |
| uint32_t | transferredSize |
| Size of data that was already transferred (number of bytes that were sent from the sender during this transfer) More... | |
| uint32_t | receivedSize |
| Size of contiguous data that was actually received (number of contiguous bytes received) 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... | |
| BotaTransferReaction | transferReaction |
| User reaction to the transfer at the recipient. More... | |
| BotaRecipientTransferState | transferState |
| State of the transfer at the recipient. More... | |
| BotaRecipientMissingChunk | missingChunks [BOTA_RECIPIENT_MAX_MISSING_CHUNKS] |
| Array holding the information about missing data chunks. More... | |
| BotaDestinationMemory | destMemory |
| User-provided destination memory for the transfer. More... | |
| uint32_t | lastValidateRequestSize |
| Size used in the last VALIDATE.request (for caching purposes) More... | |
| uint32_t | lastValidateRequestCRC |
| CRC produced during last VALIDATE.request (for caching purposes) More... | |
| uint64_t | lastPacketTime |
| time at which last packet from that transfer was received from the sender More... | |
| uint64_t | transferConfirmationSendTimestamp |
| time at which TRANSFER.confirmation should be sent, 0 means that the packet should not be sent More... | |
| uint64_t | validateConfirmationSendTimestamp |
| time at which VALIDATE.confirmation should be sent, 0 means that the packet should not be sent More... | |
| uint64_t | bulkMissingSendTimestamp |
| time at which BULK_MISSING.request should be sent, 0 means that the packet should not be sent More... | |
Field Documentation
◆ transferId
| BotaTransferId BotaRecipientTransfer::transferId |
ID of the transfer.
◆ senderIPv6
| EMBENET_IPV6 BotaRecipientTransfer::senderIPv6 |
Sender IPv6 address.
◆ senderPort
| uint16_t BotaRecipientTransfer::senderPort |
Sender port.
◆ totalSize
| size_t BotaRecipientTransfer::totalSize |
Total size (number of bytes) of the bulk data that should be transfered in this transfer.
◆ transferredSize
| uint32_t BotaRecipientTransfer::transferredSize |
Size of data that was already transferred (number of bytes that were sent from the sender during this transfer)
◆ receivedSize
| uint32_t BotaRecipientTransfer::receivedSize |
Size of contiguous data that was actually received (number of contiguous bytes received)
◆ transferInfo
| uint8_t BotaRecipientTransfer::transferInfo[BOTA_MAX_TRANSFER_INFO_SIZE] |
User-defined data associated with the transfer.
◆ transferInfoSize
| size_t BotaRecipientTransfer::transferInfoSize |
Size of the transferInfo.
◆ transferReaction
| BotaTransferReaction BotaRecipientTransfer::transferReaction |
User reaction to the transfer at the recipient.
◆ transferState
| BotaRecipientTransferState BotaRecipientTransfer::transferState |
State of the transfer at the recipient.
◆ missingChunks
| BotaRecipientMissingChunk BotaRecipientTransfer::missingChunks[BOTA_RECIPIENT_MAX_MISSING_CHUNKS] |
Array holding the information about missing data chunks.
◆ destMemory
| BotaDestinationMemory BotaRecipientTransfer::destMemory |
User-provided destination memory for the transfer.
◆ lastValidateRequestSize
| uint32_t BotaRecipientTransfer::lastValidateRequestSize |
Size used in the last VALIDATE.request (for caching purposes)
◆ lastValidateRequestCRC
| uint32_t BotaRecipientTransfer::lastValidateRequestCRC |
CRC produced during last VALIDATE.request (for caching purposes)
◆ lastPacketTime
| uint64_t BotaRecipientTransfer::lastPacketTime |
time at which last packet from that transfer was received from the sender
◆ transferConfirmationSendTimestamp
| uint64_t BotaRecipientTransfer::transferConfirmationSendTimestamp |
time at which TRANSFER.confirmation should be sent, 0 means that the packet should not be sent
◆ validateConfirmationSendTimestamp
| uint64_t BotaRecipientTransfer::validateConfirmationSendTimestamp |
time at which VALIDATE.confirmation should be sent, 0 means that the packet should not be sent
◆ bulkMissingSendTimestamp
| uint64_t BotaRecipientTransfer::bulkMissingSendTimestamp |
time at which BULK_MISSING.request should be sent, 0 means that the packet should not be sent
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