Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

RTPSenderControlMessage Class Reference

#include <RTPSenderControlMessage.h>

List of all members.

Detailed Description

A message of the type RTPSenderControlMessage is created by an application to control the behavior of an rtp sender module. With this class the application can send a command string to the sender module like "PLAY" or "STOP". A message can have up to two float parameters.

Following commands are evaluated in RTPPayloadSender (although correct behavior must be implemented in modules for certain payload types):


Public Member Functions

 RTPSenderControlMessage (const char *name=NULL)
 RTPSenderControlMessage (const RTPSenderControlMessage &message)
virtual ~RTPSenderControlMessage ()
RTPSenderControlMessage & operator= (const RTPSenderControlMessage &message)
virtual cObject * dup () const
virtual const char * className () const
virtual const char * command () const
virtual void setCommand (const char *command)
virtual void setCommand (const char *command, float commandParameter1)
virtual void setCommand (const char *command, float commandParameter1, float commandParameter2)
virtual float commandParameter1 ()
virtual float commandParameter2 ()

Private Attributes

const char * _command
float _commandParameter1
float _commandParameter2

Constructor & Destructor Documentation

RTPSenderControlMessage::RTPSenderControlMessage (  const char *  name = NULL  ) 
 

Default constructor. 

00023                                                                  {
00024     _command = "";
00025 };

RTPSenderControlMessage::RTPSenderControlMessage (  const RTPSenderControlMessage &  message  ) 
 

Copy constructor. 

00028                                                                                        {
00029     setName(message.name());
00030     operator=(message);
00031 };

RTPSenderControlMessage::~RTPSenderControlMessage (   )  [virtual]
 

Destructor. 

00034                                                   {
00035 };

Member Function Documentation

const char * RTPSenderControlMessage::className (   )  const [virtual]
 

Returns the class name "RTPSenderControlMessage". 

00050                                                      {
00051     return "RTPSenderControlMessage";
00052 };

const char * RTPSenderControlMessage::command (   )  const [virtual]
 

Returns the command string in this message. 

00055                                                    {
00056     return opp_strdup(_command);
00057 };

float RTPSenderControlMessage::commandParameter1 (   )  [virtual]
  

00081                                                  {
00082     return _commandParameter1;
00083 };

float RTPSenderControlMessage::commandParameter2 (   )  [virtual]
  

00086                                                  {
00087     return _commandParameter2;
00088 };

cObject * RTPSenderControlMessage::dup (   )  const [virtual]
 

Duplicates the object. 

00045                                             {
00046     return new RTPSenderControlMessage(*this);
00047 };

RTPSenderControlMessage & RTPSenderControlMessage::operator= (  const RTPSenderControlMessage &  message  ) 
 

Assignment operator. 

00038                                                                                                   {
00039     cMessage::operator=(message);
00040     _command = message.command();
00041     return *this;
00042 };

void RTPSenderControlMessage::setCommand (  const char *  command,
float  commandParameter1,
float  commandParameter2
)  [virtual]
  

00074                                                                                                               {
00075     _command = command;
00076     _commandParameter1 = commandParameter1;
00077     _commandParameter2 = commandParameter2;
00078 };

void RTPSenderControlMessage::setCommand (  const char *  command,
float  commandParameter1
)  [virtual]
  

00067                                                                                      {
00068     _command = command;
00069     _commandParameter1 = commandParameter1;
00070     _commandParameter2 = 0.0;
00071 };

void RTPSenderControlMessage::setCommand (  const char *  command  )  [virtual]
 

Set the command string this message transports to the sender module. 

00060                                                             {
00061     _command = command;
00062     _commandParameter1 = 0.0;
00063     _commandParameter2 = 0.0;
00064 };

Member Data Documentation

const char* RTPSenderControlMessage::_command [private]
 

The command string stored in the message.

float RTPSenderControlMessage::_commandParameter1 [private]
 

float RTPSenderControlMessage::_commandParameter2 [private]
 

The documentation for this class was generated from the following files:
Generated on Sat Apr 1 20:52:24 2006 for INET Framework for OMNeT++/OMNEST by  doxygen 1.4.1