Type defining a function that will be called when a new incoming BOTA transfer is started in the recipient.

This callback will be called when the node receives a new (incoming) BOTA transfer from the specified sender. The node can accept or reject the transfer or can mark that the transfer has already been received.

To accept the transfer this callback should:

1. fill in the BotaDestinationMemory structure passed in as the memory argument
2. return BOTA_TRANSFER_REACTION_ACCEPT Once the transfer is accepted the BOTA protocol will use the provided definition of the destination memory to handle and save the incoming data. The memory should have sufficient capacity to store the transfer data, otherwise the transfer will be aborted.

To reject the transfer this callback should return BOTA_TRANSFER_REACTION_REJECT In this case the transfer will be marked as rejected in the sender. The transfer will not be started on the recipient side.

To mark the transfer as already received this callback should return BOTA_TRANSFER_REACTION_MARK_AS_RECEIVED. In this case the transfer will be marked as succeeded in the sender. The transfer will not be started on the recipient side.

Parameters

[in]	transferId	id of the transfer
[in]	senderAddr	address of the sender
[in]	bulkSize	size of the incoming bulk transfer
[in]	transferInfo	user-defined data associated with the transfer
[in]	transferInfoSize	size of the user-defined data associated with the transfer (number of bytes)
[out]	destinationMemory	destination memory structure that should be filled if the user accepts the transfer (otherwise leave it untouched)

Return values

BOTA_TRANSFER_REACTION_ACCEPT	if the transfer should be accepted
BOTA_TRANSFER_REACTION_REJECT	if the transfer should be rejected
BOTA_TRANSFER_REACTION_MARK_AS_RECEIVED	if the transfer should be marked as already received

Type defining a function that will be called when an incoming BOTA transfer is received.

Parameters

[in]	transferId	id of the transfer
[in]	memory	structure describing the memory where the transfer data was stored
[in]	size	total transfer size
[in]	transferInfo	user-defined data associated with the transfer
[in]	transferInfoSize	size of the user-defined data associated with the transfer (number of bytes)

Type defining a function that will be called when an incoming BOTA transfer is aborted.

Parameters

[in]	transferId	id of the transfer
[in]	memory	structure describing the memory where the transfer data was stored
[in]	size	total transfer size
[in]	transferInfo	user-defined data associated with the transfer
[in]	transferInfoSize	size of the user-defined data associated with the transfer (number of bytes)
[in]	abortReason	reason why the transfer was aborted

Type defining a function that will be called when an incoming BOTA transfer is missing too much data to continue.

Parameters

[in]	transferId	id of the transfer
[in]	receivedSize	total transfer size
[in]	totalSize	total transfer size
[in]	transferInfo	user-defined data associated with the transfer
[in]	transferInfoSize	size of the user-defined data associated with the transfer (number of bytes)

Possible reasons for aborting the transfer.

Possible states of a single transfer.

Initializes the BOTA protocol instance for the recipient.

Parameters

[in]	botaRecipient	BOTA recipient instance
[in]	port	UDP port number used for BOTA transfers. This number should be the same in all BOTA-enabled devices. Consider using BOTA_DEFAULT_PORT value.
[in]	timeFunc	callback function that will provide time for the BOTA protocol instance
[in]	onTransferStarted	callback that will be called when a new incoming transfer is started. This callback is mandatory.
[in]	onTransferReceived	callback that will be called when an incoming transfer is successfully received. This callback is optional.
[in]	onTransferAborted	callback that will be called when an incoming transfer is aborted. This callback is optional.
[in]	onTransferDataMissing	callback that will be called when the transfer missed too much data to be able to continue. This callback is optional.

Deinitializes the BOTA protocol instance in the recipient.

Parameters

[in]

botaRecipient

BOTA recipient instance

Starts the BOTA Recipient service.

This function starts the BOTA Recipient service. It is typically called in reaction to the event that the node has joined a network.

Parameters

[in]

botaRecipient

BOTA recipient instance

Return values

BOTA_RESULT_OK	if the service was initialized successfully
BOTA_RESULT_INVALID_INPUT_ARGUMENT	if at least one of the input arguments was invalid

Stops the BOTA Recipient service.

This function stops the BOTA Recipient service. It is typically called in reaction to the event that the node has left a network. Call this function will cause all the ongoing transfers to be halted. A halted transfer is be picked up when the BOTA Sender restarts such transfer. The service can be restarted by a call to BOTA_RECIPIENT_Start.

Parameters

[in]

botaRecipient

BOTA recipient instance

Return values

BOTA_RESULT_OK	if the service was initialized successfully
BOTA_RESULT_INVALID_INPUT_ARGUMENT	if at least one of the input arguments was invalid

Runs the BOTA protocol instance in the recipient.

Parameters

[in]

botaRecipient

BOTA recipient instance

Gets the status of the incoming BOTA transfer.

Parameters

[in]	botaRecipient	BOTA recipient instance
[in]	transferId	id of the transfer

Returns

structure describing the status of the transfer at the recipient

Aborts the ongoing transfer in the recipient.

This function allows to abort the ongoing transfer. It can be called from within the read and write functions of the destination memory (BotaDestinationMemory::read, BotaDestinationMemory::write). This function can also be used from other callbacks such as onTransferStarted as long as it aborts some other transfer, and not the one the given callback refers to. Aborting the transfer from its own onTransferStarted, onTransferReceived or onTransferAborted callback makes no sense and is not supported (may lead to undefined behavior).

Calling this function invokes the onTransferAborted callback (if it was provided).

Parameters

[in]	botaRecipient	BOTA recipient instance
[in]	transferId	id of the transfer to be aborted