/usr/include/opal/im/msrp.h is in libopal-dev 3.10.2~dfsg-0ubuntu1.
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 | /*
* msrp.h
*
* Support for RFC 4975 Message Session Relay Protocol (MSRP)
*
* Open Phone Abstraction Library (OPAL)
*
* Copyright (c) 2008 Post Increment
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Open Phone Abstraction Library.
*
* The Initial Developer of the Original Code is Post Increment
*
* Contributor(s): ______________________________________.
*
* $Revision: 23593 $
* $Author: csoutheren $
* $Date: 2009-10-06 01:23:00 -0500 (Tue, 06 Oct 2009) $
*/
#ifndef OPAL_IM_MSRP_H
#define OPAL_IM_MSRP_H
#include <ptlib.h>
#include <opal/buildopts.h>
#include <opal/rtpconn.h>
#include <opal/manager.h>
#include <opal/mediastrm.h>
#include <opal/mediatype.h>
#include <im/im.h>
#include <ptclib/inetprot.h>
#include <ptclib/guid.h>
#include <ptclib/mime.h>
#if OPAL_SIP
#include <sip/sdp.h>
#endif
#if OPAL_HAS_MSRP
class OpalMSRPMediaType : public OpalIMMediaType
{
public:
OpalMSRPMediaType();
virtual OpalMediaSession * CreateMediaSession(OpalConnection & conn, unsigned sessionID) const;
#if OPAL_SIP
SDPMediaDescription * CreateSDPMediaDescription(const OpalTransportAddress & localAddress);
#endif
};
////////////////////////////////////////////////////////////////////////////
//
// Ancestor for all MSRP encoding types
//
class OpalMSRPEncoding {
};
////////////////////////////////////////////////////////////////////////////
//
// Ancestor for MSRP protocol
//
class MSRPProtocol : public PInternetProtocol
{
public:
enum Commands {
SEND,
REPORT,
NumCommands
};
static const unsigned MaximumMessageLength = 1024;
class Message
{
public:
struct Chunk {
Chunk(const PString & id, unsigned from, unsigned len)
: m_chunkId(id), m_rangeFrom(from + 1), m_rangeTo(from + len) { }
PString m_chunkId;
unsigned m_rangeFrom;
unsigned m_rangeTo;
};
typedef std::vector<Chunk> ChunkList;
ChunkList m_chunks;
PString m_id;
PURL m_fromURL;
PURL m_toURL;
PString m_contentType;
unsigned m_length;
};
MSRPProtocol();
bool SendSEND(
const PURL & from,
const PURL & to,
const PString & text,
const PString & contentType,
PString & messageId
);
bool SendChunk(
const PString & transactionId,
const PString toUrl,
const PString fromUrl,
const PMIMEInfo & mime,
const PString & body
);
bool SendResponse(const PString & chunkId,
unsigned response,
const PString & text,
const PString & toUrl,
const PString & fromUrl);
bool SendREPORT(const PString & chunkId,
const PString & toUrl,
const PString & fromUrl,
const PMIMEInfo & mime);
bool ReadMessage(
int & command,
PString & chunkId,
PMIMEInfo & mime,
PString & body
);
//typedef std::map<std::string, Message> MessageMap;
//MessageMap m_messageMap;
PMutex m_mutex;
};
////////////////////////////////////////////////////////////////////////////
//
//
//
class OpalMSRPManager : public PObject
{
public:
enum {
DefaultPort = 2855
};
//
// Create an MSRP manager. This is a singleton class
//
OpalMSRPManager(OpalManager & opal, WORD port = DefaultPort);
~OpalMSRPManager();
//
// Get the local port for the MSRP manager
//
bool GetLocalPort(WORD & port);
//
// Information about a connection to another MSRP manager
//
class Connection : public PSafeObject {
public:
Connection(OpalMSRPManager & manager, const std::string & key, MSRPProtocol * protocol = NULL);
~Connection();
//
// Start handler thread for a connection
//
void StartHandler();
//
// Handler thread for a connection
//
void HandlerThread();
OpalMSRPManager & m_manager;
std::string m_key;
MSRPProtocol * m_protocol;
bool m_running;
PThread * m_handlerThread;
bool m_originating;
PAtomicInteger m_refCount;
};
//
// Get the connection to use for communicating with a remote URL
//
PSafePtr<Connection> OpenConnection(
const PURL & localURL,
const PURL & remoteURL
);
//
// close a connection
//
bool CloseConnection(
PSafePtr<OpalMSRPManager::Connection> & connection
);
//
// Create a new MSRP session ID
//
std::string CreateSessionID();
//
// return session ID as a path
//
PURL SessionIDToURL(const OpalTransportAddress & addr, const std::string & id);
//
// Main listening thread for new connections
//
void ListenerThread();
struct IncomingMSRP {
int m_command;
PString m_chunkId;
PMIMEInfo m_mime;
PString m_body;
PSafePtr<Connection> m_connection;
};
//
// dispatch an incoming MSRP message to the correct callback
//
void DispatchMessage(
IncomingMSRP & incomingMsg
);
typedef PNotifierTemplate<IncomingMSRP &> CallBack;
void SetNotifier(
const PURL & localUrl,
const PURL & remoteURL,
const CallBack & notifier
);
void RemoveNotifier(
const PURL & localUrl,
const PURL & remoteURL
);
OpalManager & GetOpalManager() { return opalManager; }
protected:
OpalManager & opalManager;
WORD m_listenerPort;
PMutex mutex;
PAtomicInteger lastID;
PTCPSocket m_listenerSocket;
PThread * m_listenerThread;
PMutex m_connectionInfoMapAddMutex;
typedef std::map<std::string, PSafePtr<Connection> > ConnectionInfoMapType;
ConnectionInfoMapType m_connectionInfoMap;
typedef std::map<std::string, CallBack> CallBackMap;
CallBackMap m_callBacks;
PMutex m_callBacksMutex;
private:
static OpalMSRPManager * msrp;
};
////////////////////////////////////////////////////////////////////////////
/** Class for carrying MSRP session information
*/
class OpalMSRPMediaSession : public OpalMediaSession
{
PCLASSINFO(OpalMSRPMediaSession, OpalMediaSession);
public:
OpalMSRPMediaSession(OpalConnection & connection, unsigned sessionId);
OpalMSRPMediaSession(const OpalMSRPMediaSession & _obj);
~OpalMSRPMediaSession();
bool Open(const PURL & remoteParty);
virtual void Close();
virtual PObject * Clone() const { return new OpalMSRPMediaSession(*this); }
virtual bool IsActive() const { return true; }
virtual bool IsRTP() const { return false; }
virtual bool HasFailed() const { return false; }
virtual OpalTransportAddress GetLocalMediaAddress() const;
PURL GetLocalURL() const { return m_localUrl; }
PURL GetRemoteURL() const { return m_remoteUrl; }
void SetRemoteURL(const PURL & url) { m_remoteUrl = url; }
virtual void SetRemoteMediaAddress(const OpalTransportAddress &, const OpalMediaFormatList & );
virtual bool WritePacket(
RTP_DataFrame & frame
);
PBoolean ReadData(
BYTE * data,
PINDEX length,
PINDEX & read
);
#if OPAL_SIP
virtual SDPMediaDescription * CreateSDPMediaDescription(
const OpalTransportAddress & localAddress
);
#endif
virtual OpalMediaStream * CreateMediaStream(
const OpalMediaFormat & mediaFormat,
unsigned sessionID,
PBoolean isSource
);
OpalMSRPManager & GetManager() { return m_manager; }
bool OpenMSRP(const PURL & remoteUrl);
void CloseMSRP();
void SetConnection(PSafePtr<OpalMSRPManager::Connection> & conn);
OpalMSRPManager & m_manager;
bool m_isOriginating;
std::string m_localMSRPSessionId;
PURL m_localUrl;
PURL m_remoteUrl;
PSafePtr<OpalMSRPManager::Connection> m_connectionPtr;
OpalTransportAddress m_remoteAddress;
};
////////////////////////////////////////////////////////////////////////////
class OpalMSRPMediaStream : public OpalIMMediaStream
{
public:
OpalMSRPMediaStream(
OpalConnection & conn,
const OpalMediaFormat & mediaFormat, ///< Media format for stream
unsigned sessionID, ///< Session number for stream
bool isSource, ///< Is a source stream
OpalMSRPMediaSession & msrpSession
);
~OpalMSRPMediaStream();
virtual PBoolean RequiresPatchThread() const { return !isSource; }
/**Read raw media data from the source media stream.
The default behaviour reads from the PChannel object.
*/
virtual PBoolean ReadPacket(
RTP_DataFrame & frame
);
/**Write raw media data to the sink media stream.
The default behaviour writes to the PChannel object.
*/
virtual PBoolean WritePacket(
RTP_DataFrame & frame
);
virtual bool Open();
virtual bool Close();
PURL GetRemoteURL() const { return m_msrpSession.GetRemoteURL(); }
void SetRemoteURL(const PURL & url) { m_msrpSession.SetRemoteURL(url); }
PDECLARE_NOTIFIER2(OpalMSRPManager, OpalMSRPMediaStream, OnReceiveMSRP, OpalMSRPManager::IncomingMSRP &);
//@}
protected:
OpalMSRPMediaSession & m_msrpSession;
PString m_remoteParty;
RFC4103Context m_rfc4103Context;
};
// schemeName,user, passwd, host, defUser,defhost, query, params, frags, path, rel, port
#endif // OPAL_HAS_MSRP
#endif // OPAL_IM_MSRP_H
|