Detailed Description

Structure describing a single BOTA transfer.

Data Fields
BotaTransferId	transferId
	ID of the transfer.

EMBENET_IPV6	recipientAddr
	IPv6 address of the recipient (can be multicast)

uint16_t	recipientPort
	Recipient port number.

BotaReadFunc	readFunc
	Read function to read bulk memory.

BotaMemoryAddr	readAddr
	Address in Bulk memory where the bulk data starts.

size_t	size
	Size of the bulk data to transfer.

BotaOnTransferAcceptedCallback	onTransferAcceptedCallback
	Callback function to call when the transfer is accepted.

BotaOnTransferFinishedCallback	onTransferFinishedCallback
	Callback function to call when the transfer is finished.

uint8_t	transferInfo [BOTA_MAX_TRANSFER_INFO_SIZE]
	User defined data associated with the transfer.

size_t	transferInfoSize
	Size of the transferInfo.

struct BotaRecipientRegistry *	recipientRegistry
	Recipient registry.

BotaSenderTransferState	state
	State of the transfer.

size_t	transferRequestSentCount
	Number of TRANSFER.request packets sent during this transfer.

size_t	validateRequestSentCount
	Number of VALIDATE.request packets sent during this transfer.

BotaSenderMissingChunk	missingChunks [BOTA_SENDER_MAX_MISSING_CHUNKS]
	Array holding the information about missing data chunks.

uint64_t	lastSentPacketTime
	Time at which the last packet was sent.

uint64_t	lastSentOrReceivedPacketTime
	Time at which the last packet was received.

uint32_t	amountOfDataThatWasSent
	Counter that aggregates the amount of bytes that were already sent in the transfer.

uint32_t	crc32
	CRC of the data that was already sent.

BotaSenderTransferPolicy	policy
	Transfer policy (settings)

size_t	retryCount
	Number of retries.

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:

bota_sender.h

BotaTransfer Struct ReferenceBOTA Sender API