/usr/include/ccrtp/queuebase.h is in libccrtp-dev 2.0.9-2.2+b2.
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 | // Copyright (C) 2001,2002,2004 Federico Montesino Pouzols <fedemp@altern.org>.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// As a special exception, you may use this file as part of a free software
// library without restriction. Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License. This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
//
// This exception applies only to the code released under the name GNU
// ccRTP. If you copy code from other releases into a copy of GNU
// ccRTP, as the General Public License permits, the exception does
// not apply to the code that you add in this way. To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for GNU ccRTP, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//
/**
* @file queuebase.h
*
* @short Base classes for RTP queues.
**/
#ifndef CCXX_RTP_QUEUEBASE_H_
#define CCXX_RTP_QUEUEBASE_H_
#include <commoncpp/pointer.h>
#include <ccrtp/rtppkt.h>
#include <ccrtp/sources.h>
NAMESPACE_COMMONCPP
/**
* @defgroup queuebase Base classes for RTP queues.
* @{
**/
/**
* @class AppDataUnit
* @short Interface (envelope) to data received over RTP packets.
*
* A class of objects representing data transmitted over RTP packets.
* Tipically, this object will apply to received data. Data blocks
* received via RTP connections as well as its related objects
* (source, etc), are accessed through the methods of this class.
*
* @author Federico Montesino Pouzols <fedemp@altern.org>
**/
class __EXPORT AppDataUnit
{
public:
AppDataUnit(const IncomingRTPPkt& packet, const SyncSource& src);
inline ~AppDataUnit()
{ }
/**
* @param src the AppDataUnit object being copied
*/
AppDataUnit(const AppDataUnit& src);
/**
* Assignment operator
*
* @param source the AppDataUnit object being assigned @return
* the result of the assignment
*/
AppDataUnit&
operator=(const AppDataUnit& source);
/**
* @return type of this data
*/
inline PayloadType
getType() const
{ return datablock->getPayloadType(); }
/**
* Get data as it is received in RTP packets (i.e. for
* multi-octet encodings, octets are in network
* order.
*
* @return Raw pointer to data block.
**/
inline const uint8* const
getData() const
{ return datablock->getPayload(); }
/**
* @return length of data in octets
**/
size_t
getSize() const
{ return datablock->getPayloadSize(); }
/**
* @return Source that sent this data
*/
inline const SyncSource&
getSource() const
{ return *source; }
/**
* Is this data unit marked?.
*
* @return true if marked.
**/
inline bool
isMarked() const
{ return datablock->isMarked(); }
/**
* Get data unit sequence number.
**/
inline uint16
getSeqNum() const
{ return datablock->getSeqNum(); }
/**
* Get the number of contributing sources in the CSRC list.
**/
inline uint8
getContributorsCount() const
{ return (uint8)datablock->getCSRCsCount(); }
/**
* Get the array of 32-bit CSRC identifiers.
*
* @return NULL if (getContributorsCount() == 0)
**/
inline const uint32*
getContributorsID() const
{ return datablock->getCSRCs(); }
private:
Pointer<const IncomingRTPPkt> datablock;
const SyncSource* source;
};
/**
* @class RTPQueueBase
*
* A virtual base class for RTP queue hierarchies.
*
* @author Federico Montesino Pouzols <fedemp@altern.org>
**/
class __EXPORT RTPQueueBase
{
public:
/**
* Set the payload format in use, for timing and payload type
* identification purposes.
*
* @param pf payload format to use from now on.
* @return whether the payload format has been successfully set.
**/
inline bool
setPayloadFormat(const PayloadFormat& pf)
{
currentPayloadType = pf.getPayloadType();
currentRTPClockRate = pf.getRTPClockRate();
return true;
}
inline uint32 getLocalSSRC() const
{ return localSSRC; }
/**
* Get the clock rate in RTP clock units (for instance, 8000
* units per second for PCMU, or 90000 units per second for
* MP2T). This value depends on what payload format has been
* selected using setPayloadFormat().
*
* @return clock rate in RTP clock units.
**/
inline uint32 getCurrentRTPClockRate() const
{ return currentRTPClockRate; }
inline PayloadType getCurrentPayloadType() const
{ return currentPayloadType; }
inline timeval getInitialTime() const
{ return initialTime; }
protected:
/**
* @param ssrc If not null, the local SSRC identifier for this
* session.
**/
RTPQueueBase(uint32 *ssrc = NULL);
inline void setLocalSSRC(uint32 ssrc)
{ localSSRC = ssrc; localSSRCNetwork = htonl(ssrc); }
inline uint32 getLocalSSRCNetwork() const
{ return localSSRCNetwork; }
virtual
~RTPQueueBase()
{ }
/**
* A plugin point for posting of BYE messages.
*
* @param - reason to leave the RTP session.
* @return number of octets sent.
**/
inline virtual size_t
dispatchBYE(const std::string&)
{ return 0; }
inline virtual void
renewLocalSSRC()
{ }
private:
// local SSRC 32-bit identifier
uint32 localSSRC;
// SSRC in network byte order
uint32 localSSRCNetwork;
// RTP clock rate for the current payload type.
uint32 currentRTPClockRate;
// Current payload type set for outgoing packets and expected
// from incoming packets.
PayloadType currentPayloadType;
// when the queue is created
timeval initialTime;
};
/**
* @class OutgoingDataQueueBase
*
* @author Federico Montesino Pouzols <fedemp@altern.org>
**/
class __EXPORT OutgoingDataQueueBase:
public virtual RTPQueueBase
{
public:
inline size_t
getDefaultMaxSendSegmentSize()
{ return defaultMaxSendSegmentSize;}
/**
* Set maximum payload segment size before fragmenting sends.
*
* @param size Maximum payload size.
* @return Whether segment size was successfully set.
**/
inline void
setMaxSendSegmentSize(size_t size)
{ maxSendSegmentSize = size; }
inline size_t
getMaxSendSegmentSize()
{ return maxSendSegmentSize; }
protected:
OutgoingDataQueueBase();
inline virtual
~OutgoingDataQueueBase()
{ }
private:
static const size_t defaultMaxSendSegmentSize;
// maximum packet size before fragmenting sends.
size_t maxSendSegmentSize;
};
/**
* @class IncomingDataQueueBase
*
* @author Federico Montesino Pouzols <fedemp@altern.org>
**/
class __EXPORT IncomingDataQueueBase:
public virtual RTPQueueBase
{
public:
inline size_t getDefaultMaxRecvPacketSize() const
{ return defaultMaxRecvPacketSize; }
inline size_t
getMaxRecvPacketSize() const
{ return maxRecvPacketSize; }
/**
* @param maxsize maximum length of received RTP data packets,
* in octets. Defaults to the value returned by
* getDefaultMaxRecvPacketSize().
*
* @note This method sets a filter for incoming
* packets. Setting higher values does not necessarily imply
* higher memory usage (this method does not set any buffer
* size).
**/
inline void
setMaxRecvPacketSize(size_t maxsize)
{ maxRecvPacketSize = maxsize; }
protected:
IncomingDataQueueBase()
{ setMaxRecvPacketSize(getDefaultMaxRecvPacketSize()); }
inline virtual
~IncomingDataQueueBase()
{ }
private:
static const size_t defaultMaxRecvPacketSize;
// filter value for received packets length.
size_t maxRecvPacketSize;
};
/** @}*/ // queuebase
END_NAMESPACE
#endif //CCXX_RTP_QUEUEBASE_H_
/** EMACS **
* Local variables:
* mode: c++
* c-basic-offset: 8
* End:
*/
|