AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface

◆ SendBulkTrigger() [2/2]

void drama::MessageHandler::SendBulkTrigger ( BulkDataSds arg,
DitsTransIdType transId,
unsigned  notifyBytes = 1024*1024 
)
inlineinherited

Send a bulk data trigger message to the parent action.

In this version - the bulk data item contains an SDS item.

See SendBulkTrigger() for details about the general case.

Note
Only valid if invoked in the contact of MessageReceived() being invoked for an Obey or Kick message.
Parameters
argThe Bulk Data segment to be the argument to the trigger message, which will contain an SDS item.
transIdTransaction id for the transaction started. This will be unique (any one time - they are reused) and allows the application to distinguish multiple different outstanding trigger replies. If specified as a nullptr, then no replies be received and you won't know when the transfer is complete.
notifyBytesIf non-zero, it indicates your action should be notified (using EntryCode::BulkTransferred entries) every time the specified number of bytes are transferred. Note the this effect is somewhat dependent on the target task behavior and you may only receive the final EntryCode::BulkDone message.

References drama::CreateRunDramaTask(), and drama::MessageHandler::SendBulkTrigger().