开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 多媒体 > IP电话/视频会议 > 查看源码
h245sig.h
资源名称：h323.zip　[点击查看]
上传用户：hnnddl
上传日期：2007-01-06
资源大小：3580k
文件大小：14k
源码类别：

IP电话/视频会议

开发平台：

WINDOWS

h245sig.h：源码内容
  1. /*
  2.  * $Revision: 1.6 $
  3.  * $Date: 1998/10/14 22:49:54 $
  4.  */
  6. ////////////////////////////////////////////////////////////////
  7. //               Copyright (c) 1996,97 Lucent Technologies    //
  8. //                       All Rights Reserved                  //
  9. //                                                            //
  10. //                       THIS IS UNPUBLISHED                  //
  11. //                       PROPRIETARY SOURCE                   //
  12. //                   CODE OF Lucent Technologies              //
  13. // AND elemedia
  14. //                                                            //
  15. //           The copyright notice above does not evidence any //
  16. //          actual or intended publication of such source code//
  17. ////////////////////////////////////////////////////////////////
  18. //
  19. /////////////////////////////////////////////////////////////////
  20. // File : h245sig.h    //
  21. //                                                             //
  22. // Description: The H245 control signalling protocol.    //
  23. //    //
  24. //    //
  25. // 10_Mar_1997 Created    //
  26. // 03_Apr_1997 Connection Manager changes..    //
  27. // 08_May_1997 Profile 1B changes    //
  28. // 20_May_1997 added conference request and response functions //
  29. // 10_Dec_1997 Destructor made virtual    //
  30. // 01_Oct_1997 Support for fallback procedures from faststart  //
  31. //    InheritLC        //
  32. //    GetOutLCDataType,GetInLCDataType(overloaded)    //
  33. //    GetInLCParams,GetOutLCParams(overloaded)    //
  34. //    GetRemoteMuxCap,GetMuxCap(overloaded)    //
  35. //    //
  36. /////////////////////////////////////////////////////////////////
  38. #if !defined(__H245SIG_H__)
  40. #define __H245SIG_H__
  42. #include "util/platform.h"
  43. #include "api/h245sigerr.h"
  44. #include "api/h245types.h"
  45. #include "api/h245caps.h"
  46. #include "api/h245ind.h"
  47. #include "api/h245cmd.h"
  48. #include "api/h245rr.h"
  49. #include "api/connmgr.h"
  51. class H245Client;
  52. class H245Engine;
  53. class Logger;
  55. class DLLEXPORT H245Protocol : public ConnectionEntity
  56. {
  57. public:
  59. // terminal_type is from the set H245SigTerminalType
  61. H245Protocol(int identifier, int terminal_type, 
  62. ProtReturnCode& returnCode);
  64. virtual ~H245Protocol();
  66. /////////////////////////////////////////////////////////////////////////
  67. /// H245 Commands and Indications
  68. /////////////////////////////////////////////////////////////////////////
  71. // Used to send a command to the remote end.
  72. // Note: If an EndSession command is specified, then all open 
  73. //  logical channels will be closed. No further API calls
  74. //  can be made following a call to send an EndSession command.
  76. ProtReturnCode SendCommand(H245SigCommand &command);
  78. // Used to send an indication to the remote end.
  80. ProtReturnCode SendIndication(H245SigIndication &indication);
  82. /////////////////////////////////////////////////////////////////////////
  83. /// H245 Master slave determination functions.
  84. /////////////////////////////////////////////////////////////////////////
  86. // Invoked to initiate outgoing master-slave determination procedure.
  88. ProtReturnCode DetermineMS();
  90. /////////////////////////////////////////////////////////////////////////
  91. /// H245 Terminal capabilities functions.
  92. /////////////////////////////////////////////////////////////////////////
  94. // Method to send the terminal capability set. Called at the end
  95. // of master slave determination (success) notification.
  97. ProtReturnCode SendTermCaps(H245SigMuxCap* mux_cap,
  98. H245SigCapTable* cap_table,
  99. H245SigCapDescs* cap_descriptors);
  101. // Called by the user to ack the remote ends terminal capabilitity set.
  103. ProtReturnCode AckTermCaps(void);
  105. // Called by the user to reject the remote ends terminal capability set.
  106. // cause indicates the reason for rejecting the remote termcap set and 
  107. // it is one from the set H245SigCapRejectReason.
  108. // exceeded_type specified if the terminal capability set was processed or 
  109. // not before rejecting it.  Valid only if cause is set to 
  110. // CRR_TABLE_ENTRY_CAPACITY_EXCEEDED
  111. // max_entry indicates the sequence number of the capability table entry 
  112. // number for which this negative acknowledgement was generated. Valid
  113. // only if exceeded_type is TRUE
  115. ProtReturnCode RejectTermCaps(
  116. int cause,
  117. boolean exceeded_type,
  118.      int max_entry);
  120. /////////////////////////////////////////////////////////////////////////
  121. /// H245 Open Logical Channel Functions.
  122. /////////////////////////////////////////////////////////////////////////
  124. // Open a Logical Channel for the specified data type.
  126. // forward_lc_num indicates the number to be associated with the LC
  127. // port_number is an user to user parameter.
  128. // data_type describes the type of media to be transferred on the LC.
  129. // lc_mux_params describes the transport related parameters for the LC.
  131. ProtReturnCode OpenLC(int forward_lc_num,
  132. unsigned short port_number,
  133. H245SigDataType& data_type,
  134. H245SigMuxParams& lc_mux_params);
  136. // Reject a open channel request made by the remote end
  138. // lc_num indicates the (remote end's) logical channel number which is 
  139. // being rejected.
  140. // reason indicates the reason for rejection and it is one from the set
  141. // H245SigOLCRejectReason
  143. ProtReturnCode RejectOpenLCReq(int lc_num, int reason);
  145. // Ack a open channel request made by the peer
  146. // lc_num indicates the (remote end's) logical channel number which is 
  147. // being acknowledged.
  148. // lc_ack_params specifies the transport parameters for the acknowledged LC.
  149. // lc_ack_params need to be set only for H.225 (H.222, H.223 and V.76 don't
  150. // need it)
  152. ProtReturnCode AckOpenLCReq(int lc_num,
  153. H245SigH225AckParams *h225_lc_ack_params = NULL);
  155. // Inherit a logical channel created using the fast start mechanism
  156. // defined in H.323. Note that InheritLC will return a failure if 
  157. // the procedure is attempted before the masterslave determination
  158. // completes. direction specifies the Q.931 call direction.
  159. // Values of Q931CallDir are defined in q931_event.h
  160. // DIR_OUTGOING = 0, DIR_INCOMING = 1
  162. ProtReturnCode InheritLC(H245SigOpenLogicalChannel &olcInfo, int direction);
  164. /////////////////////////////////////////////////////////////////////////
  165. /// H245 Close Logical Channel Functions.
  166. /////////////////////////////////////////////////////////////////////////
  168. // Close a logical channel opened by this end.
  170. // lc_num indicates the forward logical number that is being closed.
  172. ProtReturnCode CloseOutLC(int lc_num);
  174. // Request to close a logical channel created by the other end..
  176. // lc_num indicates the logical number whose closure is being requested.
  178. ProtReturnCode CloseInLC(int lc_num);
  180. // Ack a close channel request made by the remote end for closing a 
  181. // channel opened by this end.
  183. // lc_num indicates the logical number whose closure was requested.
  185. ProtReturnCode AckCloseOutLCReq(int lc_num);
  187. // Reject a close channel request, for a logical channel opened by this end.
  189. ProtReturnCode RejectCloseOutLCReq(int lc_num);
  191. /////////////////////////////////////////////////////////////////////////
  192. /// Other requests and response messages
  193. /////////////////////////////////////////////////////////////////////////
  195. // Use the following to send conference request and conference response
  196. // messages.
  198. ProtReturnCode SendConfRequest(H245SigConfRequest &conference_req);
  199. ProtReturnCode SendConfResponse(H245SigConfResponse &conference_resp);
  201. /////////////////////////////////////////////////////////////////////////
  202. /// Query functions.
  203. /////////////////////////////////////////////////////////////////////////
  205. // Returns the remote capabilities
  207. ProtReturnCode GetRemoteMuxCapType(int& type);
  208. ProtReturnCode GetRemoteMuxCap(H245SigMuxCap& mux_cap);
  209. ProtReturnCode GetRemoteCapTable(H245SigCapTable& cap_table);
  210. ProtReturnCode GetRemoteCapDescs(H245SigCapDescs& cap_descriptors);
  212. // Return local capabilities.
  213. ProtReturnCode GetMuxCapType(int& type);
  214. ProtReturnCode GetMuxCap(H245SigMuxCap& mux_cap);
  215. ProtReturnCode GetCapTable(H245SigCapTable& cap_table);
  216. ProtReturnCode GetCapDescs(H245SigCapDescs& cap_descriptors);
  218. // Query the data type for a logical channel
  220. ProtReturnCode GetTypeOfInLCDataType(int lc_num, int &type);
  221. ProtReturnCode GetInLCDataType(int lc_num, H245SigDataType& data_type);
  223. ProtReturnCode GetTypeOfOutLCDataType(int lc_num, int &type);
  224. ProtReturnCode GetOutLCDataType(int lc_num, H245SigDataType& dataType);
  226. // Query the logical channel parameters for the logical channel.
  228. ProtReturnCode GetTypeOfInLCParams(int lc_num, int& type);
  229. ProtReturnCode GetInLCParams(int lc_num, H245SigMuxParams& lc_params);
  231. ProtReturnCode GetTypeOfOutLCParams(int lc_num, int& type);
  232. ProtReturnCode GetOutLCParams(int lc_num, H245SigMuxParams& lc_params);
  234. /////////////////////////////////////////////////////////////////////////
  235. // Command and Indication message notifications.
  236. /////////////////////////////////////////////////////////////////////////
  238. // An indication has arrived from the remote endpoint or the MC.
  240. virtual void NotifyIndication(H245SigIndication &indication) = 0;
  242. // A command has been sent by the remote endpoint or the MC.
  244. virtual void NotifyCommand(H245SigCommand &command) = 0;
  246. /////////////////////////////////////////////////////////////////////////
  247. // Master Slave Determination notifications.
  248. /////////////////////////////////////////////////////////////////////////
  250. // Notify user of an error in the master-slave determination procedure. 
  251. // error specifies the reason for the error and is one from the set
  252. // H245SigMSDError
  254. virtual void NotifyMSDError(int error) = 0;
  256. // Notifies the user that master-slave determination completed
  257. // successfully. The decision value indicates master or slave and
  258. // is one from the set H245SigMSDResult.
  260. virtual void NotifyMSDConfirm(int decision) = 0;
  262. /////////////////////////////////////////////////////////////////////////
  263. // Terminal capabilities exchange notifications.
  264. /////////////////////////////////////////////////////////////////////////
  266. // Remote end has sent its capabilities.
  268. virtual void NotifyRemoteTermCaps(
  269. H245SigMuxCap  *mux_cap,
  270. H245SigCapTable *cap_table,
  271. H245SigCapDescs *cap_descriptors) = 0;
  273. // Remote end has ack'ed SendTermCaps call.
  275. virtual void NotifyTermCapsAck() = 0;
  277. // Remote end has rejected SendTermCaps call.
  278. // cause specifies the reason for rejection and is one from the set
  279. // H245SigCapRejectReason . If cause is set to 
  280. // CRR_TABLE_ENTRY_CAPACITY_EXCEEDED then exceed_type indicates whether
  281. // the cap table was processed or not before rejecting. If exceed_type
  282. // is set to TRUE, then max_entry denotes the last entry in cap table
  283. // that was processed before the remote end rejected the capabilities.
  284. // direction specifies the signalling entity that notifies the 
  285. // rejection. If direction is CESE_OUTGOING it indicates the remote
  286. // end rejected the capability set sent earlier. If direction is
  287. // CESE_INCOMING it indicates that the remote end reset its capabilites
  288. // sent earlier because it did not recieve an ack from us on time.
  290. virtual void NotifyTermCapsReject(int cause, boolean exceed_type, 
  291. int max_entry, int direction) = 0;
  293. /////////////////////////////////////////////////////////////////////////
  294. // Logical Channel signalling notifications.
  295. /////////////////////////////////////////////////////////////////////////
  297. // Notifies of an Error during logical channel signalling.
  298. // error_code is one from the set  of H245SigLCSError
  300. virtual void NotifyOutLCError(int lc_num, int errorCode) = 0;
  302. virtual void NotifyInLCError(int lc_num, int error_code) = 0;
  304. /////////////////////////////////////////////////////////////////////////
  305. /// H245 Open Logical Channel Notifications.
  306. /////////////////////////////////////////////////////////////////////////
  308. // Called upon receipt of OpenLogicalChannel Request from the remote end.
  310. virtual void NotifyOpenLCReq(
  311. int lc_num,
  312. unsigned short port_number,
  313. H245SigDataType& data_type,
  314. H245SigMuxParams& lc_mux_params) = 0;
  316. // Callback to notify that the remote end has rejected the OpenLC call.
  317. // reason indicates cause for rejection and is one from the set
  318. // H245SigOpenLCRejectType
  320. virtual void NotifyOpenLCReject(int lc_num, int reason) = 0;
  322. // Callback for notifying that the remote end has ack'ed the OpenLC call.
  323. // Note that h225_lc_ack_params will be NULL for the non H.225 cases.
  325. virtual void NotifyOpenLCAck(int lc_num,
  326. H245SigH225AckParams *h225_lc_ack_params) = 0;
  328. /////////////////////////////////////////////////////////////////////////
  329. /// H245 Close Logical Channel Notifications.
  330. /////////////////////////////////////////////////////////////////////////
  332. // Remote endpoint has made a request to close a logical channel
  333. // opened by this end.
  335. virtual void NotifyCloseOutLCReq(int lc_num) = 0;
  337. // Remote end has ack'ed a CloseOutLC call.
  339. virtual void NotifyCloseOutLCAck(int lc_num) = 0;
  341. // Remote end has indicated a closure of  a logical channel which it 
  342. // opened earlier.
  343. // The user does not have to ACK or NAK.
  345. virtual void NotifyCloseInLC(int lc_num) = 0;
  347. // Remote end has ack'ed an earlier CloseInLC call.
  349. virtual void NotifyCloseInLCAck(int lc_num) = 0;
  351. // Remote end has rejected an earlier CloseInLC call.
  353. virtual void NotifyCloseInLCReject(int lc_num) = 0;
  355. /////////////////////////////////////////////////////////////////////////
  356. /// Other requests and response message notifications
  357. /////////////////////////////////////////////////////////////////////////
  359. // Notification of a conference request from the remote end
  360. // or a response to a request sent out previously.
  362. virtual void NotifyConfRequest(H245SigConfRequest &conference_req) = 0;
  364. virtual void NotifyConfResponse(H245SigConfResponse &conference_resp) = 0;
  366. /////////////////////////////////////////////////////////////////////////
  367. /// Begin private section, End of API specification
  368. /////////////////////////////////////////////////////////////////////////
  370. private:
  371. friend class H245Client;
  374. H245Client *client;
  375. H245Engine *eng;
  376. Logger *_logger;
  377. };
  379. extern DLLEXPORT const char * H245SigGetVersionString();
  380. extern DLLEXPORT unsigned long H245SigGetVersionNumber();
  383. #endif // __H245SIG_H__