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

◆ Kick()

void drama::Path::Kick ( thread::TMessHandler action,
const std::string &  name,
const sds::Id argIn = sds::Id::CreateNullItem(),
sds::IdPtr *const  argOut = nullptr,
MessageEventHandler *const  eventProcessor = &_simpleEventProcessor 
)
inlineinherited

Sends a kick message to a task and blocks the current thread until the reply is received.

Parameters
actionA pointer to the threaded action which is executing this operation.
nameName of the action to kick.
argInArgument to the kick, if any.
eventProcessorAn object to use to process events. Defaults to a simple event processor that causes the method to return when the kick completes.
argOutThe reply message argument, if any. An address of and sds::IdPtr is supplied. If you supply a
null pointer, it is ignored. Otherwise, any argument to the kick completion is copied into here.
If there is no argument to the reply, it will refer to a null SDS item.

References drama::TransEvtInfo::complete, drama::CreateRunDramaTask(), DramaTHROW_S, and drama::TransEvtInfo::entryStatus.