IGetSrcDescription.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 _IGetSrcDescription_h
#define _IGetSrcDescription_h

#include "rtcp/RtcpConfig.h"

// Include
#include "IBaseClass.h"

// Defines
#define CNAME_FIELD        0x1
#define NAME_FIELD         0x2
#define EMAIL_FIELD        0x4
#define PHONE_FIELD        0x8
#define LOCATION_FIELD     0x10
#define APPNAME_FIELD      0x20
#define NOTE_FIELD         0x40
#define PRIVATE_FIELD      0x80

#define CNAME_ID            1
#define NAME_ID             2
#define EMAIL_ID            3
#define PHONE_ID            4
#define LOCATION_ID         5
#define APPNAME_ID          6
#define NOTE_ID             7
#define PRIVATE_ID          8

#define MAX_ENTRYSIZE      255

//  Forward Declarations
interface ISDESReport;

interface IGetSrcDescription : public IBaseClass
 {

//  Public Methods

public:

    virtual unsigned long GetChanges(void)=0;

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


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

    virtual ssrc_t GetSSRC(void)=0;

    virtual unsigned long GetName(unsigned char *puchName) = 0;



    virtual unsigned long GetEmail(unsigned char *puchEmail) = 0;



    virtual unsigned long GetPhone(unsigned char *puchPhone) = 0;


    virtual unsigned long GetAppName(unsigned char *puchAppName) = 0;



    virtual unsigned long GetLocation(unsigned char *puchLocation) = 0;



    virtual unsigned long GetNotes(unsigned char *puchNotes) = 0;

    virtual unsigned long GetPrivate(unsigned char *puchNotes) = 0;

    virtual ISDESReport * GetSDESInterface(void) = 0;
};

#endif