/usr/include/sipxtapi/rtcp/IGetSrcDescription.h is in libsipxtapi-dev 3.3.0~test17-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | //
// 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 Name: IGetSrcDescription
*
* Inheritance: None
*
*
* Description: The IGetSrcDescription interface allows consumers to retrieve
* components of a source description including Name, Email,
* Phone, Location, Application Name, Notes, and Private fields.
*
* Notes:
*
*/
interface IGetSrcDescription : public IBaseClass
{
// Public Methods
public:
/**
*
* Method Name: GetChanges
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: unsigned long
* The aggregate changes that have occurred in the report since the last period
*
* Description: Retrieves the aggregate changes that have occurred in the
* report since the last period
*
* Usage Notes: Mask is an OR'ing of all changes for a period.
*/
virtual unsigned long GetChanges(void)=0;
/**
*
* Method Name: GetFieldChange
*
*
* Input: unsigned long ulChangeMask
* A mask identifying the changed field in an SDES Report
*
* Outputs: unsigned long *pulFieldType
* The Field Identifier present in change mask
* unsigned char *puchReportBuffer
* Character Buffer to store contents of field
*
* Returns: unsigned long - The modified change mask
*
* Description: Gets a field from an SDES Report based upon the change mask
* passed. A field present within the change mask shall have
* its ID and field contents loaded as output arguments to this
* call. The change mask shall be modified to reflect the
* removal of the field change that is being returned.
*
* Usage Notes: This may be called multiple times to extract all the changes
* from an SDES report. No more changes are available once the
* mask has a value of 0.
*/
virtual unsigned long GetFieldChange(unsigned long ulChangeMask,
unsigned long *pulFieldType,
unsigned char *puchFieldBuffer) = 0;
/**
*
* Method Name: GetAllComponents()
*
*
* Inputs: unsigned char *puchName - NAME field
* unsigned char *puchEmail - EMAIL field
* unsigned char *puchPhone - PHONE field
* unsigned char *puchAppName - APPLICATION NAME
* unsigned char *puchLocation - LOCATION field
* unsigned char *puchNotes - NOTES field
* unsigned char *puchPrivate - PRIVATE field
*
* Outputs: None
*
* Returns: None
*
* Description: Performs a bulk get upon all the constituent elements
* composing a Source Description.
*
* Usage Notes: The elements retrieved are NULL terminated.
*
*/
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;
/**
*
* Method Name: GetSSRC
*
*
* Inputs: None
*
*
* Outputs: None
*
* Returns: ssrc_t - The SSRC of the Bye Report
*
* Description: Returns the SSRC Associated with the Bye Report.
*
* Usage Notes:
*/
virtual ssrc_t GetSSRC(void)=0;
/**
*
* Method Name: GetName
*
*
* Inputs: None
*
* Outputs: unsigned char *puchName
* Character buffer in which the NAME attribute shall be returned
*
* Returns: unsigned long
* Length of the item being returned in the buffer
*
* Description: Retrieves the Name attribute stored within the object and
* returns its associated length.
*
* Usage Notes: All unsigned character strings returned are limited to 255
* bytes in length. Any wide unsigned character support for
* internationalized display is a responsibility assumed by
* the caller.
*/
virtual unsigned long GetName(unsigned char *puchName) = 0;
/**
*
* Method Name: GetEmail
*
*
* Inputs: None
*
* Outputs: unsigned char *puchEmail
* Character buffer in which the EMAIL attribute shall be returned
*
* Returns: unsigned long
* Length of the item being returned in the buffer
*
* Description: Retrieves the Email attribute stored within the object and
* returns its associated length.
*
* Usage Notes: All unsigned character strings returned are limited to 255
* bytes in length. Any wide unsigned character support for
* internationalized display is a responsibility assumed by
* the caller.
*/
virtual unsigned long GetEmail(unsigned char *puchEmail) = 0;
/**
*
* Method Name: GetPhone
*
*
* Inputs: None
*
* Outputs: unsigned char *puchPhone
* Character buffer in which the PHONE attribute shall be returned
*
* Returns: unsigned long
* Length of the item being returned in the buffer
*
* Description: Retrieves the Phone attribute stored within the object and
* returns its associated length.
*
* Usage Notes: All unsigned character strings returned are limited to 255
* bytes in length. Any wide unsigned character support for
* internationalized display is a responsibility assumed by
* the caller.
*/
virtual unsigned long GetPhone(unsigned char *puchPhone) = 0;
/**
*
* Method Name: GetAppName
*
*
* Inputs: None
*
* Outputs: unsigned char *puchAppName
* Character buffer in which the APPLICATION NAME attribute shall
* be returned
*
* Returns: unsigned long
* Length of the item being returned in the buffer
*
* Description: Retrieves the Application Name attribute stored within the
* object and returns its associated length.
*
* Usage Notes: All unsigned character strings returned are limited to 255
* bytes in length. Any wide unsigned character support for
* internationalized display is a responsibility assumed by
* the caller.
*/
virtual unsigned long GetAppName(unsigned char *puchAppName) = 0;
/**
*
* Method Name: GetLocation
*
*
* Inputs: None
*
* Outputs: unsigned char *puchLocation
* Character buffer in which the LOCATION attribute shall be
* returned
*
* Returns: unsigned long
* Length of the item being returned in the buffer
*
* Description: Retrieves the Location attribute stored within the object
* and returns its associated length.
*
* Usage Notes: All unsigned character strings returned are limited to 255
* bytes in length. Any wide unsigned character support for
* internationalized display is a responsibility assumed by
* the caller.
*/
virtual unsigned long GetLocation(unsigned char *puchLocation) = 0;
/**
*
* Method Name: GetNotes
*
*
* Inputs: None
*
* Outputs: unsigned char *puchNotes
* Character buffer in which the Notes attribute shall be returned
*
* Returns: unsigned long
* Length of the item being returned in the buffer
*
* Description: Retrieves the Notes attribute stored within the object and
* returns its associated length.
*
* Usage Notes: All unsigned character strings returned are limited to 255
* bytes in length. Any wide unsigned character support for
* internationalized display is a responsibility assumed by
* the caller.
*/
virtual unsigned long GetNotes(unsigned char *puchNotes) = 0;
/**
*
* Method Name: GetPrivate
*
*
* Inputs: None
*
* Outputs: unsigned char *puchPrivate
* Character buffer in which the Private attribute shall be returned
*
* Returns: unsigned long
* Length of the item being returned in the buffer
*
* Description: Retrieves the Private attribute stored within the object and
* returns its associated length.
*
* Usage Notes: All unsigned character strings returned are limited to 255
* bytes in length. Any wide unsigned character support for
* internationalized display is a responsibility assumed by
* the caller.
*/
virtual unsigned long GetPrivate(unsigned char *puchNotes) = 0;
/**
*
* Method Name: GetSDESInterface()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: ISDESReport * - Pointer to the SDES Report Interface
*
* Description: Returns the SDES Report interface.
*
* Usage Notes:
*
*/
virtual ISDESReport * GetSDESInterface(void) = 0;
};
#endif
|