inet::rtp::SDESItem Class Reference

The class SDESItem is used for storing a source description item (type of description, description string) for an RTP end system. More...

#include <sdes.h>

Inheritance diagram for inet::rtp::SDESItem:

Public Types
enum	SDES_ITEM_TYPE {   SDES_UNDEF = 0, SDES_CNAME = 1, SDES_NAME = 2, SDES_EMAIL = 3,   SDES_PHONE = 4, SDES_LOC = 5, SDES_TOOL = 6, SDES_NOTE = 7,   SDES_PRIV = 8 }
	This enumeration holds the types of source description items as defined in the RFC. More...

Public Member Functions
	SDESItem ()
	Default constructor. More...
	SDESItem (SDES_ITEM_TYPE type, const char *content)
	Constructor which sets the entry. More...
	SDESItem (const SDESItem &sdesItem)
	Copy constructor. More...
virtual	~SDESItem ()
	Destructor. More...
SDESItem &	operator= (const SDESItem &sdesItem)
	Assignment operator. More...
virtual SDESItem *	dup () const override
	Duplicates theis SDESItem by calling the copy constructor. More...
virtual std::string	info () const override
	Writes a short info about this SDESItem into the given string. More...
virtual void	dump (std::ostream &os) const
	Writes an info about this SDESItem into the give output stream. More...
virtual SDES_ITEM_TYPE	getType () const
	Returns the type of this sdes item. More...
virtual const char *	getContent () const
	Returns the stored sdes string. More...
virtual int	getLength () const
	This method returns the size of this SDESItem in bytes as it would be in the real world. More...

Protected Attributes
SDES_ITEM_TYPE	_type
	The type of this SDESItem. More...
int	_length
	The length of this SDESItem. More...
std::string	_content
	The sdes string. More...

Private Member Functions
void	copy (const SDESItem &other)
void	clean ()

Detailed Description

The class SDESItem is used for storing a source description item (type of description, description string) for an RTP end system.

Member Enumeration Documentation

enum inet::rtp::SDESItem::SDES_ITEM_TYPE

This enumeration holds the types of source description items as defined in the RFC.

In this implementation only SDES_UNDEF and SDES_CNAME are usable.

Enumerator
SDES_UNDEF
SDES_CNAME
SDES_NAME
SDES_EMAIL
SDES_PHONE
SDES_LOC
SDES_TOOL
SDES_NOTE
SDES_PRIV

                        {
        SDES_UNDEF = 0,
        SDES_CNAME = 1,
        SDES_NAME = 2,
        SDES_EMAIL = 3,
        SDES_PHONE = 4,
        SDES_LOC = 5,
        SDES_TOOL = 6,
        SDES_NOTE = 7,
        SDES_PRIV = 8
    };

Constructor & Destructor Documentation

inet::rtp::SDESItem::SDESItem

(

)

Default constructor.

Referenced by dup().

                   : cObject()
{
    _type = SDES_UNDEF;
    _length = 2;
    _content = "";
}

inet::rtp::SDESItem::SDESItem	(	SDES_ITEM_TYPE	type,
		const char *	content
	)

Constructor which sets the entry.

                                                           : cObject()
{
    if (nullptr == content)
        throw cRuntimeError("The content parameter must be a valid pointer.");
    _type = type;
    _content = content;
    // an sdes item requires one byte for the type field,
    // one byte for the length field and bytes for
    // the content string
    _length = 2 + _content.length();
}

inet::rtp::SDESItem::SDESItem

(

const SDESItem &

sdesItem

)

Copy constructor.

                                           : cObject(sdesItem)
{
    copy(sdesItem);
}

inet::rtp::SDESItem::~SDESItem ( )

virtual

Destructor.

{
    clean();
}

Member Function Documentation

void inet::rtp::SDESItem::clean ( )

inlineprivate

Referenced by operator=(), and ~SDESItem().

{}    //FIXME The `_content' sometimes allocated, sometimes not allocated pointer.

void inet::rtp::SDESItem::copy ( const SDESItem &  other )

private

Referenced by operator=(), and SDESItem().

{
    _type = sdesItem._type;
    _length = sdesItem._length;
    _content = sdesItem._content;
}

void inet::rtp::SDESItem::dump ( std::ostream &  os ) const

virtual

Writes an info about this SDESItem into the give output stream.

{
    os << "SDESItem:" << endl;
    os << "  type = " << _type << endl;
    os << "  content = " << _content << endl;
}

SDESItem * inet::rtp::SDESItem::dup ( ) const

overridevirtual

Duplicates theis SDESItem by calling the copy constructor.

{
    return new SDESItem(*this);
}

const char * inet::rtp::SDESItem::getContent ( ) const

virtual

Returns the stored sdes string.

{
    return _content.c_str();
}

int inet::rtp::SDESItem::getLength ( ) const

virtual

This method returns the size of this SDESItem in bytes as it would be in the real world.

Referenced by inet::rtp::SDESChunk::addSDESItem().

{
    // bytes needed for this sdes item are
    // one byte for type, one for length
    // and the string
    return _length + 2;
}

SDESItem::SDES_ITEM_TYPE inet::rtp::SDESItem::getType ( ) const

virtual

Returns the type of this sdes item.

Referenced by inet::rtp::SDESChunk::addSDESItem().

{
    return _type;
}

std::string inet::rtp::SDESItem::info ( ) const

overridevirtual

Writes a short info about this SDESItem into the given string.

{
    std::stringstream out;
    out << "SDESItem=" << _content;
    return out.str();
}

SDESItem & inet::rtp::SDESItem::operator=

(

const SDESItem &

sdesItem

)

Assignment operator.

{
    if (this == &sdesItem)
        return *this;
    clean();
    cObject::operator=(sdesItem);
    copy(sdesItem);
    return *this;
}

Member Data Documentation

std::string inet::rtp::SDESItem::_content

protected

The sdes string.

Referenced by copy(), dump(), getContent(), info(), and SDESItem().

int inet::rtp::SDESItem::_length

protected

The length of this SDESItem.

Referenced by copy(), getLength(), and SDESItem().

SDES_ITEM_TYPE inet::rtp::SDESItem::_type

protected

The type of this SDESItem.

Referenced by copy(), dump(), getType(), and SDESItem().

---

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

• sdes.h
• sdes.cc