summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/tests/Event/Basic
diff options
context:
space:
mode:
authorJohnny Willemsen <jwillemsen@remedy.nl>2003-07-18 15:15:34 +0000
committerJohnny Willemsen <jwillemsen@remedy.nl>2003-07-18 15:15:34 +0000
commit6846de18b24ca9a22718ee4c050374fc9c5a066f (patch)
tree6424acb27b45cee8584c8954a85354397394ff7a /TAO/orbsvcs/tests/Event/Basic
parent70d6a09a9cfe77b905fb2281cdc4c48ffd212e50 (diff)
downloadATCD-6846de18b24ca9a22718ee4c050374fc9c5a066f.tar.gz
ChangeLogTag: Fri Jul 18 15:15:12 UTC 2003 Johnny Willemsen <jwillemsen@remedy.nl>
Diffstat (limited to 'TAO/orbsvcs/tests/Event/Basic')
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/Atomic_Reconnect.h43
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/BCast.h61
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/Control.h43
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/MT_Disconnect.h34
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/Observer.h75
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/Random.h66
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/Reconnect.h72
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/Schedule.h80
-rw-r--r--TAO/orbsvcs/tests/Event/Basic/Shutdown.h54
9 files changed, 247 insertions, 281 deletions
diff --git a/TAO/orbsvcs/tests/Event/Basic/Atomic_Reconnect.h b/TAO/orbsvcs/tests/Event/Basic/Atomic_Reconnect.h
index e808ca3d26a..6aafd6e9dce 100644
--- a/TAO/orbsvcs/tests/Event/Basic/Atomic_Reconnect.h
+++ b/TAO/orbsvcs/tests/Event/Basic/Atomic_Reconnect.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel tests
-//
-// = FILENAME
-// Atomic_Reconnect.h
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Atomic_Reconnect.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_ATOMIC_RECONNECT_H
#define EC_ATOMIC_RECONNECT_H
@@ -24,17 +20,18 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Consumer
+ *
+ * @brief Simple consumer object
+ *
+ */
class Consumer : public EC_Counting_Consumer
{
- // = TITLE
- // Simple consumer object
- //
- // = DESCRIPTION
- //
public:
+ /// Constructor
Consumer (const char* name,
int event_base_type);
- // Constructor
void dump_results (int expected_count,
int tolerance);
@@ -48,15 +45,15 @@ public:
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException));
+ /// Number of events of type <event_base_type_> received.
CORBA::ULong event_base_count;
- // Number of events of type <event_base_type_> received.
private:
+ /// Base event type
int event_base_type_;
- // Base event type
+ /// Synchronize access to the counter
TAO_SYNCH_MUTEX lock_;
- // Synchronize access to the counter
};
#endif /* EC_ATOMIC_RECONNECT_H */
diff --git a/TAO/orbsvcs/tests/Event/Basic/BCast.h b/TAO/orbsvcs/tests/Event/Basic/BCast.h
index 85e4f32437d..1bd9ea7d528 100644
--- a/TAO/orbsvcs/tests/Event/Basic/BCast.h
+++ b/TAO/orbsvcs/tests/Event/Basic/BCast.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// BCast
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file BCast.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_BCAST_H
#define EC_BCAST_H
@@ -24,50 +20,53 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class EC_BCast
+ *
+ * @brief Test the EC bcast
+ *
+ */
class EC_BCast : public EC_Driver
{
- //
- // = TITLE
- // Test the EC bcast
- //
- // = DESCRIPTION
- //
public:
+ /// Constructor
EC_BCast (void);
- // Constructor
// = The EC_Driver methods
+ /// add some command line args to enable/disable bcastions
virtual int parse_args (int& argc, char* argv[]);
virtual void print_args (void) const;
virtual void print_usage (void);
- // add some command line args to enable/disable bcastions
+ /// set the bcastion flags
virtual void modify_attributes (TAO_EC_Event_Channel_Attributes& attr);
- // set the bcastion flags
+ /// Don't run the suppliers, just test connect and disconnect calls.
void execute_test (ACE_ENV_SINGLE_ARG_DECL);
- // Don't run the suppliers, just test connect and disconnect calls.
+ /// Don't dump the EC_Driver results, they are meaningless.
void dump_results (void);
- // Don't dump the EC_Driver results, they are meaningless.
private:
+ /// The IP address used to broadcast
const char* bcast_address_;
- // The IP address used to broadcast
+ /// The port used to send and receive bcast messages...
u_short bcast_port_;
- // The port used to send and receive bcast messages...
};
// ****************************************************************
+/**
+ * @class Simple_Address_Server
+ *
+ * A fixed address server
+ */
class Simple_Address_Server : public POA_RtecUDPAdmin::AddrServer
{
- // = DESCRIPTION
- // A fixed address server
public:
+ /// constructo
Simple_Address_Server (const ACE_INET_Addr& address);
- // constructo
virtual void get_addr (const RtecEventComm::EventHeader& header,
RtecUDPAdmin::UDP_Addr& address
@@ -75,8 +74,8 @@ public:
ACE_THROW_SPEC ((CORBA::SystemException));
private:
+ /// The UDP addres...
RtecUDPAdmin::UDP_Addr address_;
- // The UDP addres...
};
#endif /* EC_BCAST_H */
diff --git a/TAO/orbsvcs/tests/Event/Basic/Control.h b/TAO/orbsvcs/tests/Event/Basic/Control.h
index 7ad7d9772f5..2df1cb7e3ea 100644
--- a/TAO/orbsvcs/tests/Event/Basic/Control.h
+++ b/TAO/orbsvcs/tests/Event/Basic/Control.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel tests
-//
-// = FILENAME
-// Control.h
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Control.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_CONTROL_H
#define EC_CONTROL_H
@@ -24,17 +20,18 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class Consumer
+ *
+ * @brief Simple consumer object
+ *
+ */
class Consumer : public EC_Counting_Consumer
{
- // = TITLE
- // Simple consumer object
- //
- // = DESCRIPTION
- //
public:
+ /// Constructor
Consumer (const char* name,
int event_count);
- // Constructor
// = The RtecEventComm::PushConsumer methods
@@ -43,12 +40,12 @@ public:
ACE_THROW_SPEC ((CORBA::SystemException));
private:
+ /// After this number of events the consumer disconnects from the
+ /// event service.
CORBA::ULong shutdown_count_;
- // After this number of events the consumer disconnects from the
- // event service.
+ /// Synchronize access to the counter
TAO_SYNCH_MUTEX lock_;
- // Synchronize access to the counter
};
#endif /* EC_CONTROL_H */
diff --git a/TAO/orbsvcs/tests/Event/Basic/MT_Disconnect.h b/TAO/orbsvcs/tests/Event/Basic/MT_Disconnect.h
index 4448774b248..06855260d66 100644
--- a/TAO/orbsvcs/tests/Event/Basic/MT_Disconnect.h
+++ b/TAO/orbsvcs/tests/Event/Basic/MT_Disconnect.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel tests
-//
-// = FILENAME
-// MT_Disconnect.h
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file MT_Disconnect.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_MT_DISCONNECT_H
#define EC_MT_DISCONNECT_H
@@ -27,23 +23,23 @@
class Task : public ACE_Task_Base
{
public:
+ /// Create the task...
Task (RtecEventChannelAdmin::EventChannel_ptr ec,
int use_callbacks);
- // Create the task...
// = Check the ACE_Task_Base documentation.
int svc (void);
+ /// Run a single iteration of the test
void run_iteration (ACE_ENV_SINGLE_ARG_DECL);
- // Run a single iteration of the test
private:
+ /// The event channel used on the test
RtecEventChannelAdmin::EventChannel_var event_channel;
- // The event channel used on the test
+ /// Does the event channel send any callback messages when a client
+ /// diconnects
int use_callbacks;
- // Does the event channel send any callback messages when a client
- // diconnects
};
#endif /* EC_DISCONNECT_H */
diff --git a/TAO/orbsvcs/tests/Event/Basic/Observer.h b/TAO/orbsvcs/tests/Event/Basic/Observer.h
index 4ff6fd35604..bb788c01258 100644
--- a/TAO/orbsvcs/tests/Event/Basic/Observer.h
+++ b/TAO/orbsvcs/tests/Event/Basic/Observer.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// Observer
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Observer.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_OBSERVER_H
#define EC_OBSERVER_H
@@ -26,79 +22,80 @@
class EC_Observer;
+/**
+ * @class EC_Master
+ *
+ * @brief Run multiple events channels
+ *
+ * This test runs multiple event channels, all connected using
+ * gateways.
+ */
class EC_Master
{
- // = TITLE
- // Run multiple events channels
- //
- // = DESCRIPTION
- // This test runs multiple event channels, all connected using
- // gateways.
- //
public:
EC_Master (void);
virtual ~EC_Master (void);
+ /// Execute the test.
virtual int run (int argc, char* argv[]);
- // Execute the test.
+ /// Obtain the orb and the poa pointers
virtual void initialize_orb_and_poa (int& argc, char* argv[]
ACE_ENV_ARG_DECL);
- // Obtain the orb and the poa pointers
+ /// Accessors
int channel_count (void) const;
EC_Observer* channel (int i) const;
- // Accessors
private:
int parse_args (int &argc, char *argv []);
private:
+ /// The seed
ACE_RANDR_TYPE seed_;
- // The seed
+ /// The driver programs
int n_channels_;
EC_Observer** channels_;
- // The driver programs
+ /// The ORB
CORBA::ORB_var orb_;
- // The ORB
+ /// The Root POA
PortableServer::POA_var root_poa_;
- // The Root POA
};
+/**
+ * @class EC_Observer
+ *
+ * @brief Test the EC observers
+ *
+ */
class EC_Observer : public EC_Driver
{
- //
- // = TITLE
- // Test the EC observers
- //
- // = DESCRIPTION
- //
public:
+ /// Constructor
EC_Observer (EC_Master *master,
ACE_RANDR_TYPE seed,
CORBA::ORB_ptr orb,
PortableServer::POA_ptr root_poa,
int id);
- // Constructor
+ /// Destructor
~EC_Observer (void);
- // Destructor
// = The EC_Driver methods
+ /// add some command line args to enable/disable observerions
virtual void initialize_orb_and_poa (int& argc, char* argv[]
ACE_ENV_ARG_DECL);
virtual int parse_args (int& argc, char* argv[]);
virtual void print_args (void) const;
virtual void print_usage (void);
- // add some command line args to enable/disable observerions
+ /// Run the suppliers, using the <thread_manager> parameter
void execute_test (ACE_ENV_SINGLE_ARG_DECL);
void run_cleanup (ACE_ENV_SINGLE_ARG_DECL);
- // Run the suppliers, using the <thread_manager> parameter
void dump_results (void);
void connect_consumer (
@@ -116,8 +113,8 @@ private:
TAO_EC_Gateway_IIOP *gwys_;
+ /// lock internal state
TAO_SYNCH_MUTEX lock_;
- // lock internal state
};
#endif /* EC_OBSERVER_H */
diff --git a/TAO/orbsvcs/tests/Event/Basic/Random.h b/TAO/orbsvcs/tests/Event/Basic/Random.h
index fbbb5ee8468..22fd387192b 100644
--- a/TAO/orbsvcs/tests/Event/Basic/Random.h
+++ b/TAO/orbsvcs/tests/Event/Basic/Random.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel tests
-//
-// = FILENAME
-// Random.h
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Random.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_RANDOM_H
#define EC_RANDOM_H
@@ -44,8 +40,8 @@ class RND_Consumer
// = DESCRIPTION
//
public:
+ /// Constructor
RND_Consumer (RND_Driver *driver);
- // Constructor
void push (const RtecEventComm::EventSet &event
ACE_ENV_ARG_DECL)
@@ -59,14 +55,14 @@ public:
void disconnect (ACE_ENV_SINGLE_ARG_DECL);
protected:
+ /// The driver
RND_Driver *driver_;
- // The driver
+ /// The supplier.
RtecEventChannelAdmin::ProxyPushSupplier_var proxy_;
- // The supplier.
+ /// Synch
TAO_SYNCH_MUTEX lock_;
- // Synch
};
inline
@@ -106,34 +102,34 @@ class RND_Supplier
// = DESCRIPTION
//
public:
+ /// Constructor
RND_Supplier (int verbose);
- // Constructor
void connect (RtecEventChannelAdmin::SupplierAdmin_ptr admin,
const RtecEventChannelAdmin::SupplierQOS &qos
ACE_ENV_ARG_DECL);
void disconnect (ACE_ENV_SINGLE_ARG_DECL);
+ /// Push a single event...
void push_new_event (ACE_ENV_SINGLE_ARG_DECL);
void push (RtecEventComm::EventSet &event
ACE_ENV_ARG_DECL);
- // Push a single event...
virtual void disconnect_push_supplier (ACE_ENV_SINGLE_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException));
+ /// Active method
virtual int svc (void);
- // Active method
private:
+ /// The supplier.
RtecEventChannelAdmin::ProxyPushConsumer_var proxy_;
- // The supplier.
+ /// Synch
TAO_SYNCH_MUTEX lock_;
- // Synch
+ /// Be verbose about the progress of the test
int verbose_;
- // Be verbose about the progress of the test
};
inline
@@ -149,45 +145,45 @@ class RND_Driver
public:
RND_Driver (void);
+ /// Run the test
int run (int argc, char *argv[]);
- // Run the test
+ /// The main timer has expired
void timer (const RtecEventComm::Event &e
ACE_ENV_ARG_DECL);
- // The main timer has expired
+ /// One of the consumers has received an event
void event (const RtecEventComm::Event &e
ACE_ENV_ARG_DECL);
- // One of the consumers has received an event
private:
RND_Driver (const RND_Driver &);
RND_Driver& operator= (const RND_Driver &);
private:
+ /// The main timer
RND_Timer timer_;
- // The main timer
+ /// The supplier
RND_Supplier supplier_;
- // The supplier
+ /// Number of suppliers
int nsuppliers_;
- // Number of suppliers
+ /// The suppliers
RND_Supplier **suppliers_;
- // The suppliers
+ /// Number of consumers
int nconsumers_;
- // Number of consumers
+ /// The consumers
RND_Consumer **consumers_;
- // The consumers
+ /// Maximum recursion
int max_recursion_;
- // Maximum recursion
+ /// Be verbose about the progress of the test
int verbose_;
- // Be verbose about the progress of the test
RtecEventChannelAdmin::ConsumerAdmin_var consumer_admin_;
RtecEventChannelAdmin::SupplierAdmin_var supplier_admin_;
diff --git a/TAO/orbsvcs/tests/Event/Basic/Reconnect.h b/TAO/orbsvcs/tests/Event/Basic/Reconnect.h
index 5430aebd876..e99cd4b9ffb 100644
--- a/TAO/orbsvcs/tests/Event/Basic/Reconnect.h
+++ b/TAO/orbsvcs/tests/Event/Basic/Reconnect.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// Reconnect
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Reconnect.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_RECONNECT_H
#define EC_RECONNECT_H
@@ -23,54 +19,54 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class EC_Reconnect
+ *
+ * @brief Test the EC reconnection feature
+ *
+ * The EC can be configured to allow re-connection of suppliers
+ * and consumers, this test verifies that:
+ * + The EC does *not* allow reconnections if the feature is
+ * disabled (the default)
+ * + The EC does allow reconnections if the feature is enabled
+ * and:
+ * - There are no memory leaks
+ * - Compares the time required for a reconnection vs a complete
+ * connect/disconnect cycle, specially as the number of
+ * suppliers and consumers increases.
+ */
class EC_Reconnect : public EC_Driver
{
- //
- // = TITLE
- // Test the EC reconnection feature
- //
- // = DESCRIPTION
- // The EC can be configured to allow re-connection of suppliers
- // and consumers, this test verifies that:
- // + The EC does *not* allow reconnections if the feature is
- // disabled (the default)
- // + The EC does allow reconnections if the feature is enabled
- // and:
- // - There are no memory leaks
- // - Compares the time required for a reconnection vs a complete
- // connect/disconnect cycle, specially as the number of
- // suppliers and consumers increases.
- //
public:
+ /// Constructor
EC_Reconnect (void);
- // Constructor
// = The EC_Driver methods
+ /// add some command line args to enable/disable reconnections
virtual int parse_args (int& argc, char* argv[]);
virtual void print_args (void) const;
virtual void print_usage (void);
- // add some command line args to enable/disable reconnections
+ /// set the reconnection flags
virtual void modify_attributes (TAO_EC_Event_Channel_Attributes& attr);
- // set the reconnection flags
+ /// Don't run the suppliers, just test connect and disconnect calls.
void execute_test (ACE_ENV_SINGLE_ARG_DECL);
- // Don't run the suppliers, just test connect and disconnect calls.
+ /// Don't dump the EC_Driver results, they are meaningless.
void dump_results (void);
- // Don't dump the EC_Driver results, they are meaningless.
+ /// Separate the suppliers and consumers.
void execute_consumer_test (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS);
void execute_supplier_test (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS);
- // Separate the suppliers and consumers.
private:
+ /// What aspect of reconnection are we going to test?
int allow_consumer_reconnect_;
int allow_supplier_reconnect_;
- // What aspect of reconnection are we going to test?
+ /// The number of disconnections
int disconnections_;
- // The number of disconnections
ACE_Throughput_Stats consumer_reconnect_;
ACE_Throughput_Stats supplier_reconnect_;
diff --git a/TAO/orbsvcs/tests/Event/Basic/Schedule.h b/TAO/orbsvcs/tests/Event/Basic/Schedule.h
index 4cb08296b1f..c139b699227 100644
--- a/TAO/orbsvcs/tests/Event/Basic/Schedule.h
+++ b/TAO/orbsvcs/tests/Event/Basic/Schedule.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// Schedule
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Schedule.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_SCHEDULE_H
#define EC_SCHEDULE_H
@@ -25,51 +21,48 @@
#include "orbsvcs/RtecSchedulerS.h"
+/**
+ * @class EC_Schedule
+ *
+ * @brief Test the EC scheduling test
+ *
+ * The EC can be used in conjunction with the scheduling service
+ * to analyze the schedulabity of a system and compute priority
+ * assignments that guarantee the correct behavior of it.
+ * Most of the work is actually done by the scheduler (as it
+ * should be), the event channel simply plays two roles:
+ * 1) Feed the scheduler with the dependency information between
+ * consumers and suppliers based on their QoS requirements,
+ * subscriptions and publications.
+ * 2) At run-time use the scheduler information to dispatch the
+ * events at the right priority.
+ * The current version only verifies the first role.
+ */
class EC_Schedule : public EC_Driver
{
- //
- // = TITLE
- // Test the EC scheduling test
- //
- // = DESCRIPTION
- // The EC can be used in conjunction with the scheduling service
- // to analyze the schedulabity of a system and compute priority
- // assignments that guarantee the correct behavior of it.
- //
- // Most of the work is actually done by the scheduler (as it
- // should be), the event channel simply plays two roles:
- //
- // 1) Feed the scheduler with the dependency information between
- // consumers and suppliers based on their QoS requirements,
- // subscriptions and publications.
- //
- // 2) At run-time use the scheduler information to dispatch the
- // events at the right priority.
- //
- // The current version only verifies the first role.
- //
public:
+ /// Constructor
EC_Schedule (void);
- // Constructor
// = The EC_Driver methods
+ /// add some command line args to change the scheduling service to
+ /// use.
virtual int parse_args (int& argc, char* argv[]);
virtual void print_args (void) const;
virtual void print_usage (void);
- // add some command line args to change the scheduling service to
- // use.
+ /// Set the scheduling service attribute
void initialize_ec_impl (ACE_ENV_SINGLE_ARG_DECL);
void cleanup_ec (void);
virtual void modify_attributes (TAO_EC_Event_Channel_Attributes& attr);
- // Set the scheduling service attribute
+ /// Don't run the suppliers, just compute the schedule.
void execute_test (ACE_ENV_SINGLE_ARG_DECL);
- // Don't run the suppliers, just compute the schedule.
+ /// Don't dump the EC_Driver results, they are meaningless.
void dump_results (void);
- // Don't dump the EC_Driver results, they are meaningless.
+ /// This time really connect to the scheduler
virtual void build_consumer_qos (
int i,
RtecEventChannelAdmin::ConsumerQOS& qos,
@@ -80,14 +73,13 @@ public:
RtecEventChannelAdmin::SupplierQOS& qos,
int& shutdown_event_type
ACE_ENV_ARG_DECL_NOT_USED);
- // This time really connect to the scheduler
private:
+ /// The scheduler implementation
POA_RtecScheduler::Scheduler *scheduler_impl_;
- // The scheduler implementation
+ /// The scheduler object reference
RtecScheduler::Scheduler_var scheduler_;
- // The scheduler object reference
};
#endif /* EC_SCHEDULE_H */
diff --git a/TAO/orbsvcs/tests/Event/Basic/Shutdown.h b/TAO/orbsvcs/tests/Event/Basic/Shutdown.h
index f0d9af6c43f..81050629f9f 100644
--- a/TAO/orbsvcs/tests/Event/Basic/Shutdown.h
+++ b/TAO/orbsvcs/tests/Event/Basic/Shutdown.h
@@ -1,18 +1,14 @@
/* -*- C++ -*- */
-// $Id$
-//
-// ============================================================================
-//
-// = LIBRARY
-// ORBSVCS Real-time Event Channel testsuite
-//
-// = FILENAME
-// Shutdown
-//
-// = AUTHOR
-// Carlos O'Ryan (coryan@cs.wustl.edu)
-//
-// ============================================================================
+//=============================================================================
+/**
+ * @file Shutdown.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan (coryan@cs.wustl.edu)
+ */
+//=============================================================================
+
#ifndef EC_SHUTDOWN_H
#define EC_SHUTDOWN_H
@@ -23,41 +19,41 @@
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+/**
+ * @class EC_Shutdown
+ *
+ * @brief Test the EC shutdown features
+ *
+ * The EC must inform its suppliers and consumers on the event of
+ * its destruction.
+ * This test exercises that feature of the EC.
+ */
class EC_Shutdown : public EC_Driver
{
- //
- // = TITLE
- // Test the EC shutdown features
- //
- // = DESCRIPTION
- // The EC must inform its suppliers and consumers on the event of
- // its destruction.
- // This test exercises that feature of the EC.
- //
public:
+ /// Constructor
EC_Shutdown (void);
- // Constructor
// = The EC_Driver methods
+ /// Don't run the suppliers just create the EC and then destroy it.
void execute_test (ACE_ENV_SINGLE_ARG_DECL);
- // Don't run the suppliers just create the EC and then destroy it.
+ /// Don't dump the EC_Driver results, they are meaningless.
void dump_results (void);
- // Don't dump the EC_Driver results, they are meaningless.
+ /// One of the consumers in the test has been disconnected from the EC
virtual void consumer_disconnect (void* consumer_cookie
ACE_ENV_ARG_DECL);
- // One of the consumers in the test has been disconnected from the EC
+ /// One of the suppliers in the test has been disconnected from the EC
virtual void supplier_disconnect (void* supplier_cookie
ACE_ENV_ARG_DECL);
- // One of the suppliers in the test has been disconnected from the EC
private:
+ /// Number of consumer and supplier disconnect messages.
int consumer_disconnects_;
int supplier_disconnects_;
- // Number of consumer and supplier disconnect messages.
};
#endif /* EC_SHUTDOWN_H */