diff options
Diffstat (limited to 'orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h')
-rw-r--r-- | orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h | 92 |
1 files changed, 47 insertions, 45 deletions
diff --git a/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h b/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h index 979a4f00fd1..9e439b9736d 100644 --- a/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h +++ b/orbsvcs/tests/AVStreams/Asynch_Three_Stage/sender.h @@ -1,46 +1,46 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage -// -// = FILENAME -// sender.h -// -// = DESCRIPTION -// This application reads data from a file and sends it to s -// receiver. -// -// = AUTHOR -// Yamuna Krishnamurthy <yamuna@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file sender.h + * + * $Id$ + * + * This application reads data from a file and sends it to s + * receiver. + * + * + * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu> + */ +//============================================================================= + #include "Connection_Manager.h" #include "orbsvcs/AV/AVStreams_i.h" #include "orbsvcs/AV/Endpoint_Strategy.h" #include "orbsvcs/AV/Protocol_Factory.h" +/** + * @class Sender_StreamEndPoint + * + * @brief Defines a sender stream endpoint. + */ class Sender_StreamEndPoint : public TAO_Client_StreamEndPoint { - // = TITLE - // Defines a sender stream endpoint. public: + /// Create the application callback and return its handle to + /// AVStreams for further application callbacks. int get_callback (const char *flowname, TAO_AV_Callback *&callback); - // Create the application callback and return its handle to - // AVStreams for further application callbacks. + /// Set protocol object corresponding to the transport protocol + /// chosen. int set_protocol_object (const char *flowname, TAO_AV_Protocol_Object *object); - // Set protocol object corresponding to the transport protocol - // chosen. protected: + /// Application callback. TAO_AV_Callback callback_; - // Application callback. }; typedef TAO_AV_Endpoint_Reactive_Strategy_A @@ -49,58 +49,60 @@ typedef TAO_AV_Endpoint_Reactive_Strategy_A AV_Null_MediaCtrl> SENDER_ENDPOINT_STRATEGY; +/** + * @class Sender + * + * @brief Sender Application. + * + * Class is responsible for streaming (and pacing) data to a + * receiver. + */ class Sender { - // = TITLE - // Sender Application. - // - // = DESCRIPTION - // Class is responsible for streaming (and pacing) data to a - // receiver. public: + /// Constructor Sender (void); - // Constructor + /// Method to initialize the various data components. int init (int argc, ACE_TCHAR **argv); - // Method to initialize the various data components. + /// Method to pace and send data from a file. int pace_data (void); - // Method to pace and send data from a file. + /// Accessor to the connection manager. Connection_Manager &connection_manager (void); - // Accessor to the connection manager. private: + /// Method to parse the command line arguments. int parse_args (int argc, ACE_TCHAR **argv); - // Method to parse the command line arguments. + /// The endpoint strategy used by the sender. SENDER_ENDPOINT_STRATEGY endpoint_strategy_; - // The endpoint strategy used by the sender. + /// The sender MMDevice. TAO_MMDevice *sender_mmdevice_; - // The sender MMDevice. + /// Number of frames sent. int frame_count_; - // Number of frames sent. + /// File from which data is read. ACE_TString filename_; - // File from which data is read. + /// File handle of the file read from. FILE *input_file_; - // File handle of the file read from. + /// File from which data is read. ACE_TString addr_file_; - // File from which data is read. + /// Rate at which the data will be sent. double frame_rate_; - // Rate at which the data will be sent. + /// Message block into which data is read from a file and then sent. ACE_Message_Block mb_; - // Message block into which data is read from a file and then sent. + /// Name of this sender. ACE_TString sender_name_; - // Name of this sender. // Connection manager. Connection_Manager connection_manager_; |