SourceDescription.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2013 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


//  Border Guard
#ifndef _SourceDescription_h
#define _SourceDescription_h

#include "rtcp/RtcpConfig.h"

//  Includes
#include "BaseClass.h"
#include "RTCPHeader.h"
#include "ISDESReport.h"
#include "ISetSrcDescription.h"
#include "IGetSrcDescription.h"


class CSourceDescription:
          public CBaseClass,        // Inherits the CBaseClass implementation
          public CRTCPHeader,       // Inherits the CRTCPHeader implementation
          public ISDESReport,       // Interface exposed for SDES Reporting
          public ISetSrcDescription,
                        // Interface exposed for modifying Source Description
          public IGetSrcDescription 
                        // Interface exposed for retrieving Source Description
 {

//  Public Methods
public:

    CSourceDescription(ssrc_t ulSSRC=0,
                       unsigned char *puchName=NULL,
                       unsigned char *puchEmail=NULL,
                       unsigned char *puchPhone=NULL,
                       unsigned char *puchLocation=NULL,
                       unsigned char *puchAppName=NULL,
                       unsigned char *puchNotes=NULL,
                       unsigned char *puchPrivate=NULL);

    CSourceDescription(bool bHeader, unsigned char *puchSDESReport=NULL);


    ~CSourceDescription(void);


    static CSourceDescription *GetLocalSDES(void);
    void SetAllComponents(unsigned char *puchName=NULL,
                          unsigned char *puchEmail=NULL,
                          unsigned char *puchPhone=NULL,
                          unsigned char *puchLocation=NULL,
                          unsigned char *puchAppName=NULL,
                          unsigned char *puchNotes=NULL,
                          unsigned char *puchPrivate=NULL);

    void GetAllComponents(unsigned char *puchName,
                          unsigned char *puchEmail,
                          unsigned char *puchPhone,
                          unsigned char *puchLocation,
                          unsigned char *puchAppName,
                          unsigned char *puchNotes,
                          unsigned char *puchPrivate);

    unsigned long GetFieldChange(unsigned long ulChangeMask,
                                 unsigned long *pulFieldType,
                                 unsigned char *puchFieldBuffer);


    virtual ssrc_t GetSSRC(void);

    virtual void SetSSRC(ssrc_t ulSSRC);


    bool SetName(unsigned char *puchCName, unsigned long ulLength=0);


    unsigned long GetName(unsigned char *puchName);


    bool SetEmail(unsigned char *puchEmail, unsigned long ulLength=0);


    unsigned long GetEmail(unsigned char *puchEmail);


    bool SetPhone(unsigned char *puchPhone, unsigned long ulLength=0);


    unsigned long GetPhone(unsigned char *puchPhone);


    bool SetAppName(unsigned char *puchAppName, unsigned long ulLength=0);


    unsigned long GetAppName(unsigned char *puchAppName);



    bool SetLocation(unsigned char *puchLocation, unsigned long ulLength=0);


    unsigned long GetLocation(unsigned char *puchLocation);


    bool SetNotes(unsigned char *puchNotes, unsigned long ulLength=0);


    unsigned long GetNotes(unsigned char *puchNotes);

    bool SetPrivate(unsigned char *puchPrivate, unsigned long ulLength=0);


    unsigned long GetPrivate(unsigned char *puchNotes);

    ISDESReport * GetSDESInterface(void);

    IGetSrcDescription *GetAccessInterface(void);

    unsigned long GetChanges(void);


unsigned long FormatSDESReport(bool bHeader,
                               long lContentMask,
                               unsigned char *puchReportBuffer,
                               unsigned long ulBufferSize);


    unsigned long ParseSDESReport(bool bHeader,
                                  unsigned char *puchReportBuffer);



   private:     // Private Methods

    bool FormulateCName(void);


    bool SetCName(unsigned char *puchCName, unsigned long ulLength=0);


    unsigned long GetCName(unsigned char *puchCName);

    unsigned long ExtractFieldInfo(unsigned char *puchReportBuffer);


    unsigned long ExtractPadding(unsigned char *puchReportBuffer);

    unsigned long LoadFieldInfo(unsigned char *puchReportBuffer,
                                long lContentMask);

    unsigned long LoadFieldChanges(unsigned char *puchReportBuffer);


    unsigned long TerminateNPad(unsigned char *puchReportBuffer,
                                bool *pbPadded);

DECLARE_IBASE_M


private:        // Private Data Members

      static CSourceDescription *m_spoLocalSDES;

      bool          m_bCNameSet;

      unsigned long m_ulContentMask;


      unsigned long m_ulChangeMask;

      unsigned long m_ulCNameLength;


      unsigned char m_uchCName[MAX_SOURCE_LENGTH];

      unsigned long m_ulNameLength;

      unsigned char m_uchName[MAX_SOURCE_LENGTH];


      unsigned long  m_ulEmailLength;

      unsigned char m_uchEmail[MAX_SOURCE_LENGTH];


      unsigned long  m_ulPhoneLength;

      unsigned char m_uchPhone[MAX_SOURCE_LENGTH];

      unsigned long  m_ulAppNameLength;

      unsigned char m_uchAppName[MAX_SOURCE_LENGTH];

      unsigned long  m_ulLocationLength;

      unsigned char m_uchLocation[MAX_SOURCE_LENGTH];

      unsigned long  m_ulNotesLength;

      unsigned char m_uchNotes[MAX_SOURCE_LENGTH];

      unsigned long  m_ulPrivateLength;

      unsigned char m_uchPrivate[MAX_SOURCE_LENGTH];

};

inline unsigned long CSourceDescription::GetChanges(void)
{

    return(m_ulChangeMask);

}

inline ISDESReport * CSourceDescription::GetSDESInterface(void)
{
    ((ISDESReport *)this)->AddRef(ADD_RELEASE_CALL_ARGS(__LINE__));
    return((ISDESReport *)this);

}

inline IGetSrcDescription *CSourceDescription::GetAccessInterface(void)
{

    ((IGetSrcDescription *)this)->AddRef(ADD_RELEASE_CALL_ARGS(__LINE__));
    return((IGetSrcDescription *)this);

}


inline ssrc_t CSourceDescription::GetSSRC(void)
{

    return(CRTCPHeader::GetSSRC());

}

#endif