/usr/include/sipxtapi/rtcp/RTCPConnection.h is in libsipxtapi-dev 3.3.0~test17-2.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 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 | //
// 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 _RTCPConnection_h
#define _RTCPConnection_h
#include "rtcp/RtcpConfig.h"
// Includes
#include "NetworkChannel.h"
#include "RTCPSource.h"
#include "RTCPRender.h"
#include "RTCPTimer.h"
#include "IRTCPSession.h"
/**
*
* Class Name: CRTCPConnection
*
* Inheritance: CBaseClass - Base Class Implementation
*
*
* Interfaces: IRTCPConnection - RTCP Session Control Interface
*
* Description: The CRTCPConnection Class shall manage the instantiation of
* RTCP objects used to report and track the identity and
* performance RTP connections. At RTP connection creation time,
* the RTCPConnection will instantiate a CRTCPRender and
* CRTCPSource object and make the appropriate association
* between objects to:
* ==> Allow the RTPRender object to dispatch RTP Headers, as
* received, to the RTCPRender
* ==> Allow the RTCPSource object to receive RTCP Reports
* from the Network Source object through the INetDispatch
* interface
* ==> Allow the RTCPRender object to send RTCP Reports
* through the INetSend interface exposed by an associated
* Network Render object.
* ==> Allow the SenderReport object associated with the
* RTCPSource object to update Sender Report statistics
* within ReceiverReport object associated with the
* RTCPSource object.
*
* In addition to RTCP setup, the RTCPConnection shall coordinate
* the generation of periodic RTCP Sender, Receiver, and SDES
* Reports as well as the aperiodic generation of RTCP BYE
* Reports. The CRTCPConnection shall provide the the thread of
* execution for these activities and will use the resources of
* the various CRTCPRender objects to actually carry out report
* generation and transmission. Additionally, the CRTCPConnection
* object shall be responsible for managing registered interests
* in RTCP events both in and outside of a call in addition to be
* an intermediate dispatcher of these events.
*
*
* Notes: CRTCPConnection is derived from CBaseClass which provides
* basic Initialization and reference counting support.
*
*/
class CRTCPConnection : public CBaseClass,
// Inherits CBaseClass implementation
public CRTCPTimer,
// Inherit CTimer Class implementation
public IRTCPConnection,
// Interface exposed for RTCP Connection Control
public IRTCPNotify
// Interface exposed for RTCP Notifications
{
// Public Methods
public:
/**
*
* Method Name: CRTCPConnection() - Constructor
*
*
* Inputs: unsigned long ulSSRC - SSRC ID
* IRTCPNotify *piRTCPNotify - RTCP Event Notification Interface
* ISDESReport *piSDESReport - Local Source Description Interface
*
*
* Outputs: None
*
* Returns: None
*
* Description: Allocates the RTCP Source and Render components of an RTCP
* Connection.
*
* Usage Notes: Allocation is not normally performed at construction time but
* a flag shall be set that will be used during the
* initialization phase to determine whether all went well. This
* is being done so construction arguments do not have to be
* stored as attributes of the RTCP Session object.
*
*/
CRTCPConnection(unsigned long ulSSRC, IRTCPNotify *piRTCPNotify,
ISDESReport *piSDESReport);
/**
*
* Method Name: ~CRTCPConnection() - Destructor
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: None
*
* Description: Shall deallocated and/or release all resources which was
* acquired over the course of runtime. In particular, the
* following shall occur:
* ==> Shall release the reference to the RTCP Render object
* ==> Shall release the reference to the RTCP Source object
* ==> Shall release the reference to the RTCP Timer object
*
* Usage Notes:
*
*
*/
~CRTCPConnection(void);
/**
*
* Method Name: Initialize
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: bool
*
* Description: Performs runtime initialization that may be failure prone and
* therefore inappropriate for execution within a constructor.
* This includes the verification of construction time
* initialization as well as the instantiation of the RTCP Timer
* object.
*
* Usage Notes: This is an overload of the CBaseClass Initialize() method.
*
*/
bool Initialize(void);
/**
*
* Method Name: GetDispatchInterfaces()
*
*
* Inputs: None
*
* Outputs: INetDispatch **ppiNetDispatch
* - Interface used to route Network packets
* to the RTCP Source object
* IRTPDispatch **ppRTPDispatch
* - Interface used to route RTP Header packets to
* the RTPRender object's instance of an RTCP
* Receiver Report
* ISetSenderStatistics **piSenderStats
8 - Statistical Dispatch Interface
*
* Returns: void
*
* Description: This method allow a consumer to obtain the dispatch
* interfaces that are crucial to routing inbound RTCP and
* RTP network packets.
*
*
* Usage Notes:
*
*/
void GetDispatchInterfaces(INetDispatch **ppiNetDispatch,
IRTPDispatch **ppiRTPDispatch,
ISetSenderStatistics **piSenderStats);
/**
*
* Method Name: GetRemoteSSRC()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: unsigned long - SSRC of remote particant
*
* Description: This method returns the remote SSRC ID associated with
* an RTCP Connection.
*
*
* Usage Notes:
*
*/
unsigned long GetRemoteSSRC(void);
bool isRemoteSSRCValid(void);
/**
*
* Method Name: GetRenderInterface()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: IRTCPRender * - RTCP Render Interface
*
* Description: This method allows a consumer to gain access to the RTCP
* Render interface associated with a specific RTCP Connection.
*
*
* Usage Notes:
*
*/
IRTCPRender * GetRenderInterface(void);
/**
*
* Method Name: GenerateRTCPReports
*
*
* Inputs: unsigned char *puchByeReason - Reason for terminating Connection
* ssrc_t aulCSRC[] - Array of contributing sources
* unsigned long ulCSRCs - Number of contributing sources
*
* Outputs: None
*
* Returns: None
*
* Description: The GenerateRTCPReports() method is called when the RTCP
* Report Timer has expired. This method will obtain the
* interface of the CRTCPRender object and instruct it to generate
* reports. The reports generate shall be returned and shall
* result in event delivery to the RTC Manager onto subscribing
* clients.
*
* Usage Notes:
*
*
*/
void GenerateRTCPReports(unsigned char *puchByeReason = NULL,
ssrc_t aulCSRC[] = NULL,
unsigned long ulCSRCs = 0);
/**
*
* Method Name: StopRenderer
*
*
* Inputs: bool bRelease
*
* Outputs: None
*
* Returns: bool
*
* Description: Performs connection based shutdown related to the orderly
* deallocation of connection based filters.
*
* Usage Notes:
*
*/
bool StopRenderer(void);
/**
*
* Method Name: Terminate
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: bool
*
* Description: Performs connection based shutdown related to the orderly
* deallocation of connection based filters.
*
* Usage Notes: This method must be called in order for the Connection object
* and its constituents to be gracefully deallocated.
*
*/
bool Terminate(void);
/**
*
* 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:
*
*/
unsigned long GetEventInterest(void);
/**
*
* 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: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
*
* Usage Notes:
*
*/
void NewSDES(IGetSrcDescription *piGetSrcDescription,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL);
/**
*
* Method Name: UpdatedSDES()
*
*
* Inputs: IGetSrcDescription *piGetSrcDescription
* - Interface to the new Source Description info
* unsigned long ulChangeMask
* - The SDES fields that were subject to change
* IRTCPConnection *piRTCPConnection
* - Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* - Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
* Usage Notes:
*
*/
void UpdatedSDES(IGetSrcDescription *piGetSrcDescription,
unsigned long ulChangeMask,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL);
/**
*
* 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: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
* Usage Notes:
*
*/
void SenderReportReceived(IGetSenderStatistics *piGetSenderStatistics,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL);
/**
*
* 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: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
* Usage Notes:
*
*/
void ReceiverReportReceived(IGetReceiverStatistics *piGetReceiverStatistics,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL);
/**
*
* 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: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
* Usage Notes:
*
*/
void ByeReportReceived(IGetByeInfo *piGetByeInfo,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL);
/**
*
* 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: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
* Usage Notes:
*
*/
void SDESReportSent(IGetSrcDescription *piGetSrcDescription,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL) {};
/**
*
* 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: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
* Usage Notes:
*
*/
void SenderReportSent(IGetSenderStatistics *piGetSenderStatistics,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL) {};
/**
*
* 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: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
* Usage Notes:
*
*/
void ReceiverReportSent(IGetReceiverStatistics *piGetReceiverStatistics,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL) {};
/**
*
* 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: Provides the corresponding RTCPConnection interface to the
* notification and passes it along to the subscribing Session
* Object.
*
* Usage Notes:
*
*/
void ByeReportSent(IGetByeInfo *piGetByeInfo,
IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL) {};
/**
*
* 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:
*
*/
void LocalSSRCCollision(IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL) {};
/**
*
* 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:
*
*/
void RemoteSSRCCollision(IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL) {};
/**
*
* Method Name: RTCPReportingAlarm
*
*
* Inputs: IRTCPConnection *piRTCPConnection
* - Interface to associated RTCP Connection
* IRTCPSession *piRTCPSession
* - Interface to associated RTCP Session
*
* Outputs: None
*
* Returns: None
*
* Description: The RTCPReportingAlarm() event method shall inform the
* recipient of the expiration of the RTCP Reporting Timer.
* This signals the generation of the next round of RTCP Reports.
*
* Usage Notes:
*
*
*/
void RTCPReportingAlarm(IRTCPConnection *piRTCPConnection=NULL,
IRTCPSession *piRTCPSession=NULL);
/**
*
* Macro Name: DECLARE_IBASE_M
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: None
*
* Description: This implements the IBaseClass functions used and exposed by
* derived classes.
*
* Usage Notes:
*
*
*/
DECLARE_IBASE_M
private: // Private Data Members
#ifdef PINGTEL_OSSOCKET
/**
*
* Method Name: StartRenderer()
*
*
* Inputs: OsSocket& rRtcpSocket - Reference to an RTCP Socket object
*
* Outputs: None
*
* Returns: bool - Result of Starting the Renderer
*
* Description: This method starts the RTCP Renderer allowing it to generate
* RTCP reports on regular intervals.
*
*
* Usage Notes:
*
*/
bool StartRenderer(OsSocket& rRtcpSocket);
#else
bool StartRenderer(INetworkRender *piNetworkRender);
#endif
/**
*
* Attribute Name: m_ulSSRC
*
* Type: unsigned long
*
* Description: This member shall cache the SSRC associated with
* this connection
*
*/
unsigned long m_ulSSRC;
/**
*
* Attribute Name: m_piRTCPNetworkRender
*
* Type: INetworkRender *
*
* Description: This member shall store the interface to the
* CNetworkChannel wrapper to the Pingtel OSSocket object.
*
*/
INetworkRender *m_piRTCPNetworkRender;
/**
*
* Attribute Name: m_piRTCPNotify
*
* Type: IRTCPNotify *
*
* Description: This member shall contain the interface for delivering
* notification to a registered consumer.
*
*/
IRTCPNotify * m_piRTCPNotify;
/**
*
* Attribute Name: m_piSDESReport
*
* Type: ISDESReport *
*
* Description: This member shall cache the control interface for the
* Source Description report that identifies the local site.
*
*/
ISDESReport *m_piSDESReport;
/**
*
* Attribute Name: m_ulEventInterest
*
* Type: unsigned long
*
* Description: This member shall store the events of interest for this
* Session object.
*
*/
unsigned long m_ulEventInterest;
/**
*
* Attribute Name: m_poRTCPRender
*
* Type: CRTCPRender *
*
* Description: This member shall store an instance to the
* RTCP Render object.
*
*/
CRTCPRender *m_poRTCPRender;
/**
*
* Attribute Name: m_poRTCPSource
*
* Type: CRTCPSource *
*
* Description: This member shall store an instance to the RTCP Source object.
*
*/
CRTCPSource *m_poRTCPSource;
};
/**
*
* Method Name: GetRemoteSSRC()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: unsigned long - SSRC of remote particant
*
* Description: This method returns the remote SSRC ID associated
* with an RTCP Connection.
*
*
* Usage Notes:
*
*/
inline unsigned long CRTCPConnection::GetRemoteSSRC(void) { return ((m_poRTCPRender) ? (m_poRTCPRender->GetRemoteSSRC()) : 0); }
inline bool CRTCPConnection::isRemoteSSRCValid(void) { return ((m_poRTCPRender) ? (m_poRTCPRender->isRemoteSSRCValid()) : 0); }
/**
*
* 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:
*
*/
inline unsigned long CRTCPConnection::GetEventInterest(void)
{
return(m_ulEventInterest);
}
#endif
|