ALMA Computing Group

MyCBvoid Class Reference

This callback class is used so the caller of asynchronous methods can be informed when the method invocation has finally completed. More...

#include <acsexmplCallbacks.h>

Inheritance diagram for MyCBvoid:

Inheritance graph
[legend]
Collaboration diagram for MyCBvoid:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MyCBvoid (ACE_CString _prop)
 Constructor.
 ~MyCBvoid ()
 Destructor - nothing to delete.
void working (const ACSErr::Completion &c, const ACS::CBDescOut &desc)
 Method invoked only to inform the developer of a client that the asynchronous method has not "forgot about it", but is still working on processing the request.
void done (const ACSErr::Completion &c, const ACS::CBDescOut &desc)
 Method invoked to inform the developer of a client that the asynchronous method has completed.
CORBA::Boolean negotiate (ACS::TimeInterval time_to_transmit, const ACS::CBDescOut &desc)
 Method used so that client and servant can agree upon the time it takes to transmit data (generally invocations of the done method).

Detailed Description

This callback class is used so the caller of asynchronous methods can be informed when the method invocation has finally completed.

Definition at line 273 of file acsexmplCallbacks.h.


Constructor & Destructor Documentation

MyCBvoid::MyCBvoid ACE_CString  _prop  )  [inline]
 

Constructor.

Parameters:
_prop Name of this CBvoid instance
Definition at line 281 of file acsexmplCallbacks.h.

MyCBvoid::~MyCBvoid  )  [inline]
 

Destructor - nothing to delete.

Definition at line 286 of file acsexmplCallbacks.h.


Member Function Documentation

void MyCBvoid::done const ACSErr::Completion &  c,
const ACS::CBDescOut &  desc
 

Method invoked to inform the developer of a client that the asynchronous method has completed.

Parameters:
c Error handling structure.
desc Callback descriptor
Returns:
void

Definition at line 76 of file acsexmplCallbacksImpl.cpp.

CORBA::Boolean MyCBvoid::negotiate ACS::TimeInterval  time_to_transmit,
const ACS::CBDescOut &  desc
[inline]
 

Method used so that client and servant can agree upon the time it takes to transmit data (generally invocations of the done method).

A smart callback implementation would analyze the value of time_to_transmit and decide whether the value is acceptable, but we just return true regardless in this simplistic example.

Parameters:
time_to_transmit Time to transmit data.
desc Callback descriptor
Returns:
True regardless of parameter values.

Definition at line 330 of file acsexmplCallbacks.h.

void MyCBvoid::working const ACSErr::Completion &  c,
const ACS::CBDescOut &  desc
 

Method invoked only to inform the developer of a client that the asynchronous method has not "forgot about it", but is still working on processing the request.

Parameters:
c Error handling structure.
desc Callback descriptor
Returns:
void

Definition at line 70 of file acsexmplCallbacksImpl.cpp.


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