rtspmsg.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:9k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. /*
  36.  * RTSP/1.0 message and helper classes 
  37.  *
  38.  */
  39. #ifndef _RTSPMSG_H_
  40. #define _RTSPMSG_H_
  41. #include "hxrtsp2.h"
  42. #include "mimehead.h"
  43. class CHXString;
  44. class CHXSimpleList;
  45. struct IHXValues;
  46. const UINT32 RTSP_PLAY_RANGE_BLANK = (UINT32)-1;
  47. /*
  48.  * Contains a begin/end pair (expressed in millisecs)
  49.  */
  50. class RTSPRange: public MIMEHeaderValue
  51. {
  52. public:
  53.     enum RangeType { TR_SMPTE, TR_CLOCK, TR_NPT } m_rangeType;
  54.     RTSPRange(UINT32 begin, UINT32 end, RangeType rType);
  55.     UINT32 m_begin;
  56.     UINT32 m_end;
  57.     void asString(CHXString& str);
  58.     CHXString asString();
  59. };
  60. class RTSPAuthentication: public MIMEHeaderValue
  61. {
  62. public:
  63.     enum AuthenticationType { AU_BASIC, AU_DIGEST, AU_HX_PRIVATE } m_authType;
  64.     RTSPAuthentication(const char* authString, AuthenticationType authType);
  65.     RTSPAuthentication(IHXValues* authValues);
  66.     ~RTSPAuthentication();
  67.     void asString(CHXString& str);
  68.     CHXString asString();
  69.     CHXString   m_authString;
  70.     IHXValues* m_authValues;
  71. };
  72. class RTSPDigestAuthorization: public MIMEHeaderValue
  73. {
  74. public:
  75.     RTSPDigestAuthorization(IHXValues* pValues);
  76.     void asString(CHXString& str);
  77.     CHXString asString();
  78.     IHXValues* m_values;
  79. };
  80. class RTSPPEPInfo: public MIMEHeaderValue
  81. {
  82. public:
  83.     RTSPPEPInfo(BOOL bStrengthMust);
  84.     ~RTSPPEPInfo();
  85.     void asString(CHXString& str);
  86.     CHXString asString();
  87.     BOOL m_bStrengthMust;
  88. };
  89. /*
  90.  * Base class for all RTSP messages
  91.  */
  92. class RTSPMessage
  93. {
  94. public:
  95.     RTSPMessage();
  96.     virtual ~RTSPMessage();
  97.     static const int MAJ_VERSION;
  98.     static const int MIN_VERSION;
  99.     enum Tag { T_UNKNOWN, T_RESP, T_SETUP, T_REDIRECT, 
  100.        T_PLAY, T_PAUSE, T_SET_PARAM, T_GET_PARAM,
  101.        T_OPTIONS, T_DESCRIBE, T_TEARDOWN, T_RECORD,
  102.        T_ANNOUNCE };
  103.     virtual RTSPMessage::Tag tag() const = 0;
  104.     virtual RTSPMethod GetMethod() const = 0;
  105.     virtual const char* tagStr() const = 0;
  106.     void setVersion(int maj, int min) { m_nMajorVersion = maj;
  107.                                         m_nMinorVersion = min; }
  108.     int majorVersion() { return m_nMajorVersion; }
  109.     int minorVersion() { return m_nMinorVersion; }
  110.     void setContent(const char* pStr) { m_content = pStr; }
  111.     const char* getContent() { return m_content; }
  112.     int contentLength();
  113.     MIMEHeader* getHeader(const char* pName);
  114.     MIMEHeader* getFirstHeader();
  115.     MIMEHeader* getNextHeader();
  116.     // special case retrieval for simple Header: value situations
  117.     CHXString getHeaderValue(const char* pName);
  118.     int getHeaderValue(const char* pName, UINT32& value);
  119.     void addHeader(MIMEHeader* pHeader, BOOL bAtHead = FALSE);
  120.     void addHeader(const char* pName, const char* pValue, BOOL bAtHead = FALSE);
  121.     void setSeqNo(UINT32 seqNo) { m_seqNo = seqNo; }
  122.     UINT32 seqNo() const { return m_seqNo; }
  123.     virtual void asString(char* pBuf, int& msgLen) = 0;
  124.     virtual CHXString asString() = 0;
  125.     HX_RESULT AsValues(REF(IHXValues*) pIHXValuesHeaders);
  126. private:
  127.     void clearHeaderList();
  128.     int m_nMajorVersion;
  129.     int m_nMinorVersion;
  130.     UINT32 m_seqNo;
  131.     CHXString m_content;
  132.     CHXSimpleList m_headers;
  133.     LISTPOSITION m_listpos;
  134. };
  135. /*
  136.  * RTSP request is in form:
  137.  *
  138.  *  method url version sequence-number<CRLF>
  139.  *      *(header<CRLF>)
  140.  *      <CRLF>
  141.  */
  142. class RTSPRequestMessage: public RTSPMessage
  143. {
  144. public:
  145.     virtual RTSPMessage::Tag tag() const = 0;
  146.     virtual RTSPMethod GetMethod() const = 0;
  147.     virtual const char* tagStr() const = 0;
  148.     void setURL(const char* pURL) { m_url = pURL; }
  149.     const char* url() const { return m_url; }
  150.     void asString(char* pBuf, int& msgLen);
  151.     CHXString asString();
  152. private:
  153.     CHXString m_url;
  154. };
  155. /*
  156.  * RTSP response is in form:
  157.  *
  158.  * version error-code sequence-number error-text<CRLF>
  159.  *      *(header<CRLF>)
  160.  * <CRLF>
  161.  *
  162.  */
  163. class RTSPResponseMessage: public RTSPMessage
  164. {
  165. public:
  166.     virtual RTSPMessage::Tag tag() const { return RTSPMessage::T_RESP; }
  167.     virtual RTSPMethod GetMethod() const { return RTSP_RESP; }
  168.     const char* tagStr() const { return ""; }
  169.     void setErrorCode(const char* eCode) 
  170.     {
  171. m_errorCode = eCode; 
  172. m_ulErrorCode = atol(eCode);
  173.     }
  174.     const char* errorCode() { return m_errorCode; }
  175.     const UINT32 errorCodeAsUINT32() { return m_ulErrorCode; }
  176.     void setErrorMsg(const char* eMsg) { m_errorMsg = eMsg; }
  177.     const char* errorMsg() { return m_errorMsg; }
  178.     void asString(char* pBuf, int& msgLen);
  179.     CHXString asString();
  180. private:
  181.     CHXString m_errorCode;
  182.     CHXString m_errorMsg;
  183.     UINT32 m_ulErrorCode;
  184. };
  185. /*
  186.  *  Request messgage objects are separated by tags for the RTSP
  187.  *  state machine to dispatch events.
  188.  */
  189. class RTSPUnknownMessage: public RTSPRequestMessage
  190. {
  191. public:
  192.     RTSPMessage::Tag tag() const { return RTSPMessage::T_UNKNOWN; }
  193.     RTSPMethod GetMethod() const { return RTSP_UNKNOWN; }
  194.     const char* tagStr() const { return "UNKNOWN"; }
  195. };
  196. class RTSPSetupMessage: public RTSPRequestMessage
  197. {
  198. public:
  199.     RTSPMessage::Tag tag() const { return RTSPMessage::T_SETUP; }
  200.     RTSPMethod GetMethod() const { return RTSP_SETUP; }
  201.     const char* tagStr() const { return "SETUP"; }
  202. };
  203. class RTSPRedirectMessage: public RTSPRequestMessage
  204. {
  205. public:
  206.     RTSPMessage::Tag tag() const { return RTSPMessage::T_REDIRECT; }
  207.     RTSPMethod GetMethod() const { return RTSP_REDIRECT; }
  208.     const char* tagStr() const { return "REDIRECT"; }
  209. };
  210. class RTSPPlayMessage: public RTSPRequestMessage
  211. {
  212. public:
  213.     RTSPMessage::Tag tag() const { return RTSPMessage::T_PLAY; }
  214.     RTSPMethod GetMethod() const { return RTSP_PLAY; }
  215.     const char* tagStr() const { return "PLAY"; }
  216. };
  217. class RTSPPauseMessage: public RTSPRequestMessage
  218. {
  219. public:
  220.     RTSPMessage::Tag tag() const { return RTSPMessage::T_PAUSE; }
  221.     RTSPMethod GetMethod() const { return RTSP_PAUSE; }
  222.     const char* tagStr() const { return "PAUSE"; }
  223. };
  224. class RTSPSetParamMessage: public RTSPRequestMessage
  225. {
  226. public:
  227.     RTSPMessage::Tag tag() const { return RTSPMessage::T_SET_PARAM; }
  228.     RTSPMethod GetMethod() const { return RTSP_SET_PARAM; }
  229.     const char* tagStr() const { return "SET_PARAMETER"; }
  230. };
  231. class RTSPGetParamMessage: public RTSPRequestMessage
  232. {
  233. public:
  234.     RTSPMessage::Tag tag() const { return RTSPMessage::T_GET_PARAM; }
  235.     RTSPMethod GetMethod() const { return RTSP_GET_PARAM; }
  236.     const char* tagStr() const { return "GET_PARAMETER"; }
  237. };
  238. class RTSPTeardownMessage: public RTSPRequestMessage
  239. {
  240. public:
  241.     RTSPMessage::Tag tag() const { return RTSPMessage::T_TEARDOWN; }
  242.     RTSPMethod GetMethod() const { return RTSP_TEARDOWN; }
  243.     const char* tagStr() const { return "TEARDOWN"; }
  244. };
  245. class RTSPOptionsMessage: public RTSPRequestMessage
  246. {
  247. public:
  248.     RTSPMessage::Tag tag() const { return RTSPMessage::T_OPTIONS; }
  249.     RTSPMethod GetMethod() const { return RTSP_OPTIONS; }
  250.     const char* tagStr() const { return "OPTIONS"; }
  251. };
  252. class RTSPDescribeMessage: public RTSPRequestMessage
  253. {
  254. public:
  255.     RTSPMessage::Tag tag() const { return RTSPMessage::T_DESCRIBE; }
  256.     RTSPMethod GetMethod() const { return RTSP_DESCRIBE; }
  257.     const char* tagStr() const { return "DESCRIBE"; }
  258. };
  259. class RTSPRecordMessage: public RTSPRequestMessage
  260. {
  261. public:
  262.     RTSPMessage::Tag tag() const { return RTSPMessage::T_RECORD; }
  263.     RTSPMethod GetMethod() const { return RTSP_RECORD; }
  264.     const char* tagStr() const { return "RECORD"; }
  265. };
  266. class RTSPAnnounceMessage: public RTSPRequestMessage
  267. {
  268. public:
  269.     RTSPMessage::Tag tag() const { return RTSPMessage::T_ANNOUNCE; }
  270.     RTSPMethod GetMethod() const { return RTSP_ANNOUNCE; }
  271.     const char* tagStr() const { return "ANNOUNCE"; }
  272. };
  273. #endif /* _RTSPMSG_H_ */