/usr/include/sipxtapi/rtcp/ISetSrcDescription.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 | //
// 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 _ISetSrcDescription_h
#define _ISetSrcDescription_h
#include "rtcp/RtcpConfig.h"
// Includes
#include "IBaseClass.h"
/**
*
* Interface Name: ISetSrcDescription
*
* Inheritance: None
*
*
* Description: The ISetSrcDescription interface allows consumers to modify
* components of a source description including Name, Email,
* Phone, Location, Application Name, Notes, and Private fields.
*
* Notes:
*
*/
interface ISetSrcDescription : public IBaseClass
{
// Public Methods
public:
/**
*
* Method Name: SetSrcComponents()
*
*
* 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 set upon all the constituent elements composing
* a Source Description.
*
* Usage Notes: Performs default assignment of any arguments that may not be
* provided at assignment time. The least likely known are placed
* at the end of the assignment list.
*
* All elements passed must be NULL terminated.
*
*/
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);
/**
*
* Method Name: SetName
*
*
* Inputs: unsigned char *puchName - NAME Character String
* unsigned long ulLength -
* Optional Length of NAME argument passed
*
* Outputs: None
*
* Returns: bool bChanged -
* Flag identifying whether item has changed
*
* Description: Stores the Name field and length, either specified of derived,
* as attribute data within the object.
*
* Usage Notes: The NAME argument MUST be passed as a NULL terminated string or
* must contain a valid length argument. All text strings passed
* shall be truncated beyond the length of 255 characters.
*
*
*
*/
virtual bool SetName(unsigned char *puchCName, unsigned long ulLength) = 0;
/**
*
* Method Name: SetEmail
*
*
* Inputs: unsigned char *puchEmail - EMAIL character string
* unsigned long ulLength -
* Optional Length of Email argument passed
*
* Outputs: None
*
* Returns: bool bChanged - Flag identifying whether item has changed
*
* Description: Stores the Email field and length, either specified of derived,
* as attribute data within the object.
*
* Usage Notes: The EMAIL argument MUST be passed as a NULL terminated string
* or must contain a valid length argument. All text strings
* passed shall be truncated beyond the length of 255 characters.
*
*
*/
virtual bool SetEmail(unsigned char *puchEmail,
unsigned long ulLength=0) = 0;
/**
*
* Method Name: SetPhone
*
*
* Inputs: unsigned char *puchPhone - PHONE character string
* unsigned long ulLength -
* Optional Length of Phone argument passed
*
* Outputs: None
*
* Returns: bool bChanged - Flag identifying whether item has changed
*
* Description: Stores the Phone field and length, either specified of derived,
* as attribute data within the object.
*
* Usage Notes: The PHONE argument MUST be passed as a NULL terminated string
* or must contain a valid length argument. All text strings
* passed shall be truncated beyond the length of 255 characters.
*
*
*/
virtual bool SetPhone(unsigned char *puchPhone, unsigned long ulLength)=0;
/**
*
* Method Name: SetAppName
*
*
* Inputs: unsigned char *puchAppName - Application Name character string
* unsigned long ulLength -
* Optional Length of APP NAME argument passed
*
* Outputs: None
*
* Returns: bool bChanged - Flag identify whether item has changed
*
* Description: Stores the App Name field and length, either specified of
* derived, as attribute data within the object.
*
* Usage Notes: The APP NAME argument MUST be passed as a NULL terminated
* string or must contain a valid length argument. All text
* strings passed shall be truncated beyond the length of 255
* characters.
*
*
*/
virtual bool SetAppName(unsigned char *puchAppName,
unsigned long ulLength) = 0;
/**
*
* Method Name: SetLocation
*
*
* Inputs: unsigned char *puchLocation - Location character string
* unsigned long ulLength -
* Optional Length of Location argument passed
*
* Outputs: None
*
* Returns: bool bChanged - Flag identifying whether item has changed
*
* Description: Stores the Location field and length, either specified of
* derived, as attribute data within the object.
*
* Usage Notes: The LOCATION argument MUST be passed as a NULL terminated
* string or must contain a valid length argument. All text
* strings passed shall be truncated beyond the length of 255
* characters.
*
*
*/
virtual bool SetLocation(unsigned char *puchLocation,
unsigned long ulLength) = 0;
/**
*
* Method Name: SetNotes
*
*
* Inputs: unsigned char *puchNotes - Notes character string
* unsigned long ulLength -
* Optional Length of Notes argument passed
*
* Outputs: None
*
* Returns: bool bChanged - Flag identifying whether item has changed
*
* Description: Stores the Notes field and length, either specified of
* derived, as attribute data within the object.
*
* Usage Notes: The NOTES argument MUST be passed as a NULL terminated string
* or must contain a valid length argument. All text strings
* passed shall be truncated beyond the length of 255 characters.
*
*
*/
virtual bool SetNotes(unsigned char *puchNotes, unsigned long ulLength)=0;
/**
*
* Method Name: SetPrivate
*
*
* Inputs: unsigned char *puchNotes - Private character string
* unsigned long ulLength -
* Optional Length of Private argument passed
*
* Outputs: None
*
* Returns: bool bChanged - Flag identifying whether item has changed
*
* Description: Stores the Private field and length, either specified of
* derived, as attribute data within the object.
*
* Usage Notes: The PRIVATE argument MUST be passed as a NULL terminated string
* or must contain a valid length argument. All text strings
* passed shall be truncated beyond the length of 255 characters.
*
*
*/
virtual bool SetPrivate(unsigned char *puchPrivate,
unsigned long ulLength) = 0;
};
#endif
|