/usr/include/sipxtapi/rtcp/ISenderReport.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 | //
// 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 _ISenderReport_h
#define _ISenderReport_h
#include "rtcp/RtcpConfig.h"
// Includes
#include "IBaseClass.h"
/**
*
* Interface Name: ISenderReport
*
* Inheritance: None
*
*
* Description: The ISenderReport interface allows consumers to parse,
* format, and otherwise control the interpretation and
* generation of RTCP Sender Reports.
*
* Notes:
*
*/
interface ISenderReport : public IBaseClass
{
// Public Methods
public:
/**
*
* Method Name: SetSSRC
*
*
* Inputs: unsigned ssrc_t 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 octet
* and packet count accumulators as mandated by standard.
*
*
*
*/
virtual void SetSSRC(ssrc_t ulSSRC) = 0;
/**
*
* Method Name: WasMediaSent
*
*
* Inputs: None
*
* Outputs: None
*
* Returns: bool
*
* Description: A method to determine whether media has been sent out since
* the last reporting period. This will determine whether a
* Sender Report or Receiver Report is in order.
*
* Usage Notes:
*
*/
virtual bool WasMediaSent(void)=0;
/**
*
* Method Name: FormatSenderReport
*
*
* Inputs: uint32_t ulBufferSize -
* Optional size defining the length allocated for the buffer
*
* Outputs: unsigned char *puchReportBuffer -
* Buffer used to store the contents of the Sender Report
*
* Returns: uint32_t -
* Returns the number of octets written into the buffer.
*
* Description: Constructs a Sender report using the buffer passed in by the
* caller. The Sender Report object shall keep track of the
* reporting periods that have passed an which information
* should be used to populate the report.
*
* Usage Notes: The header of the RTCP Report shall be formatted by delegating
* to the base class.
*
*
*/
virtual unsigned long FormatSenderReport(unsigned char *puchReportBuffer,
unsigned long ulBufferSize) = 0;
/**
*
* Method Name: ParseSenderReport
*
*
* Inputs: unsigned char *puchReportBuffer -
* Buffer containing the contents of the Sender Report
*
* Outputs: None
*
* Returns: None
*
* Description: Extracts the contents of an Sender report using the buffer
* passed in by the caller. The Sender Report object shall store
* the content and length of data fields extracted from the
* Sender Report.
*
* Usage Notes: The header of the RTCP Report shall be parsed by delegating to
* the base class.
*
*
*/
virtual unsigned long ParseSenderReport(unsigned char *puchReportBuffer)=0;
};
#endif
|