/usr/include/sipxtapi/rtcp/RTCPSession.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 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 | //
// 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 _RTCPSession_h
#define _RTCPSession_h
#include "rtcp/RtcpConfig.h"
// Includes
#include "TLinkedList.h"
#include "RTCPConnection.h"
#include "IRTCPRender.h"
#include "INetworkRender.h"
#include "IRTCPSession.h"
#include "IRTCPNotify.h"
/**
*
* Class Name: CRTCPSession
*
* Inheritance: CBaseClass - Base Class Implementation
*
*
* Interfaces: IRTCPSession - RTCP Session Control Interface
*
* Description: The CRTCPSession Class shall create, manage, and terminate
* instances of RTCP Connection objects used to monitor and report
* upon a corresponding number of RTP Connections composing an RTP
* Session.
*
*
* Notes: CRTCPSession is derived from CBaseClass which provides basic
* Initialization and reference counting support.
*
*/
class CRTCPSession:
public CBaseClass, // Inherits CBaseClass implementation
public CTLinkedList<CRTCPConnection *>,
// Inherit Connection Linked List Services
public IRTCPSession, // Interface exposed for RTCP Session Control
public IRTCPNotify // Interface exposed for RTCP Notifications
{
// Public Methods
public:
/**
*
* Method Name: CRTCPSession() - Constructor
*
*
* Inputs: unsigned long ulSSRC - SSRC ID of the RTCP Session
* IRTCPNotify *piRTCPNotify - RTCP Event Notification Interface
* ISDESReport *piSDESReport
* - Local Source Description Report Interface
*
*
* Outputs: None
*
* Returns: None
*
* Description: Performs routine assignment of constructor arguments to
* internal attributes.
*
* Usage Notes:
*
*/
CRTCPSession(unsigned long ulSSRC,
IRTCPNotify *piRTCPNotify,
ISDESReport *piSDESReport);
/**
*
* Method Name: ~CRTCPSession() - 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:
* ==> The list containing RTCP Connections objects shall be
* drained with the reference to each object released.
*
* Usage Notes:
*
*
*/
~CRTCPSession(void);
/**
*
* Method Name: CreateRTCPConnection()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: bool
*
* Description: Creates an RTCP Connection used to monitor and report upon
* the identify and performance of an RTP Connection.
*
* Usage Notes:
*
*/
IRTCPConnection *CreateRTCPConnection(void);
/**
*
* Method Name: TerminateRTCPConnection()
*
*
* Inputs: IRTCPConnection *piRTCPConnection
* - The Connection Interface pointer returned on creation
* unsigned char *puchReason
* - Reason for Termination
*
* Outputs: None
*
* Returns: bool
*
* Description: Terminates an RTCP Connection previously used to monitor and
* report upon the identify and performance of an RTP Connection.
*
* Usage Notes:
*
*/
bool TerminateRTCPConnection(IRTCPConnection *piRTCPConnection);
/**
*
* Method Name: TerminateAllConnections
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: bool
*
* Description: The TerminateAllConnections() method shall manage the
* termination of all RTCP connections. This shall include the
* graceful release of all associated objects as well as the
* deallocation of all resources associated with each contained
* RTCP connection.
*
*
* Usage Notes:
*
*
*/
void TerminateAllConnections(void);
/**
*
* Method Name: ReassignSSRC
*
*
* Inputs: unsigned long ulSSRC - Source ID
*
* Outputs: None
*
* Returns: void
*
* Description: Reassigns the Source Identifier associated with an RTP session
* due to collision detection and resolution. Calling of this
* method shall result in the resetting of the SSRC IDs of
* associated Sender, Receiver, and SDES Reports.
*
* Usage Notes:
*
*
*
*/
void ReassignSSRC(unsigned long ulSSRC, unsigned char *puchReason=NULL);
/**
*
* Method Name: ForwardSDESReport
*
*
* Inputs: IGetSrcDescription *piGetSrcDescription
* - Interface for getting SDES Report Statistics
* IRTCPConnection *piRTCPConnection
* - Interface to RTCP Connection originating SDES
*
* Outputs: None
*
* Returns: None
*
* Description: The ForwardSDESReport() method shall enable the RTC Manager to
* pass interfaces to SDES Reports received from participating
* site while acting in the mode of a conference Mixer. The
* Mixer's role in this situation is to transmit these reports
* unchanged to others participating within a conference. The
* handoff of an SDES Report to the CRTCPRender will cause the
* report to be transmitted to a participating site using the
* associated Network Render object.
*
* Usage Notes: The interface for the local site's Source Description Report
* generator is passed as an argument at construction time.
*
*
*/
void ForwardSDESReport(IGetSrcDescription *piGetSrcDescription,
IRTCPConnection *piRTCPConnection);
/**
*
* Method Name: ForwardByeReport
*
*
* Inputs: IGetByeInfo *piGetByeInfo
* - Interface used to retrieve Bye Report information
* IRTCPConnection *piRTCPConnection
* - Interface to RTCP Connection originating Bye
*
* Outputs: None
*
* Returns: None
*
* Description: The ForwardByeReport() method shall enable the RTC Manager to
* pass interfaces to Bye Reports received from participating site
* while acting in the mode of a conference Mixer. The Mixer's
* role in this situation is to transmit these reports unchanged
* to others participating within a conference. The handoff of a
* Bye Report to the CRTCPRender will cause the report to be
* transmitted to a participating site using the associated
* Network Render object.
*
* Usage Notes:
*
*
*/
void ForwardByeReport(IGetByeInfo *piGetByeInfo,
IRTCPConnection *piRTCPConnection);
/**
*
* Method Name: CheckLocalSSRCCollisions
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: void
*
* Description: Check that our local SSRC is not colliding with one fo the
* SSRCs of a participating site.
*
* Usage Notes:
*
*
*
*/
void CheckLocalSSRCCollisions(void);
/**
*
* Method Name: CheckRemoteSSRCCollisions
*
*
* Inputs: IRTCPConnection *piRTCPConnection - Connection Interface
*
* Outputs: None
*
* Returns: void
*
* Description: Check that other remote SSRCs aren't colliding with each other.
*
* Usage Notes:
*
*
*
*/
void CheckRemoteSSRCCollisions(IRTCPConnection *piRTCPConnection);
/**
*
* Method Name: SetMixerMode()
*
*
* Inputs: MIXER_MODE_ET etMixerMode
* - Identifies whether the audio mixer is enabled or disabled
*
* Outputs: None
*
* Returns: None
*
* Description: Sets the audio mixer mode for a session.
*
* Usage Notes:
*
*/
void SetMixerMode(MIXER_MODE_ET etMixerMode);
/**
*
* Method Name: GetMixerMode()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: MIXER_MODE_ET - The audio mixer mode supported by the session
*
* Description: Retrieves the audio mixer mode supported by the session.
*
* Usage Notes:
*
*/
MIXER_MODE_ET GetMixerMode(void);
/**
*
* Method Name: GetSessionID()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: unsigned long - The ID for this Sesson
*
* Description: Retrieves the Session ID associated with a session.
*
* Usage Notes:
*
*/
unsigned long GetSessionID(void);
/**
*
* Method Name: GetSSRC()
*
*
* Inputs: integer triple, identifying the stream
*
* Outputs: None
*
* Returns: ssrc_t - Local SSRC associated with the session
*
* Description: Retrieves the SSRC associated with a session.
*
* Usage Notes:
*
*/
ssrc_t GetSSRC(int, int, int);
/**
*
* 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: GetFirstConnection
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: IRTCPSession *
* - Returns an interface for use in controlling an RTCP Session
*
*
* Description: The GetFirstConnection shall retrieve the first instantiation
* of an RTCP Session interface on the RTC Manager's collection
* list.
*
*
* Usage Notes:
*
*
*/
IRTCPConnection *GetFirstConnection(void);
/**
*
* Method Name: GetNextConnection
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: IRTCPSession *
* - Returns an interface for use in controlling an RTCP Session
*
*
* Description: The GetNextConnection shall retrieve the next instantiation of
* an RTCP Conection interface on an RTCP Session's collection
* list.
*
*
* Usage Notes:
*
*
*/
IRTCPConnection *GetNextConnection(void);
/**
*
* Method Name: CheckConnection
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: IRTCPConnection *
* - Returns an interface for use in controlling an RTCP Connection
*
*
* Description: The CheckConnection shall check an instance of an RTCP
* Connection interface on the RTCP Session's collection list.
*
*
* Usage Notes:
*
*
*/
IRTCPConnection *CheckConnection(IRTCPConnection *);
/**
*
* 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 RTC Manager of a
* new Source Description and shall include the IGetSrcDescription
* interface for accessing the contents of this new Source
* Description. The RTCP Session shall react by adding this new
* SDES interface to the Source DescriptionList of associated
* CRTCPRenders so that the new SDES information may be forwarded
* to other call participants (i.e. Mixer scenario).
*
*
* Usage Notes:
*
*/
void NewSDES(IGetSrcDescription *piGetSrcDescription,
IRTCPConnection *piRTCPConnection,
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: The UpdatedSDES() event method shall inform the RTCP Session
* of a change in Source Description and shall include the
* IGetSrcDescription interface for accessing the contents of
* this updated Source Description.
*
* Usage Notes:
*
*/
void UpdatedSDES(IGetSrcDescription *piGetSrcDescription,
unsigned long ulChangeMask,
IRTCPConnection *piRTCPConnection,
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: 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:
*
*/
void SenderReportReceived(IGetSenderStatistics *piGetSenderStatistics,
IRTCPConnection *piRTCPConnection,
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: 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:
*
*/
void ReceiverReportReceived(IGetReceiverStatistics *piGetReceiverStatistics,
IRTCPConnection *piRTCPConnection,
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: 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. The RTCP Session shall react by forwarding this
* Bye Report to other connections within the session whne in a
* audio conference call (i.e. Mixer scenario).
*
* Usage Notes:
*
*/
void ByeReportReceived(IGetByeInfo *piGetByeInfo,
IRTCPConnection *piRTCPConnection,
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: 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:
*
*/
void SDESReportSent(IGetSrcDescription *piGetSrcDescription,
IRTCPConnection *piRTCPConnection,
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: 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:
*
*/
void SenderReportSent(IGetSenderStatistics *piGetSenderStatistics,
IRTCPConnection *piRTCPConnection,
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: 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:
*
*/
void ReceiverReportSent(IGetReceiverStatistics *piGetReceiverStatistics,
IRTCPConnection *piRTCPConnection,
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: 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:
*
*/
void ByeReportSent(IGetByeInfo *piGetByeInfo,
IRTCPConnection *piRTCPConnection,
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,
IRTCPSession *piRTCPSession=NULL);
/**
*
* 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:
*
*/
void RTCPConnectionStopped(IRTCPConnection *piRTCPConnection,
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 Member Functions
/**
*
* Method Name: ResetAllConnections
*
*
* Inputs: unsigned char *puchReason - Reason for Termination
*
* Outputs: None
*
* Returns: void
*
* Description: The ResetAllConnections() method shall manage the termination
* of all RTCP connections. This shall include the graceful
* release of all associated objects as well as the deallocation
* of all resources associated with each contained RTCP connection.
*
*
* Usage Notes:
*
*
*/
void ResetAllConnections(unsigned char *puchReason);
private: // Private Data Members
/**
*
* Attribute Name: m_ulSSRC
*
* Type: unsigned long
*
* Description: This member shall store the SSRC associated with this session
*
*/
ssrc_t m_ulSSRC;
/**
*
* Attribute Name: m_ulSessionID
*
* Type: unsigned long
*
* Description: This member shall store a reference to the session number.
* This is only for identification purposes from debug tracking
*
*/
unsigned long m_ulSessionID;
/**
*
* 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_etMixerMode
*
* Type: MIXER_MODE_ET
*
* Description: This member shall store the mixer mode of this Session object.
*
*/
MIXER_MODE_ET m_etMixerMode;
/**
*
* 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;
};
/**
*
* 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 CRTCPSession::GetEventInterest(void)
{
return(m_ulEventInterest);
}
/**
*
* Method Name: CheckConnection
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: IRTCPConnection *
* - Returns an interface for use in controlling an RTCP Connection
*
*
* Description: The CheckConnection shall check an instance of an RTCP
* Connection interface on the RTCP Session's collection list.
*
*
* Usage Notes:
*
*
*/
inline IRTCPConnection
*CRTCPSession::CheckConnection(IRTCPConnection *piRTCPConnection)
{
// Attempt to retrieve the connection from the collection
CRTCPConnection *poRTCPConnection =
GetEntry((CRTCPConnection *)piRTCPConnection);
// See whether the Render object is still active
if(poRTCPConnection)
{
IRTCPRender *piRtcpRender = poRTCPConnection->GetRenderInterface();
if(piRtcpRender)
{
piRtcpRender->Release(ADD_RELEASE_CALL_ARGS(__LINE__));
return((IRTCPConnection *)poRTCPConnection);
}
}
return(NULL);
}
/**
*
* Method Name: SetMixerMode()
*
*
* Inputs: MIXER_MODE_ET etMixerMode
* - Identifies whether the audio mixer is enabled or disabled
*
* Outputs: None
*
* Returns: None
*
* Description: Sets the audio mixer mode for a session.
*
* Usage Notes:
*
*/
inline void CRTCPSession::SetMixerMode(MIXER_MODE_ET etMixerMode)
{
// Set the mixer attribute for this session
m_etMixerMode = etMixerMode;
}
/**
*
* Method Name: GetMixerMode()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: MIXER_MODE_ET - The audio mixer mode supported by the session
*
* Description: Retrieves the audio mixer mode supported by the session.
*
* Usage Notes:
*
*/
inline MIXER_MODE_ET CRTCPSession::GetMixerMode(void)
{
// return the mixer attribute for this session
return(m_etMixerMode);
}
/**
*
* Method Name: GetSessionID()
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: unsigned long - The ID for this Sesson
*
* Description: Retrieves the Session ID associated with a session.
*
* Usage Notes:
*
*/
inline unsigned long CRTCPSession::GetSessionID(void)
{
return(m_ulSessionID);
}
#endif
|