BotaRecipient Struct ReferenceBOTA Recipient API

Table of contents Table of contents

Detailed Description

Structure defining BOTA recipient instance

Data Fields

EMBENET_UDP_SocketDescriptor udpSocket
 UDP socket descriptor.
 
BotaTimeFunc timeFunc
 Callback function that will provide time for the BOTA protocol instance.
 
BotaOnTransferStartedCallback onTransferStarted
 Callback that will be called when a new incoming transfer is started.
 
BotaOnTransferReceivedCallback onTransferReceived
 Callback that will be called when an incoming transfer is received.
 
BotaOnTransferAbortedCallback onTransferAborted
 Callback that will be called when an incoming transfer is aborted.
 
BotaOnTransferDataMissingCallback onTransferDataMissing
 Callback that will be called when an incoming transfer is missing too much data.
 
BotaRecipientTransfer transfer [BOTA_RECIPIENT_MAX_TRANSFERS]
 Array of transfers.
 
bool isStarted
 Started/stopped flag.
 

Field Documentation

◆ udpSocket

EMBENET_UDP_SocketDescriptor BotaRecipient::udpSocket

UDP socket descriptor.

◆ timeFunc

BotaTimeFunc BotaRecipient::timeFunc

Callback function that will provide time for the BOTA protocol instance.

◆ onTransferStarted

BotaOnTransferStartedCallback BotaRecipient::onTransferStarted

Callback that will be called when a new incoming transfer is started.

◆ onTransferReceived

BotaOnTransferReceivedCallback BotaRecipient::onTransferReceived

Callback that will be called when an incoming transfer is received.

◆ onTransferAborted

BotaOnTransferAbortedCallback BotaRecipient::onTransferAborted

Callback that will be called when an incoming transfer is aborted.

◆ onTransferDataMissing

BotaOnTransferDataMissingCallback BotaRecipient::onTransferDataMissing

Callback that will be called when an incoming transfer is missing too much data.

◆ transfer

Array of transfers.

◆ isStarted

bool BotaRecipient::isStarted

Started/stopped flag.


The documentation for this struct was generated from the following file:

Contact us

Any question or remarks? Just write us a message!

Contact Information

Feel free to get in touch