tbx  0.7.5
Public Member Functions | List of all members
tbx::SaveAsFillBufferHandler Class Referenceabstract

Handler for SaveAsFillBuffer message. More...

#include <saveas.h>

Inheritance diagram for tbx::SaveAsFillBufferHandler:
tbx::Listener

Public Member Functions

virtual void saveas_fill_buffer (SaveAs saveas, bool selection, int size, void *buffer, int already_transmitted)=0
 Called when the buffer need to be refilled for a RAM transfer (type 3) save. More...
 
- Public Member Functions inherited from tbx::Listener
virtual ~Listener ()
 Destroy the listener object.
 

Additional Inherited Members

- Protected Member Functions inherited from tbx::Listener
 Listener ()
 Construct the Listener object.
 

Detailed Description

Handler for SaveAsFillBuffer message.

Called for Type 3 saves only to get the next set of data to transfer

Member Function Documentation

◆ saveas_fill_buffer()

virtual void tbx::SaveAsFillBufferHandler::saveas_fill_buffer ( SaveAs  saveas,
bool  selection,
int  size,
void *  buffer,
int  already_transmitted 
)
pure virtual

Called when the buffer need to be refilled for a RAM transfer (type 3) save.

If buffer is 0 the buffer for the RAM transfer should be allocated or maintain the address in memory of the data to be transferred.

Either way saveas.buffer_filled should be called once the buffer has the correct data.

The transfer will stop when the size of data transferred is less than a complete buffer.

Parameters
saveasSaveAs the transfer is occurring on.
selectionsaving selection only
sizeof buffer for transfer in bytes
bufferfor transfer
already_transmittednumber of bytes already transmitted

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