Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

appdataunit(3) [debian man page]

AppDataUnit(3)						     Library Functions Manual						    AppDataUnit(3)

NAME

       AppDataUnit -

       Interface (envelope) to data received over RTP packets.

SYNOPSIS

       #include <queuebase.h>

   Public Member Functions
       AppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src)
       ~AppDataUnit ()
       AppDataUnit (const AppDataUnit &src)
       AppDataUnit & operator= (const AppDataUnit &source)
	   Assignment operator.
       PayloadType getType () const
       const uint8 *const getData () const
	   Get data as it is received in RTP packets (i.e.
       size_t getSize () const
       const SyncSource & getSource () const
       bool isMarked () const
	   Is this data unit marked?.
       uint16 getSeqNum () const
	   Get data unit sequence number.
       uint8 getContributorsCount () const
	   Get the number of contributing sources in the CSRC list.
       const uint32 * getContributorsID () const
	   Get the array of 32-bit CSRC identifiers.

Detailed Description
       Interface (envelope) to data received over RTP packets.

       A class of objects representing data transmitted over RTP packets. Tipically, this object will apply to received data. Data blocks received
       via RTP connections as well as its related objects (source, etc), are accessed through the methods of this class.

       Author:
	   Federico Montesino Pouzols fedemp@altern.org

       Examples:
	   audiorx.cpp, ccrtptest.cpp, rtpduphello.cpp, rtphello.cpp, and rtplisten.cpp.

Constructor &; Destructor Documentation
   AppDataUnit::AppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src)
   AppDataUnit::~AppDataUnit () [inline]
   AppDataUnit::AppDataUnit (const AppDataUnit &src)
       Parameters:
	   src the AppDataUnit object being copied

Member Function Documentation
   uint8 AppDataUnit::getContributorsCount () const [inline]
       Get the number of contributing sources in the CSRC list.

   const uint32* AppDataUnit::getContributorsID () const [inline]
       Get the array of 32-bit CSRC identifiers. Returns:
	   NULL if (getContributorsCount() == 0)

   const uint8* const AppDataUnit::getData () const [inline]
       Get data as it is received in RTP packets (i.e. for multi-octet encodings, octets are in network order.

       Returns:
	   Raw pointer to data block.

       Examples:
	   audiorx.cpp, ccrtptest.cpp, rtpduphello.cpp, and rtphello.cpp.

   uint16 AppDataUnit::getSeqNum () const [inline]
       Get data unit sequence number.

   size_t AppDataUnit::getSize () const [inline]
       Returns:
	   length of data in octets

       Examples:
	   audiorx.cpp, and rtplisten.cpp.

   const SyncSource& AppDataUnit::getSource () const [inline]
       Returns:
	   Source that sent this data

       Examples:
	   rtplisten.cpp.

   PayloadType AppDataUnit::getType () const [inline]
       Returns:
	   type of this data

       Examples:
	   rtplisten.cpp.

   bool AppDataUnit::isMarked () const [inline]
       Is this data unit marked?. Returns:
	   true if marked.

   AppDataUnit& AppDataUnit::operator= (const AppDataUnit &source)
       Assignment operator. Parameters:
	   source the AppDataUnit object being assigned

       Returns:
	   the result of the assignment

Author
       Generated automatically by Doxygen for ccRTP from the source code.

ccRTP								  Sat Jun 23 2012						    AppDataUnit(3)

Check Out this Related Man Page

ost::CommandOptionParse(3)				     Library Functions Manual					ost::CommandOptionParse(3)

NAME

       ost::CommandOptionParse -

       This is the CommandOptionParse interface class.

SYNOPSIS

       #include <cmdoptns.h>

   Public Member Functions
       virtual ~CommandOptionParse ()=0
	   Virtual destructor needed so that the object may be correctly deleted.
       virtual bool argsHaveError ()=0
	   Get the value of the error flag set if the parser encountered errors.
       virtual const char * printErrors ()=0
	   Return a string of text describing the list of errors encountered.
       virtual const char * printUsage ()=0
	   Return a string that contains the usage description of this list of paramaters.
       virtual void registerError (const char *errMsg)=0
	   Register an error with this parser.
       virtual void performTask ()=0
	   The method should be invoked by the main code once it has determined that the application should be started.

Detailed Description
       This is the CommandOptionParse interface class.

       To implement this object you can call makeCommandOptionParse(); This will instantiate a dynamically allocated version of this class and
       parse the command line for the list of command options that are passed in.

       Author:
	   Gianni Mariani gianni@mariani.ws

       Examples:
	   cmdlineopt.cpp.

Constructor &; Destructor Documentation
   virtual ost::CommandOptionParse::~CommandOptionParse () [pure virtual]
       Virtual destructor needed so that the object may be correctly deleted.

Member Function Documentation
   virtual bool ost::CommandOptionParse::argsHaveError () [pure virtual]
       Get the value of the error flag set if the parser encountered errors.

       Examples:
	   cmdlineopt.cpp.

   virtual void ost::CommandOptionParse::performTask () [pure virtual]
       The method should be invoked by the main code once it has determined that the application should be started.

       Examples:
	   cmdlineopt.cpp.

   virtual const char* ost::CommandOptionParse::printErrors () [pure virtual]
       Return a string of text describing the list of errors encountered.

       Examples:
	   cmdlineopt.cpp.

   virtual const char* ost::CommandOptionParse::printUsage () [pure virtual]
       Return a string that contains the usage description of this list of paramaters.

       Examples:
	   cmdlineopt.cpp.

   virtual void ost::CommandOptionParse::registerError (const char *errMsg) [pure virtual]
       Register an error with this parser. This string will be appended to the errors already buffered in this object.

       Examples:
	   cmdlineopt.cpp.

Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012					ost::CommandOptionParse(3)
Man Page