#include <Initiate.h>

Inheritance diagram for Adaptation::Initiate:
Collaboration diagram for Adaptation::Initiate:

Public Types

typedef CbcPointer< AsyncJobPointer
 

Public Member Functions

 Initiate (const char *aTypeName)
 
virtual ~Initiate ()
 
void initiator (const CbcPointer< Initiator > &i)
 sets initiator More...
 
virtual void noteInitiatorAborted ()=0
 
bool canBeCalled (AsyncCall &call) const
 whether we can be called More...
 
void callStart (AsyncCall &call)
 
virtual void callEnd ()
 called right after the called job method More...
 
virtual void callException (const std::exception &e)
 called when the job throws during an async call More...
 
virtual void * toCbdata ()=0
 

Static Public Member Functions

static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Protected Member Functions

void sendAnswer (const Answer &answer)
 
void tellQueryAborted (bool final)
 
void clearInitiator ()
 
virtual void swanSong ()
 
virtual const char * status () const
 internal cleanup; do not call directly More...
 
void deleteThis (const char *aReason)
 
void mustStop (const char *aReason)
 
bool done () const
 the job is destroyed in callEnd() when done() More...
 
virtual void start ()
 called by AsyncStart; do not call directly More...
 
virtual bool doneAll () const
 whether positive goal has been reached More...
 

Protected Attributes

CbcPointer< InitiatortheInitiator
 
const char * stopReason
 reason for forcing done() to be true More...
 
const char * typeName
 kid (leaf) class name, for debugging More...
 
AsyncCall::Pointer inCall
 the asynchronous call being handled, if any More...
 
const InstanceId< AsyncJobid
 job identifier More...
 

Private Member Functions

 Initiate (const Initiate &)
 
Initiateoperator= (const Initiate &)
 

Detailed Description

Definition at line 30 of file Initiate.h.

Member Typedef Documentation

◆ Pointer

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Initiate() [1/2]

Adaptation::Initiate::Initiate ( const char *  aTypeName)

Definition at line 42 of file Initiate.cc.

◆ ~Initiate()

Adaptation::Initiate::~Initiate ( )
virtual

Definition at line 46 of file Initiate.cc.

◆ Initiate() [2/2]

Adaptation::Initiate::Initiate ( const Initiate )
private

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

◆ callException()

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)
inherited

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 101 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.

◆ clearInitiator()

void Adaptation::Initiate::clearInitiator ( )
protected

Definition at line 74 of file Initiate.cc.

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

◆ doneAll()

◆ initiator()

void Adaptation::Initiate::initiator ( const CbcPointer< Initiator > &  i)

Definition at line 54 of file Initiate.cc.

References Must.

Referenced by Adaptation::Initiator::initiateAdaptation().

◆ mustStop()

◆ noteInitiatorAborted()

virtual void Adaptation::Initiate::noteInitiatorAborted ( )
pure virtual

◆ operator=()

Initiate& Adaptation::Initiate::operator= ( const Initiate )
private

◆ sendAnswer()

void Adaptation::Initiate::sendAnswer ( const Answer answer)
protected

Definition at line 79 of file Initiate.cc.

References Adaptation::Initiator::noteAdaptationAnswer(), and ScheduleCallHere.

◆ start()

◆ Start()

◆ status()

const char * Adaptation::Initiate::status ( ) const
protectedvirtual

for debugging, starts with space

Reimplemented from AsyncJob.

Reimplemented in Adaptation::Icap::Xaction, and Adaptation::Ecap::XactionRep.

Definition at line 92 of file Initiate.cc.

References AsyncJob::status().

◆ swanSong()

◆ tellQueryAborted()

void Adaptation::Initiate::tellQueryAborted ( bool  final)
protected

Definition at line 87 of file Initiate.cc.

References Adaptation::Answer::Error().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ id

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 72 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

◆ theInitiator

CbcPointer<Initiator> Adaptation::Initiate::theInitiator
protected

Definition at line 51 of file Initiate.h.

◆ typeName


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors