/usr/include/sipxtapi/rtcp/IReceiverReport.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 | //
// 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 _IReceiverReport_h
#define _IReceiverReport_h
#include "rtcp/RtcpConfig.h"
// Include
#include "IBaseClass.h"
/**
*
* Interface Name: IReceiverReport
*
* Inheritance: None
*
*
* Description: The IReceiverReport interface allows consumers to parse,
* format, and otherwise control the interpretation and
* generation of RTCP Receiver Reports.
*
* Notes:
*
*/
interface IReceiverReport : public IBaseClass
{
// Public Methods
public:
/**
*
* Method Name: SetSSRC
*
*
* Inputs: unsigned long ulSSRC - Source ID
*
* Outputs: None
*
* Returns: void
*
* Description: Stores the Source Identifier associated with an RTP connection.
*
* Usage Notes: This is an override of the base class method defined in
* CRTCPHeader. This method shall additionally reset the
* receiver statistics associated with the RTP connection as
* mandated per standard.
*
*/
virtual void SetSSRC(ssrc_t ulSSRC) = 0;
/**
*
* Method Name: FormatReceiverReport
*
*
* Inputs: bool bSRPresent
* Specifies whether a Sender Report is prepended
* unsigned long ulBufferSize
* Optional size defining the length allocated for the buffer
*
* Outputs: unsigned char *puchReportBuffer
* Character Buffer used to store the Receiver Report
*
* Returns: unsigned long
* Returns the number of octets written into the buffer.
*
* Description: Constructs a Receiver report using the buffer passed in by
* the caller. A Receiver Report may be appended to the contents
* of a Sender Report or sent along in the case where no data was
* transmitted during the reporting period. The header flag set
* to True shall cause the Receiver Report to be appended while
* False will cause a header to be prepended to the Report
* information.
*
* A call to this method shall cause all period counts to be reset.
*
* Usage Notes: The header of the RTCP Report shall be formatted by delegating
* to the base class.
*
*
*
*/
virtual unsigned long FormatReceiverReport(bool bSRPresent,
unsigned char *puchReportBuffer,
unsigned long ulBufferSize)=0;
/**
*
* Method Name: ParseReceiverReport
*
*
* Inputs: boolean bHeader
* Specifies whether a header is included
* unsigned char *puchReportBuffer
* Character Buffer used to store the Receiver Report
*
* Outputs:
*
* Returns: unsigned long
* Returns the number of octets processed
*
* Description: Processes a Receiver report using the buffer passed in by the
* caller. The header flag shall identify whether the report is
* prepended with a header.
*
* Usage Notes: The header of the RTCP Report, if provided, shall be parsed
* by delegating to the base class.
*
*
*/
virtual unsigned long ParseReceiverReport(bool bHeader,
unsigned char *puchReportBuffer) = 0;
};
#endif
|