/usr/include/sipxtapi/rtcp/IByeReport.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 | //
// 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 _IByeReport_h
#define _IByeReport_h
#include "rtcp/RtcpConfig.h"
// Include
#include "IBaseClass.h"
/**
*
* Interface Name: IByeReport
*
* Inheritance: None
*
*
* Description: The IByeReport interface allows consumers to parse, format,
* and otherwise control the interpretation and generation of
* RTCP Bye Reports.
*
* Notes:
*
*/
interface IByeReport : IBaseClass
{
// Public Methods
public:
virtual ~IByeReport() {}
/**
*
* 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: SetCSRC
*
*
* Inputs: None
*
* Outputs: unsigned long *paulCSRC
* Contributing Source Identifier(s) Array pointer
* unsigned long ulCSRCCount
* Number of Contributing Source Identifier(s)
* bool bNBO
* Flag indicating whether data is in NBO
*
* Returns: void
*
* Description: Sets the contributing source values associated with the
* RTP packet.
*
* Usage Notes:
*
*
*/
virtual void SetCSRC(ssrc_t *paulCSRC, unsigned long ulCSRCCount, bool bNBO)=0;
/**
*
* Method Name: SetReason
*
*
* Inputs: unsigned char *puchName
* Reason Character String
* unsigned long ulLength
* Optional Length of Reason argument passed
*
* Outputs: None
*
* Returns: void
*
* Description: Stores the Reason field and length, either specified of
* derived, as attributed within the object.
*
* Usage Notes: The Reason argument MUST be passed as a NULL terminated
* string or must contain a valid length argument. All text
* strings passed shall be truncated beyond the length of
* 255 unsigned characters.
*
*/
virtual void SetReason(unsigned char *puchReason, unsigned long ulLength)=0;
/**
*
* Method Name: FormatByeReport
*
*
* Inputs: unsigned long ulBufferSize
* Optional size defining the length allocated for the buffer
*
* Outputs: unsigned char *puchReportBuffer
* Character Buffer used to store the contents of the Sender Report
*
* Returns: unsigned long
* Returns the number of octet written into the buffer.
*
* Description: Constructs a Bye report using the buffer passed in by the
* caller.
*
* Usage Notes: The header of the RTCP Report shall be formatted by
* delegating to the base class.
*
*
*/
virtual unsigned long FormatByeReport(unsigned char *puchReportBuffer,
unsigned long ulBufferSize)=0;
/**
*
* Method Name: ParseByeReport
*
*
* Inputs: unsigned char *puchReportBuffer
* Character Buffer containing the contents of the Bye Report
*
* Outputs: None
*
* Returns: unsigned long
*
* Description: Extracts the contents of an Bye report using the buffer
* passed in by the caller.
*
* Usage Notes: The header of the RTCP Report shall be parsed by delegating
* to the base class.
*
*
*/
virtual unsigned long ParseByeReport(unsigned char *puchReportBuffer)=0;
};
#endif
|