/usr/include/sipxtapi/rtcp/IRTCPNotify.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 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 | //
// 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 _IRTCPNotify_h
#define _IRTCPNotify_h
#include "rtcp/RtcpConfig.h"
// Include
#include "IBaseClass.h"
#include "IRTCPSession.h"
// Defines
#define NO_EVENTS 0x0
#define RTCP_NEW_SDES 0x1
#define RTCP_SDES_UPDATE 0x2
#define RTCP_RR_RCVD 0x4
#define RTCP_SR_RCVD 0x8
#define RTCP_BYE_RCVD 0x10
#define RTCP_RR_SENT 0x20
#define RTCP_SR_SENT 0x40
#define RTCP_SDES_SENT 0x80
#define RTCP_BYE_SENT 0x100
#define LOCAL_SSRC_COLLISION 0x200
#define REMOTE_SSRC_COLLISION 0x400
#define REPORTING_ALARM 0x800
#define ALL_EVENTS 0xffff
/**
*
* Interface Name: IRTCPNotify
*
* Inheritance: None
*
*
* Description: The IRTCPNotify interface allows subscribing clients to
* receive event notifications corresponding to a previously
* registered interest. The notification will identify the
* type of event and will provide information or resources
* for handling the event.
*
* Notes: It is necessary that the subscribing client implement the
* methods of this notification interface so that the events
* can be processed when received.
*
*/
interface IRTCPNotify : public IBaseClass
{
// Public Methods
public:
/**
*
* Method Name: GetEventInterest()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: unsigned long - Mask of Event Interests
*
* Description: The GetEventInterest() event method shall allow the dispatcher
* of notifications to access the event interests of a subscriber
* and use these wishes to dispatch RTCP event notifications
*
* Usage Notes:
*
*/
virtual unsigned long GetEventInterest(void) { return(NO_EVENTS); };
/**
*
* Method Name: NewSDES()
*
*
* Inputs: IGetSrcDescription *piGetSrcDescription
* Interface to the new Source Description info
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The NewSDES() event method shall inform the recipient of a new
* Source Description and shall include the IGetSrcDescription
* interface for accessing the contents of this new Source
* Description.
*
* Usage Notes:
*
*/
virtual void NewSDES(IGetSrcDescription *piGetSrcDescription,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL) { return; };
/**
*
* Method Name: UpdatedSDES()
*
*
* Inputs: IGetSrcDescription *piGetSrcDescription
* Interface to the new Source Description info
* unsigned long ulChangeMask
* Changes that occurred in the SDEs Report
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The UpdatedSDES() event method shall inform the recipient of
* a change in Source Description and shall include the
* IGetSrcDescription interface for accessing the contents of
* this updated Source Description.
*
* Usage Notes:
*
*/
virtual void UpdatedSDES(IGetSrcDescription *piGetSrcDescription,
unsigned long ulChangeMask,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: SenderReportReceived()
*
*
* Inputs: IGetSenderStatistics *piGetSenderStatistics
* Interface to the Sender Statistics
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The SenderReportReceived() event method shall inform the
* recipient of a change in Sender Statistics and shall include
* the IGetSenderStatistics interface for accessing the contents
* of this updated Sender Report.
*
* Usage Notes:
*
*/
virtual void
SenderReportReceived(IGetSenderStatistics *piGetSenderStatistics,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: ReceiverReportReceived()
*
*
* Inputs: IGetReceiverStatistics *piGetReceiverStatistics
* Interface to the Receiver Statistics
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The ReceiverReportReceived() event method shall inform the
* recipient of a change in Receiver Statistics and shall include
* the IGetReceiverStatistics interface for accessing the
* contents of this updated Receiver Report.
*
* Usage Notes:
*
*/
virtual void
ReceiverReportReceived(IGetReceiverStatistics *piGetReceiverStatistics,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: ByeReportReceived()
*
*
* Inputs: IGetByeInfo *piGetByeInfo
* Interface used to retrieve Bye Report information
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The ByeReportReceived() event method shall inform the recipient
* of the discontinuation of an SSRC. This may result from an
* SSRC collision or the termination of an associated RTP
* connection.
*
* Usage Notes:
*
*/
virtual void ByeReportReceived(IGetByeInfo *piGetByeInfo,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: SenderReportSent()
*
*
* Inputs: IGetSenderStatistics *piGetSenderStatistics
* Interface to the Sender Statistics
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The SenderReportSent() event method shall inform the recipient
* of a newly transmitted Sender Report and shall include the
* IGetSenderStatistics interface for accessing the contents of
* this transmitted Sender Report.
*
* Usage Notes:
*
*/
virtual void SenderReportSent(IGetSenderStatistics *piGetSenderStatistics,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: ReceiverReportSent()
*
*
* Inputs: IGetReceiverStatistics *piGetReceiverStatistics
* Interface to the Receiver Statistics
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The ReceiverReportSent() event method shall inform the
* recipient of a newly transmitted Receiver Report and shall
* include the IGetReceiverStatistics interface for accessing
* the contents of this transmitted Receiver Report.
*
* Usage Notes:
*
*/
virtual void
ReceiverReportSent(IGetReceiverStatistics *piGetReceiverStatistics,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: SDESReportSent()
*
*
* Inputs: IGetSrcDescription *piGetSrcDescription
* Interface to the local Source Description
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The SDESReportSent() event method shall inform the recipient of
* a newly transmitted SDES Report and shall include the
* IGetSrcDescription interface for accessing the contents of
* this transmitted SDES Report.
*
* Usage Notes:
*
*/
virtual void SDESReportSent(IGetSrcDescription *piGetSrcDescription,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: ByeReportSent()
*
*
* Inputs: IGetByeInfo *piGetByeInfo
* Interface used to retrieve Bye Report information
* IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The ByeReportSent() event method shall inform the recipient of
* a newly transmitted BYE Report and shall include the SSRC ID
* and reason to identify the connection and the cause of
* termination.
*
* Usage Notes:
*
*/
virtual void ByeReportSent(IGetByeInfo *piGetByeInfo,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: LocalSSRCCollision()
*
*
* Inputs: IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The LocalSSRCCollision() event method shall inform the
* recipient of a collision between the local SSRC and one used
* by one of the remote participants.
*
* Usage Notes:
*
*/
virtual void LocalSSRCCollision(IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: RemoteSSRCCollision()
*
*
* Inputs: IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The RemoteSSRCCollision() event method shall inform the
* recipient of a collision between two remote participants.
*
* Usage Notes:
*
*/
virtual void RemoteSSRCCollision(IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: RTCPReportingAlarm()
*
*
* Inputs: IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The ReportAlarm() event method shall inform the recipient of
* the expiration of reporting period. This event usually causes
* RTCP Reports to be sent out on the associated session.
*
* Usage Notes:
*
*/
virtual void RTCPReportingAlarm(IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: RTCPConnectionStopped()
*
*
* Inputs: IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The RTCPConnectionStopped() event method shall inform the
* recipient of the imminent suspension of an RTCP outbound
* connection. This will allow whatever connection related
* operations to be suspended until it again resumes.
*
* Usage Notes:
*
*/
virtual void RTCPConnectionStopped(IRTCPConnection *piRTCPConnection,
IRTCPSession *piRTCPSession=NULL)
{ return; };
/**
*
* Method Name: RTCPConnectionStarted()
*
*
* Inputs: IRTCPConnection *piRTCPConnection
* Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The RTCPConnectionStarted() event method shall inform the
* recipient of the resumption of an RTCP outbound connection.
* This will allow whatever connection related operations to be
* resumed.
*
* Usage Notes:
*
*/
virtual void RTCPConnectionStarted(IRTCPConnection *piRTCPConnection,
IRTCPSession *piRTCPSession=NULL)
{ return; };
};
#endif
|