/usr/include/openh323/h323ep.h is in libh323plus-dev 1.24.0~dfsg2-1ubuntu1.
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 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 | /*
* h323ep.h
*
* H.323 protocol handler
*
* Open H323 Library
*
* Copyright (c) 1998-2001 Equivalence Pty. Ltd.
*
* 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 H323 Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Portions of this code were written with the assisance of funding from
* Vovida Networks, Inc. http://www.vovida.com.
*
* Contributor(s): ______________________________________.
*
* $Id: h323ep.h,v 1.41 2011/10/28 14:46:38 shorne Exp $
*
*/
#ifndef __OPAL_H323EP_H
#define __OPAL_H323EP_H
#include "h323.h"
#include "h323con.h"
#ifdef P_USE_PRAGMA
#pragma interface
#endif
// Add Feature Support
#ifdef H323_H460
#include "h460/h4601.h"
#endif
// Add NAT Method Support
#ifdef P_STUN
#include <ptclib/pnat.h>
class PSTUNClient;
#endif
class PHandleAggregator;
/* The following classes have forward references to avoid including the VERY
large header files for H225 and H245. If an application requires access
to the protocol classes they can include them, but for simple usage their
inclusion can be avoided.
*/
class H225_EndpointType;
class H225_ArrayOf_SupportedProtocols;
class H225_VendorIdentifier;
class H225_H221NonStandard;
class H225_ServiceControlDescriptor;
class H225_ArrayOf_AliasAddress;
class H323SignalPDU;
class H323ConnectionsCleaner;
class H323ServiceControlSession;
#if H323_H224
class OpalH224Handler;
class OpalH281Handler;
#endif
#ifdef H323_T120
class OpalT120Protocol;
#endif
#ifdef H323_T38
class OpalT38Protocol;
#endif
#ifdef H323_H460P
class H460PresenceHandler;
#endif
#ifdef H323_GNUGK
class GNUGK_Feature;
#endif
#ifdef H323_FILE
class H323FileTransferHandler;
class H323FileTransferList;
#endif
///////////////////////////////////////////////////////////////////////////////
/**This class manages the H323 endpoint.
An endpoint may have zero or more listeners to create incoming connections
or zero or more outgoing conenctions initiated via the MakeCall() function.
Once a conection exists it is managed by this class instance.
The main thing this class embodies is the capabilities of the application,
that is the codecs and protocols it is capable of.
An application may create a descendent off this class and overide the
CreateConnection() function, if they require a descendent of H323Connection
to be created. This would be quite likely in most applications.
*/
class H323EndPoint : public PObject
{
PCLASSINFO(H323EndPoint, PObject);
public:
enum {
DefaultTcpPort = 1720
};
/**@name Construction */
//@{
/**Create a new endpoint.
*/
H323EndPoint();
/**Destroy endpoint.
*/
~H323EndPoint();
/**Set the endpoint information in H225 PDU's.
*/
virtual void SetEndpointTypeInfo(
H225_EndpointType & info
) const;
/**Set the vendor information in H225 PDU's.
*/
virtual void SetVendorIdentifierInfo(
H225_VendorIdentifier & info
) const;
/**Set the Gateway supported protocol default always H.323
*/
PBoolean SetGatewaySupportedProtocol(
H225_ArrayOf_SupportedProtocols & protocols
) const;
/**Set the gateway prefixes
Override this to set the acceptable prefixes to the gatekeeper
*/
virtual PBoolean OnSetGatewayPrefixes(
PStringList & prefixes
) const;
/**Set the H221NonStandard information in H225 PDU's.
*/
virtual void SetH221NonStandardInfo(
H225_H221NonStandard & info
) const;
//@}
/**@name Capabilities */
//@{
/**Add a codec to the capabilities table. This will assure that the
assignedCapabilityNumber field in the codec is unique for all codecs
installed on this endpoint.
If the specific instnace of the capability is already in the table, it
is not added again. Ther can be multiple instances of the same
capability class however.
*/
void AddCapability(
H323Capability * capability ///< New codec specification
);
/**Set the capability descriptor lists. This is three tier set of
codecs. The top most level is a list of particular capabilities. Each
of these consists of a list of alternatives that can operate
simultaneously. The lowest level is a list of codecs that cannot
operate together. See H323 section 6.2.8.1 and H245 section 7.2 for
details.
If descriptorNum is P_MAX_INDEX, the the next available index in the
array of descriptors is used. Similarly if simultaneous is P_MAX_INDEX
the the next available SimultaneousCapabilitySet is used. The return
value is the index used for the new entry. Note if both are P_MAX_INDEX
then the return value is the descriptor index as the simultaneous index
must be zero.
Note that the capability specified here is automatically added to the
capability table using the AddCapability() function. A specific
instance of a capability is only ever added once, so multiple
SetCapability() calls with the same H323Capability pointer will only
add that capability once.
*/
PINDEX SetCapability(
PINDEX descriptorNum, ///< The member of the capabilityDescriptor to add
PINDEX simultaneous, ///< The member of the SimultaneousCapabilitySet to add
H323Capability * cap ///< New capability specification
);
/**Manually remove capability type. This removes the specified Capability type out of the
default capability list.
*/
PBoolean RemoveCapability(
H323Capability::MainTypes capabilityType ///< capability type
);
#ifdef H323_VIDEO
/**Set the Video Frame Size. This is used for capabilities
that use 1 definition for all Video Frame Sizes. This will remove all capabilities
not matching the specified Frame Size and send a message to the remaining video capabilities
to set the maximum framesize allowed to the specified value
*/
PBoolean SetVideoFrameSize(H323Capability::CapabilityFrameSize frameSize,
int frameUnits = 1
);
/**Set the Video Encoder size and rate.
This is used for generic Video Capabilities to set the appropriate level for a given encoder
frame size and rate.
*/
PBoolean SetVideoEncoder(unsigned frameWidth, unsigned frameHeight, unsigned frameRate);
#endif
/**Add all matching capabilities in list.
All capabilities that match the specified name are added. See the
capabilities code for details on the matching algorithm.
*/
PINDEX AddAllCapabilities(
PINDEX descriptorNum, ///< The member of the capabilityDescriptor to add
PINDEX simultaneous, ///< The member of the SimultaneousCapabilitySet to add
const PString & name ///< New capabilities name, if using "known" one.
);
/**Add all user input capabilities to this endpoints capability table.
*/
void AddAllUserInputCapabilities(
PINDEX descriptorNum, ///< The member of the capabilityDescriptor to add
PINDEX simultaneous ///< The member of the SimultaneousCapabilitySet to add
);
#ifdef H323_VIDEO
#ifdef H323_H239
/** Open Extended Video Session
*/
PBoolean OpenExtendedVideoSession(
const PString & token ///< Connection Token
);
/** Open Extended Video Session
*/
PBoolean OpenExtendedVideoSession(
const PString & token, ///< Connection Token
H323ChannelNumber & num ///< Opened Channel number
);
PBoolean CloseExtendedVideoSession(
const PString & token ///< Connection Token
);
PBoolean CloseExtendedVideoSession(
const PString & token, ///< Connection Token
const H323ChannelNumber & num ///< channel number
);
/**Add all Extended Video capabilities to this endpoints capability table.
*/
void AddAllExtendedVideoCapabilities(
PINDEX descriptorNum, ///< The member of the capabilityDescriptor to add
PINDEX simultaneous ///< The member of the SimultaneousCapabilitySet to add
);
#endif
#endif
/**Remove capabilites in table.
*/
void RemoveCapabilities(
const PStringArray & codecNames
);
/**Reorder capabilites in table.
*/
void ReorderCapabilities(
const PStringArray & preferenceOrder
);
/**Find a capability that has been registered.
*/
H323Capability * FindCapability(
const H245_Capability & cap ///< H245 capability table entry
) const;
/**Find a capability that has been registered.
*/
H323Capability * FindCapability(
const H245_DataType & dataType ///< H245 data type of codec
) const;
/**Find a capability that has been registered.
*/
H323Capability * FindCapability(
H323Capability::MainTypes mainType, ///< Main type of codec
unsigned subType ///< Subtype of codec
) const;
//@}
/**@name Gatekeeper management */
//@{
/**Use and register with an explicit gatekeeper.
This will call other functions according to the following table:
address identifier function
empty empty DiscoverGatekeeper()
non-empty empty SetGatekeeper()
empty non-empty LocateGatekeeper()
non-empty non-empty SetGatekeeperZone()
The localAddress field, if non-empty, indicates the interface on which
to look for the gatekeeper. An empty string is equivalent to "ip$*:*"
which is any interface or port.
If the endpoint is already registered with a gatekeeper that meets
the same criteria then the gatekeeper is not changed, otherwise it is
deleted (with unregistration) and new one created and registered to.
*/
PBoolean UseGatekeeper(
const PString & address = PString::Empty(), ///< Address of gatekeeper to use.
const PString & identifier = PString::Empty(), ///< Identifier of gatekeeper to use.
const PString & localAddress = PString::Empty() ///< Local interface to use.
);
/**Select and register with an explicit gatekeeper.
This will use the specified transport and a string giving a transport
dependent address to locate a specific gatekeeper. The endpoint will
register with that gatekeeper and, if successful, set it as the current
gatekeeper used by this endpoint.
Note the transport being passed in will be deleted by this function or
the H323Gatekeeper object it becomes associated with. Also if transport
is NULL then a H323TransportUDP is created.
*/
PBoolean SetGatekeeper(
const PString & address, ///< Address of gatekeeper to use.
H323Transport * transport = NULL ///< Transport over which to talk to gatekeeper.
);
/**Select and register with an explicit gatekeeper and zone.
This will use the specified transport and a string giving a transport
dependent address to locate a specific gatekeeper. The endpoint will
register with that gatekeeper and, if successful, set it as the current
gatekeeper used by this endpoint.
The gatekeeper identifier is set to the spplied parameter to allow the
gatekeeper to either allocate a zone or sub-zone, or refuse to register
if the zones do not match.
Note the transport being passed in will be deleted by this function or
the H323Gatekeeper object it becomes associated with. Also if transport
is NULL then a H323TransportUDP is created.
*/
PBoolean SetGatekeeperZone(
const PString & address, ///< Address of gatekeeper to use.
const PString & identifier, ///< Identifier of gatekeeper to use.
H323Transport * transport = NULL ///< Transport over which to talk to gatekeeper.
);
/**Locate and select gatekeeper.
This function will use the automatic gatekeeper discovery methods to
locate the gatekeeper on the particular transport that has the specified
gatekeeper identifier name. This is often the "Zone" for the gatekeeper.
Note the transport being passed in will be deleted becomes owned by the
H323Gatekeeper created by this function and will be deleted by it. Also
if transport is NULL then a H323TransportUDP is created.
*/
PBoolean LocateGatekeeper(
const PString & identifier, ///< Identifier of gatekeeper to locate.
H323Transport * transport = NULL ///< Transport over which to talk to gatekeeper.
);
/**Discover and select gatekeeper.
This function will use the automatic gatekeeper discovery methods to
locate the first gatekeeper on a particular transport.
Note the transport being passed in will be deleted becomes owned by the
H323Gatekeeper created by this function and will be deleted by it. Also
if transport is NULL then a H323TransportUDP is created.
*/
PBoolean DiscoverGatekeeper(
H323Transport * transport = NULL ///< Transport over which to talk to gatekeeper.
);
/**Create a gatekeeper.
This allows the application writer to have the gatekeeper as a
descendent of the H323Gatekeeper in order to add functionality to the
base capabilities in the library.
The default creates an instance of the H323Gatekeeper class.
*/
virtual H323Gatekeeper * CreateGatekeeper(
H323Transport * transport ///< Transport over which gatekeepers communicates.
);
/**Get the gatekeeper we are registered with.
*/
H323Gatekeeper * GetGatekeeper() const { return gatekeeper; }
/**Return if endpoint is registered with gatekeeper.
*/
PBoolean IsRegisteredWithGatekeeper() const;
/**Unregister and delete the gatekeeper we are registered with.
The return value indicates FALSE if there was an error during the
unregistration. However the gatekeeper is still removed and its
instance deleted regardless of this error.
*/
PBoolean RemoveGatekeeper(
int reason = -1 ///< Reason for gatekeeper removal
);
/**Force the endpoint to reregister with Gatekeeper
*/
void ForceGatekeeperReRegistration();
/**Set the H.235 password for the gatekeeper.
*/
virtual void SetGatekeeperPassword(
const PString & password
);
/**Get the H.235 password for the gatekeeper.
*/
virtual const PString & GetGatekeeperPassword() const { return gatekeeperPassword; }
/** Check the IP of the Gatekeeper on reregistration
Use this to check if Gatekeeper IP had changed (used for DDNS type registrations)
Default returns FALSE
*/
virtual PBoolean GatekeeperCheckIP(const H323TransportAddress & oldAddr,H323TransportAddress & newaddress);
/**Create a list of authenticators for gatekeeper.
*/
virtual H235Authenticators CreateAuthenticators();
/**Called when sending a Admission Request to the gatekeeper
*/
virtual void OnAdmissionRequest(H323Connection & connection);
/**Called when the gatekeeper sends a GatekeeperConfirm
*/
virtual void OnGatekeeperConfirm();
/**Called when the gatekeeper sends a GatekeeperReject
*/
virtual void OnGatekeeperReject();
/**Called when the gatekeeper sends a RegistrationConfirm
*/
virtual void OnRegistrationConfirm(const H323TransportAddress & rasAddress);
/**Called when the gatekeeper sends a RegistrationReject
*/
virtual void OnRegistrationReject();
/**Called when Unregistered by Gatekeeper
*/
virtual void OnUnRegisterRequest();
/**Called when reply Unregister to Gatekeeper
*/
virtual void OnUnRegisterConfirm();
/**Called when TTL registration fails
*/
virtual void OnRegisterTTLFail();
//@}
/**@name Connection management */
//@{
/**Add a listener to the endpoint.
This allows for the automatic creating of incoming call connections. An
application should use OnConnectionEstablished() to monitor when calls
have arrived and been successfully negotiated.
Note if this returns TRUE, then the endpoint is responsible for
deleting the H323Listener listener object. If FALSE is returned then
the object is not deleted and it is up to the caller to release the
memory allocated for the object.
If a listener already exists on the same transport address then it is
ignored, but TRUE is still returned. The caller does not need to delete
the object.
*/
PBoolean StartListener(
H323Listener * listener ///< Transport dependent listener.
);
/**Add a listener to the endpoint.
This allows for the automatic creating of incoming call connections. An
application should use OnConnectionEstablished() to monitor when calls
have arrived and been successfully negotiated.
If a listener already exists on the same address then it is ignored,
but TRUE is still returned.
If the iface string is empty then "*" is assumed which will listen on
the standard TCP port on INADDR_ANY.
*/
PBoolean StartListener(
const H323TransportAddress & iface ///< Address of interface to listen on.
);
/**Add listeners to the endpoint.
Set the collection of listeners which will allow the automatic
creating of incoming call connections. An application should use
OnConnectionEstablished() to monitor when calls have arrived and been
successfully negotiated.
If a listener already exists on the interface specified in the list
then it is ignored. If a listener does not yet exist a new one is
created and if a listener is running that is not in the list then it
is stopped and removed.
If the array is empty then the string "*" is assumed which will listen
on the standard TCP port on INADDR_ANY.
Returns TRUE if at least one interface was successfully started.
*/
PBoolean StartListeners(
const H323TransportAddressArray & ifaces ///< Interfaces to listen on.
);
/**Remove a listener from the endpoint.
If the listener parameter is NULL then all listeners are removed.
*/
PBoolean RemoveListener(
H323Listener * listener ///< Transport dependent listener.
);
/**Return a list of the transport addresses for all listeners on this endpoint
*/
H323TransportAddressArray GetInterfaceAddresses(
PBoolean excludeLocalHost = TRUE, ///< Flag to exclude 127.0.0.1
H323Transport * associatedTransport = NULL
///< Associated transport for precedence and translation
);
#ifndef DISABLE_CALLAUTH
/**Make a Authenticated call to a remote party.
This Function sets Security Information to be included when calling
a EP which requires Authentication
*/
H323Connection * MakeAuthenticatedCall (
const PString & remoteParty, ///* Remote party to call
const PString & UserName, ///* UserName to Use (Default is LocalPartyName)
const PString & Password, ///* Password to Use (MUST NOT BE EMPTY)
PString & token, ///* String to receive token for connection
void * userData = NULL ///* user data to pass to CreateConnection
);
#endif
/**Make a Supplimentary call to a remote party.
This Function makes a Non Call supplimentary connection (lightweight call) for the purpose
of delivering H.450 & H.460 non call content such as instant messaging and messagebank messages
*/
H323Connection * MakeSupplimentaryCall (
const PString & remoteParty, ///* Remote party to call
PString & token, ///* String to receive token for connection
void * userData = NULL ///* user data to pass to CreateConnection
);
/**Make a call to a remote party. An appropriate transport is determined
from the remoteParty parameter. The general form for this parameter is
[alias@][transport$]host[:port] where the default alias is the same as
the host, the default transport is "ip" and the default port is 1720.
This function returns almost immediately with the call occurring in a
new background thread. Note that the call could be created and cleared
ie OnConnectionCleared is called BEFORE this function returns. It is
guaranteed that the token variable is set before OnConnectionCleared
called.
Note, the returned pointer to the connection is not locked and may be
deleted at any time. This is extremely unlikely immediately after the
function is called, but you should not keep this pointer beyond that
brief time. The the FindConnectionWithLock() function for future
references to the connection object. It is recommended that
MakeCallLocked() be usedin instead.
*/
H323Connection * MakeCall(
const PString & remoteParty, ///< Remote party to call
PString & token, ///< String to receive token for connection
void * userData = NULL, ///< user data to pass to CreateConnection
PBoolean supplimentary = false ///< Whether the call is a supplimentary call
);
/**Make a call to a remote party using the specified transport.
The remoteParty may be a hostname, alias or other user name that is to
be passed to the transport, if present.
If the transport parameter is NULL the transport is determined from the
remoteParty description.
This function returns almost immediately with the call occurring in a
new background thread. Note that the call could be created and cleared
ie OnConnectionCleared is called BEFORE this function returns. It is
guaranteed that the token variable is set before OnConnectionCleared
called.
Note, the returned pointer to the connection is not locked and may be
deleted at any time. This is extremely unlikely immediately after the
function is called, but you should not keep this pointer beyond that
brief time. The the FindConnectionWithLock() function for future
references to the connection object. It is recommended that
MakeCallLocked() be usedin instead.
*/
H323Connection * MakeCall(
const PString & remoteParty, ///< Remote party to call
H323Transport * transport, ///< Transport to use for call.
PString & token, ///< String to receive token for connection
void * userData = NULL, ///< user data to pass to CreateConnection
PBoolean supplimentary = false ///< Whether the call is a supplimentary call
);
/**Make a call to a remote party using the specified transport.
The remoteParty may be a hostname, alias or other user name that is to
be passed to the transport, if present.
If the transport parameter is NULL the transport is determined from the
remoteParty description.
This function returns almost immediately with the call occurring in a
new background thread. However the call will not progress very far
*/
H323Connection * MakeCallLocked(
const PString & remoteParty, ///< Remote party to call
PString & token, ///< String to receive token for connection
void * userData = NULL, ///< user data to pass to CreateConnection
H323Transport * transport = NULL ///< Transport to use for call.
);
#ifdef H323_H450
/**Setup the transfer of an existing call (connection) to a new remote party
using H.450.2. This sends a Call Transfer Setup Invoke message from the
B-Party (transferred endpoint) to the C-Party (transferred-to endpoint).
If the transport parameter is NULL the transport is determined from the
remoteParty description. The general form for this parameter is
[alias@][transport$]host[:port] where the default alias is the same as
the host, the default transport is "ip" and the default port is 1720.
This function returns almost immediately with the transfer occurring in a
new background thread.
Note, the returned pointer to the connection is not locked and may be
deleted at any time. This is extremely unlikely immediately after the
function is called, but you should not keep this pointer beyond that
brief time. The the FindConnectionWithLock() function for future
references to the connection object.
This function is declared virtual to allow an application to override
the function and get the new call token of the forwarded call.
*/
virtual H323Connection * SetupTransfer(
const PString & token, ///< Existing connection to be transferred
const PString & callIdentity, ///< Call identity of the secondary call (if it exists)
const PString & remoteParty, ///< Remote party to transfer the existing call to
PString & newToken, ///< String to receive token for the new connection
void * userData = NULL ///< user data to pass to CreateConnection
);
/**Initiate the transfer of an existing call (connection) to a new remote
party using H.450.2. This sends a Call Transfer Initiate Invoke
message from the A-Party (transferring endpoint) to the B-Party
(transferred endpoint).
*/
void TransferCall(
const PString & token, ///< Existing connection to be transferred
const PString & remoteParty, ///< Remote party to transfer the existing call to
const PString & callIdentity = PString::Empty()
///< Call Identity of secondary call if present
);
/**Transfer the call through consultation so the remote party in the
primary call is connected to the called party in the second call
using H.450.2. This sends a Call Transfer Identify Invoke message
from the A-Party (transferring endpoint) to the C-Party
(transferred-to endpoint).
*/
void ConsultationTransfer(
const PString & primaryCallToken, ///< Token of primary call
const PString & secondaryCallToken ///< Token of secondary call
);
/**Place the call on hold, suspending all media channels (H.450.4)
* NOTE: Only Local Hold is implemented so far.
*/
void HoldCall(
const PString & token, ///< Existing connection to be transferred
PBoolean localHold ///< true for Local Hold, false for Remote Hold
);
/** Initiate Call intrusion
Designed similar to MakeCall function
*/
H323Connection * IntrudeCall(
const PString & remoteParty, ///< Remote party to intrude call
PString & token, ///< String to receive token for connection
unsigned capabilityLevel, ///< Capability level
void * userData = NULL ///< user data to pass to CreateConnection
);
H323Connection * IntrudeCall(
const PString & remoteParty, ///< Remote party to intrude call
H323Transport * transport, ///< Transport to use for call.
PString & token, ///< String to receive token for connection
unsigned capabilityLevel, ///< Capability level
void * userData = NULL ///< user data to pass to CreateConnection
);
#endif // H323_H450
/** Use DNS SRV and ENUM to resolve all the possible addresses a call party
can be found. Only effective if not registered with Gatekeeper
*/
PBoolean ResolveCallParty(
const PString & _remoteParty,
PStringList & addresses
);
/**Parse a party address into alias and transport components.
An appropriate transport is determined from the remoteParty parameter.
The general form for this parameter is [alias@][transport$]host[:port]
where the default alias is the same as the host, the default transport
is "ip" and the default port is 1720.
*/
PBoolean ParsePartyName(
const PString & party, ///< Party name string.
PString & alias, ///< Parsed alias name
H323TransportAddress & address ///< Parsed transport address
);
/**Clear a current connection.
This hangs up the connection to a remote endpoint. Note that this function
is asynchronous
*/
virtual PBoolean ClearCall(
const PString & token, ///< Token for identifying connection
H323Connection::CallEndReason reason =
H323Connection::EndedByLocalUser ///< Reason for call clearing
);
/**Clearing a current connection.
A connection is being cleared callback. This can be used for PBX applications
to reallocate the line early without waiting for the cleaner thread to clean-up
the connection.
*/
virtual void OnCallClearing(H323Connection * connection, ///* Connection being Cleared
H323Connection::CallEndReason reason ///* Reason for call being cleared
);
/**Clear a current connection.
This hangs up the connection to a remote endpoint. Note that these functions
are synchronous
*/
virtual PBoolean ClearCallSynchronous(
const PString & token, ///< Token for identifying connection
H323Connection::CallEndReason reason =
H323Connection::EndedByLocalUser ///< Reason for call clearing
);
virtual PBoolean ClearCallSynchronous(
const PString & token, ///< Token for identifying connection
H323Connection::CallEndReason reason, ///< Reason for call clearing
PSyncPoint * sync
);
/**Clear all current connections.
This hangs up all the connections to remote endpoints. The wait
parameter is used to wait for all the calls to be cleared and their
memory usage cleaned up before returning. This is typically used in
the destructor for your descendant of H323EndPoint.
*/
virtual void ClearAllCalls(
H323Connection::CallEndReason reason =
H323Connection::EndedByLocalUser, ///< Reason for call clearing
PBoolean wait = TRUE ///< Flag for wait for calls to e cleared.
);
/**Determine if a connection is active.
*/
virtual PBoolean HasConnection(
const PString & token ///< Token for identifying connection
);
/**Find a connection that uses the specified token.
This searches the endpoint for the connection that contains the token
as provided by functions such as MakeCall() (as built by the
BuildConnectionToken() function). if not found it will then search for
the string representation of the CallIdentifier for the connection, and
finally try for the string representation of the ConferenceIdentifier.
Note the caller of this function MUSt call the H323Connection::Unlock()
function if this function returns a non-NULL pointer. If it does not
then a deadlock can occur.
*/
H323Connection * FindConnectionWithLock(
const PString & token ///< Token to identify connection
);
/**Get all calls current on the endpoint.
*/
PStringList GetAllConnections();
/**Call back for incoming call.
This function is called from the OnReceivedSignalSetup() function
before it sends the Alerting PDU. It gives an opportunity for an
application to alter the reply before transmission to the other
endpoint.
If FALSE is returned the connection is aborted and a Release Complete
PDU is sent.
The default behaviour simply returns TRUE.
*/
virtual PBoolean OnIncomingCall(
H323Connection & connection, ///< Connection that was established
const H323SignalPDU & setupPDU, ///< Received setup PDU
H323SignalPDU & alertingPDU ///< Alerting PDU to send
);
virtual PBoolean OnIncomingCall(
H323Connection & connection, ///< Connection that was established
const H323SignalPDU & setupPDU, ///< Received setup PDU
H323SignalPDU & alertingPDU, ///< Alerting PDU to send
H323Connection::CallEndReason & reason ///< reason for call refusal, if returned false
);
/**Handle a connection transfer.
This gives the application an opportunity to abort the transfer.
The default behaviour just returns TRUE.
*/
virtual PBoolean OnCallTransferInitiate(
H323Connection & connection, ///< Connection to transfer
const PString & remoteParty ///< Party transferring to.
);
/**Handle a transfer via consultation.
This gives the transferred-to user an opportunity to abort the transfer.
The default behaviour just returns TRUE.
*/
virtual PBoolean OnCallTransferIdentify(
H323Connection & connection ///< Connection to transfer
);
/**
* Callback for ARQ send to a gatekeeper. This allows the endpoint
* to change or check fields in the ARQ before it is sent.
*/
virtual void OnSendARQ(
H323Connection & conn,
H225_AdmissionRequest & arq
);
/**
* Callback for ACF sent back from gatekeeper.
*/
virtual void OnReceivedACF(
H323Connection & conn,
const H225_AdmissionConfirm & acf
);
/**
* Callback for ARJ sent back from gatekeeper.
*/
virtual void OnReceivedARJ(
H323Connection & conn,
const H225_AdmissionReject & arj
);
/**Call back for answering an incoming call.
This function is called from the OnReceivedSignalSetup() function
before it sends the Connect PDU. It gives an opportunity for an
application to alter the reply before transmission to the other
endpoint.
It also gives an application time to wait for some event before
signalling to the endpoint that the connection is to proceed. For
example the user pressing an "Answer call" button.
If AnswerCallDenied is returned the connection is aborted and a Release
Complete PDU is sent. If AnswerCallNow is returned then the H.323
protocol proceeds. Finally if AnswerCallPending is returned then the
protocol negotiations are paused until the AnsweringCall() function is
called.
The default behaviour simply returns AnswerNow.
*/
virtual H323Connection::AnswerCallResponse OnAnswerCall(
H323Connection & connection, ///< Connection that was established
const PString & callerName, ///< Name of caller
const H323SignalPDU & setupPDU, ///< Received setup PDU
H323SignalPDU & connectPDU ///< Connect PDU to send.
);
/**Call back for remote party being alerted.
This function is called from the SendSignalSetup() function after it
receives the optional Alerting PDU from the remote endpoint. That is
when the remote "phone" is "ringing".
If FALSE is returned the connection is aborted and a Release Complete
PDU is sent.
The default behaviour simply returns TRUE.
*/
virtual PBoolean OnAlerting(
H323Connection & connection, ///< Connection that was established
const H323SignalPDU & alertingPDU, ///< Received Alerting PDU
const PString & user ///< Username of remote endpoint
);
/**A call back function when a connection indicates it is to be forwarded.
An H323 application may handle this call back so it can make
complicated decisions on if the call forward ius to take place. If it
decides to do so it must call MakeCall() and return TRUE.
The default behaviour simply returns FALSE and that the automatic
call forwarding should take place. See ForwardConnection()
*/
virtual PBoolean OnConnectionForwarded(
H323Connection & connection, ///< Connection to be forwarded
const PString & forwardParty, ///< Remote party to forward to
const H323SignalPDU & pdu ///< Full PDU initiating forwarding
);
/**Forward the call using the same token as the specified connection.
Return TRUE if the call is being redirected.
The default behaviour will replace the current call in the endpoints
call list using the same token as the call being redirected. Not that
even though the same token is being used the actual object is
completely mad anew.
*/
virtual PBoolean ForwardConnection(
H323Connection & connection, ///< Connection to be forwarded
const PString & forwardParty, ///< Remote party to forward to
const H323SignalPDU & pdu ///< Full PDU initiating forwarding
);
/**A call back function whenever a connection is established.
This indicates that a connection to a remote endpoint was established
with a control channel and zero or more logical channels.
The default behaviour does nothing.
*/
virtual void OnConnectionEstablished(
H323Connection & connection, ///< Connection that was established
const PString & token ///< Token for identifying connection
);
/**Determine if a connection is established.
*/
virtual PBoolean IsConnectionEstablished(
const PString & token ///< Token for identifying connection
);
/**A call back function whenever a connection is broken.
This indicates that a connection to a remote endpoint is no longer
available.
The default behaviour does nothing.
*/
virtual void OnConnectionCleared(
H323Connection & connection, ///< Connection that was established
const PString & token ///< Token for identifying connection
);
/**Build a unique token for the connection.
This identifies the call using the Q931 transport host name and the
Q931 call reference number.
*/
static PString BuildConnectionToken(
const H323Transport & transport, ///< Transport for connection
unsigned callReference, ///< Call reference of Q.931 link
PBoolean fromRemote ///< Call reference is from remote endpoint
);
/**Handle a new incoming connection.
This will examine the setup PDU and either attach the signalling
transport to an existing connection that has the same Q.931 call
reference, or creates a new connection using CreateConnection().
*/
virtual H323Connection * OnIncomingConnection(
H323Transport * transport, ///< Transport for connection
H323SignalPDU & setupPDU ///< Setup PDU
);
/**Called when an outgoing call connects
If FALSE is returned the connection is aborted and a Release Complete
PDU is sent.
The default behaviour simply returns TRUE.
*/
virtual PBoolean OnOutgoingCall(
H323Connection & conn,
const H323SignalPDU & connectPDU
);
/**Create a connection that uses the specified call reference.
*/
virtual H323Connection * CreateConnection(
unsigned callReference, ///< Call reference to use
void * userData, ///< user data to pass to CreateConnection
H323Transport * transport, ///< Transport for connection
H323SignalPDU * setupPDU ///< Setup PDU, NULL if outgoing call
);
virtual H323Connection * CreateConnection(
unsigned callReference, ///< Call reference to use
void * userData ///< user data to pass to CreateConnection
);
virtual H323Connection * CreateConnection(
unsigned callReference ///< Call reference to use
);
/**Clean up connections.
This function is called from a background thread and checks for closed
connections to clean up.
This would not normally be called by an application.
*/
virtual void CleanUpConnections();
//@}
#ifndef DISABLE_CALLAUTH
/**@name Caller Authentication */
//@{
/**Create a list of authenticators for Call Authentication.
To Create a list of Autheniticators the Endpoint MUST have
set EPSecurityPassword (via SetEPCredentials()) and either
set CallAuthPolicy (via SetEPSecurityPolicy()) or set
isSecureCall to TRUE (via MakeAuthenticatedCall())
*/
virtual H235Authenticators CreateEPAuthenticators();
/** Retrieve Password and UserName for EPAuthentication
NOTE: Returns FALSE is EPSecurityPassword.IsEmpty()
*/
virtual PBoolean GetEPCredentials(PString & password, ///* Password to use for call
PString & username ///* Username to use for call
);
/** Set the Password and UserName for EPAuthentication for Connection
*/
virtual void SetEPCredentials(PString password, ///* Password to use for call
PString username ///* Username to use for call
);
enum EPSecurityPolicy
{
SecNone, ///* Default: Do Not Include Call Authenication
SecRequest, ///* Request Authentication but Accept if Missing/Fail
SecRequired ///* Calls are Rejected with EndedBySecurityDenial if Authenitication fails.
};
/** Set the EP Security Policy
*/
virtual void SetEPSecurityPolicy(EPSecurityPolicy policy);
/** Get the EP Security Policy
*/
virtual EPSecurityPolicy GetEPSecurityPolicy();
/** Retrieve the List of UserNames/Passwords to be used
to Authenticate Incoming Calls.
*/
H235AuthenticatorList GetAuthenticatorList();
/** Call Authentication Call Back
This fires for all the Authentication Methods created by
CreateEPAuthenticators() The Function Supplies the Name of
the Authentication process and the supplied SenderID (Username)
and this is then check against EPAuthList to:
1. Check if the username exists and if so
2. Return the password in the clear to validate.
Returning FALSE indicates that Authentication Failed failed for that Method..
*/
virtual PBoolean OnCallAuthentication(const PString & username, ///* UserName of Caller
PString & password ///* Password related to caller
);
//@}
#endif
/**@name Logical Channels management */
//@{
/**Call back for opening a logical channel.
The default behaviour simply returns TRUE.
*/
virtual PBoolean OnStartLogicalChannel(
H323Connection & connection, ///< Connection for the channel
H323Channel & channel ///< Channel being started
);
/**Call back for closed a logical channel.
The default behaviour does nothing.
*/
virtual void OnClosedLogicalChannel(
H323Connection & connection, ///< Connection for the channel
const H323Channel & channel ///< Channel being started
);
#ifdef H323_AUDIO_CODECS
/**Open a channel for use by an audio codec.
The H323AudioCodec class will use this function to open the channel to
read/write PCM data.
The default function creates a PSoundChannel using the member variables
soundChannelPlayDevice or soundChannelRecordDevice.
*/
virtual PBoolean OpenAudioChannel(
H323Connection & connection, ///< Connection for the channel
PBoolean isEncoding, ///< Direction of data flow
unsigned bufferSize, ///< Size of each sound buffer
H323AudioCodec & codec ///< codec that is doing the opening
);
#endif
#ifdef H323_VIDEO
/**Open a channel for use by an video codec.
The H323VideoCodec class will use this function to open the channel to
read/write image data (which is one frame in a video stream - YUV411 format).
The default function creates a PVideoChannel using the member variables.
*/
virtual PBoolean OpenVideoChannel(
H323Connection & connection, ///< Connection for the channel
PBoolean isEncoding, ///< Direction of data flow
H323VideoCodec & codec ///< codec doing the opening
);
#ifdef H323_H239
/**Open a channel for use by an application share application.
The H323VideoCodec class will use this function to open the channel to
read/write image data (which is one frame in a video stream - YUV411 format).
The default function creates a PVideoChannel using the member variables.
*/
virtual PBoolean OpenExtendedVideoChannel(
H323Connection & connection, ///< Connection for the channel
PBoolean isEncoding, ///< Direction of data flow
H323VideoCodec & codec ///< codec doing the opening
);
#endif // H323_H239
#endif // NO_H323_VIDEO
/**Callback from the RTP session for statistics monitoring.
This is called every so many packets on the transmitter and receiver
threads of the RTP session indicating that the statistics have been
updated.
The default behaviour does nothing.
*/
virtual void OnRTPStatistics(
const H323Connection & connection, ///< Connection for the channel
const RTP_Session & session ///< Session with statistics
) const;
/**Callback from the RTP session for statistics monitoring.
This is called at the end of the RTP session indicating that the statistics
of the call
The default behaviour does nothing.
*/
virtual void OnRTPFinalStatistics(
const H323Connection & connection, ///< Connection for the channel
const RTP_Session & session ///< Session with statistics
) const;
//@}
/**@name Indications */
//@{
/**Call back for remote enpoint has sent user input as a string.
The default behaviour does nothing.
*/
virtual void OnUserInputString(
H323Connection & connection, ///< Connection for the input
const PString & value ///< String value of indication
);
/**Call back for remote enpoint has sent user input.
The default behaviour calls H323Connection::OnUserInputTone().
*/
virtual void OnUserInputTone(
H323Connection & connection, ///< Connection for the input
char tone, ///< DTMF tone code
unsigned duration, ///< Duration of tone in milliseconds
unsigned logicalChannel, ///< Logical channel number for RTP sync.
unsigned rtpTimestamp ///< RTP timestamp in logical channel sync.
);
#ifdef H323_GNUGK
/**Call back from GK admission confirm to notify the Endpoint it is behind a NAT
(GNUGK Gatekeeper) The default does nothing. Override this to notify the user they are behind a NAT.
*/
virtual void OnGatekeeperNATDetect(
PIPSocket::Address publicAddr, ///< Public address as returned by the Gatekeeper
const PString & gkIdentifier, ///< Identifier at the gatekeeper
H323TransportAddress & gkRouteAddress ///< Gatekeeper Route Address
);
/**Call back from GK admission confirm to notify the Endpoint it is not detected as being NAT
(GNUGK Gatekeeper) The default does nothing. Override this to notify the user they are not NAT
so they can confirm that it is true.
*/
virtual void OnGatekeeperOpenNATDetect(
const PString & gkIdentifier, ///< Identifier at the gatekeeper
H323TransportAddress & gkRouteAddress ///< Gatekeeper Route Address
);
/** Fired with the keep-alive connection to GnuGk fails or is re-established
This allows the endpoint to re-register.
*/
virtual void NATLostConnection(PBoolean lost);
#endif
/** Call back for GK assigned aliases returned from the gatekeeper in the RCF.
The default returns FALSE which appends the new aliases to the existing alias list.
By overriding this function and returning TRUE overrides the default operation
*/
virtual PBoolean OnGatekeeperAliases(
const H225_ArrayOf_AliasAddress & aliases ///< Alias List returned from the gatekeeper
);
//@}
#ifdef H323_H248
/**@name Service Control */
//@{
/**Call back for HTTP based Service Control.
An application may override this to use an HTTP link to display
call information/CDR's or Billing information.
The default behaviour does nothing.
*/
virtual void OnHTTPServiceControl(
unsigned operation, ///< Control operation
unsigned sessionId, ///< Session ID for HTTP page
const PString & url ///< URL to use.
);
/**Call back for Call Credit Service Control.
An application may override this to display call credit Information.
The default behaviour does nothing.
*/
virtual void OnCallCreditServiceControl(
const PString & amount, ///< UTF-8 string for amount, including currency.
PBoolean mode, ///< Flag indicating that calls will debit the account.
const unsigned & durationLimit ///< Duration Limit (used to decrement display)
);
#ifdef H323_H350
/**Call back for LDAP based Service Control.
An application may override this to use an LDAP directory to query
White Page searches.
The default behaviour does nothing.
*/
virtual void OnH350ServiceControl(
const PString & url,
const PString & BaseDN
);
#endif
/**Call back for call credit information.
An application may override this to display call credit information
on registration, or when a call is started.
The canDisplayAmountString member variable must also be set to TRUE
for this to operate.
The default behaviour does nothing.
*/
virtual void OnCallCreditServiceControl(
const PString & amount, ///< UTF-8 string for amount, including currency.
PBoolean mode ///< Flag indicating that calls will debit the account.
);
/**Handle incoming service control session information.
Default behaviour calls session.OnChange()
*/
virtual void OnServiceControlSession(
unsigned type,
unsigned sessionid,
const H323ServiceControlSession & session,
H323Connection * connection
);
/**Create the service control session object.
*/
virtual H323ServiceControlSession * CreateServiceControlSession(
const H225_ServiceControlDescriptor & contents
);
//@}
#endif // H323_H248
/**@name Other services */
//@{
#ifdef H323_T120
/**Create an instance of the T.120 protocol handler.
This is called when the OpenLogicalChannel subsystem requires that
a T.120 channel be established.
Note that if the application overrides this it should return a pointer to a
heap variable (using new) as it will be automatically deleted when the
H323Connection is deleted.
The default behavour returns NULL.
*/
virtual OpalT120Protocol * CreateT120ProtocolHandler(
const H323Connection & connection ///< Connection for which T.120 handler created
) const;
#endif
#ifdef H323_T38
/**Create an instance of the T.38 protocol handler.
This is called when the OpenLogicalChannel subsystem requires that
a T.38 fax channel be established.
Note that if the application overrides this it should return a pointer to a
heap variable (using new) as it will be automatically deleted when the
H323Connection is deleted.
The default behavour returns NULL.
*/
virtual OpalT38Protocol * CreateT38ProtocolHandler(
const H323Connection & connection ///< Connection for which T.38 handler created
) const;
//@}
#endif
#if H323_H224
/** Create an instance of the H.224 protocol handler.
This is called when the subsystem requires that a H.224 channel be established.
Note that if the application overrides this it should return a pointer to a
heap variable (using new) as it will be automatically deleted when the Connection
is deleted.
The default behaviour creates a new OpalH224Handler.
*/
virtual OpalH224Handler * CreateH224ProtocolHandler(
H323Channel::Directions dir,
H323Connection & connection,
unsigned sessionID
) const;
/** Create an instance of the H.224 protocol handler.
This is called when the subsystem requires that a H.224 channel be established.
Note that if the application overrides this it should return a pointer to a
heap variable (using new) as it will be automatically deleted when the Connection
is deleted.
The default behaviour creates a new OpalH281Handler.
*/
virtual OpalH281Handler * CreateH281ProtocolHandler(
OpalH224Handler & h224Handler
) const;
#endif
#ifdef H323_FILE
/** Open File Transfer Session
Use this to initiate a file transfer.
*/
PBoolean OpenFileTransferSession(
const H323FileTransferList & list, ///< List of Files Requested
const PString & token, ///< Connection Token
H323ChannelNumber & num ///< Opened Channel number
);
/** Open a File Transfer Channel.
This is called when the subsystem requires that a File Transfer channel be established.
An implementer should override this function to facilitate file transfer.
If transmitting, list of files should be populated to notify the channel which files to read.
If receiving, the list of files should be altered to include path information for the storage
of received files.
The default behaviour returns FALSE to indicate File Transfer is not implemented.
*/
virtual PBoolean OpenFileTransferChannel(H323Connection & connection, ///< Connection
PBoolean isEncoder, ///< direction of channel
H323FileTransferList & filelist ///< Transfer File List
);
#endif
/**@name Additional call services */
//@{
/** Called when an endpoint receives a SETUP PDU with a
conference goal of "invite"
The default behaviour is to return FALSE, which will close the connection
*/
virtual PBoolean OnConferenceInvite(
PBoolean sending, ///< direction
const H323Connection * connection, ///< Connection
const H323SignalPDU & setupPDU ///< PDU message
);
/** Called when an endpoint receives a SETUP PDU with a
conference goal of "callIndependentSupplementaryService"
The default behaviour is to return FALSE, which will close the connection
*/
virtual PBoolean OnSendCallIndependentSupplementaryService(
const H323Connection * connection, ///< Connection
H323SignalPDU & pdu ///< PDU message
);
virtual PBoolean OnReceiveCallIndependentSupplementaryService(
const H323Connection * connection, ///< Connection
const H323SignalPDU & pdu ///< PDU message
);
/** Called when an endpoint receives a SETUP PDU with a
conference goal of "capability_negotiation"
The default behaviour is to return FALSE, which will close the connection
*/
virtual PBoolean OnNegotiateConferenceCapabilities(
const H323SignalPDU & setupPDU
);
//@}
/**@name Member variable access */
//@{
/**Set the user name to be used for the local end of any connections. This
defaults to the logged in user as obtained from the
PProcess::GetUserName() function.
Note that this name is technically the first alias for the endpoint.
Additional aliases may be added by the use of the AddAliasName()
function, however that list will be cleared when this function is used.
*/
virtual void SetLocalUserName(
const PString & name ///< Local name of endpoint (prime alias)
);
/**Get the user name to be used for the local end of any connections. This
defaults to the logged in user as obtained from the
PProcess::GetUserName() function.
*/
virtual const PString & GetLocalUserName() const { return localAliasNames[0]; }
/**Add an alias name to be used for the local end of any connections. If
the alias name already exists in the list then is is not added again.
The list defaults to the value set in the SetLocalUserName() function.
Note that calling SetLocalUserName() will clear the alias list.
*/
PBoolean AddAliasName(
const PString & name ///< New alias name to add
);
/**Remove an alias name used for the local end of any connections.
defaults to an empty list.
*/
PBoolean RemoveAliasName(
const PString & name ///< New alias namer to add
);
/**Get the user name to be used for the local end of any connections. This
defaults to the logged in user as obtained from the
PProcess::GetUserName() function.
*/
const PStringList & GetAliasNames() const { return localAliasNames; }
#if P_LDAP
/**Get the default ILS server to use for user lookup.
*/
const PString & GetDefaultILSServer() const { return ilsServer; }
/**Set the default ILS server to use for user lookup.
*/
void SetDefaultILSServer(
const PString & server
) { ilsServer = server; }
#endif
/**Get the default fast start mode.
*/
PBoolean IsFastStartDisabled() const
{ return disableFastStart; }
/**Set the default fast start mode.
*/
void DisableFastStart(
PBoolean mode ///< New default mode
) { disableFastStart = mode; }
/**Get the default H.245 tunneling mode.
*/
PBoolean IsH245TunnelingDisabled() const
{ return disableH245Tunneling; }
/**Set the default H.245 tunneling mode.
*/
void DisableH245Tunneling(
PBoolean mode ///< New default mode
) { disableH245Tunneling = mode; }
/**Get the default H.245 tunneling mode.
*/
PBoolean IsH245inSetupDisabled() const
{ return disableH245inSetup; }
/**Set the default H.245 tunneling mode.
*/
void DisableH245inSetup(
PBoolean mode ///< New default mode
) { disableH245inSetup = mode; }
/** Get the default H.245 QoS mode.
*/
PBoolean IsH245QoSDisabled() const
{ return disableH245QoS; }
/** Disable H.245 QoS support
*/
void DisableH245QoS(
PBoolean mode ///< New default mode
) { disableH245QoS = mode; }
/**Get the detect in-band DTMF flag.
*/
PBoolean DetectInBandDTMFDisabled() const
{ return disableDetectInBandDTMF; }
/**Set the detect in-band DTMF flag.
*/
void DisableDetectInBandDTMF(
PBoolean mode ///< New default mode
) { disableDetectInBandDTMF = mode; }
/**Get the flag indicating the endpoint can display an amount string.
*/
PBoolean CanDisplayAmountString() const
{ return canDisplayAmountString; }
/**Set the flag indicating the endpoint can display an amount string.
*/
void SetCanDisplayAmountString(
PBoolean mode ///< New default mode
) { canDisplayAmountString = mode; }
/**Get the flag indicating the call will automatically clear after a time.
*/
PBoolean CanEnforceDurationLimit() const
{ return canEnforceDurationLimit; }
/**Set the flag indicating the call will automatically clear after a time.
*/
void SetCanEnforceDurationLimit(
PBoolean mode ///< New default mode
) { canEnforceDurationLimit = mode; }
#ifdef H323_RTP_AGGREGATE
/**Set the RTP aggregation size
*/
void SetRTPAggregatationSize(
PINDEX size ///< max connections per aggregation thread. Value of 1 or zero disables aggregation
) { rtpAggregationSize = size; }
/**Get the RTP aggregation size
*/
PINDEX GetRTPAggregationSize() const
{ return rtpAggregationSize; }
/** Get the aggregator used for RTP channels
*/
PHandleAggregator * GetRTPAggregator();
#endif
#ifdef H323_SIGNAL_AGGREGATE
/**Set the signalling aggregation size
*/
void SetSignallingAggregationSize(
PINDEX size ///< max connections per aggregation thread. Value of 1 or zero disables aggregation
) { signallingAggregationSize = size; }
/**Get the RTP aggregation size
*/
PINDEX GetSignallingAggregationSize() const
{ return signallingAggregationSize; }
/** Get the aggregator used for signalling channels
*/
PHandleAggregator * GetSignallingAggregator();
#endif
#ifdef H323_H450
/**Get Call Intrusion Protection Level of the end point.
*/
unsigned GetCallIntrusionProtectionLevel() const { return callIntrusionProtectionLevel; }
/**Set Call Intrusion Protection Level of the end point.
*/
void SetCallIntrusionProtectionLevel(
unsigned level ///< New level from 0 to 3
) { PAssert(level<=3, PInvalidParameter); callIntrusionProtectionLevel = level; }
/**Called from H.450 OnReceivedInitiateReturnError
*/
virtual void OnReceivedInitiateReturnError();
#endif // H323_H450
#ifdef H323_AUDIO_CODECS
#ifdef P_AUDIO
/**Set the name for the sound channel to be used for output.
If the name is not suitable for use with the PSoundChannel class then
the function will return FALSE and not change the device.
This defaults to the value of the PSoundChannel::GetDefaultDevice()
function.
*/
virtual PBoolean SetSoundChannelPlayDevice(const PString & name);
virtual PBoolean SetSoundChannelPlayDriver(const PString & name);
/**Get the name for the sound channel to be used for output.
This defaults to the value of the PSoundChannel::GetDefaultDevice()
function.
*/
const PString & GetSoundChannelPlayDevice() const { return soundChannelPlayDevice; }
const PString & GetSoundChannelPlayDriver() const { return soundChannelPlayDriver; }
/**Set the name for the sound channel to be used for input.
If the name is not suitable for use with the PSoundChannel class then
the function will return FALSE and not change the device.
This defaults to the value of the PSoundChannel::GetDefaultDevice()
function.
*/
virtual PBoolean SetSoundChannelRecordDevice(const PString & name);
virtual PBoolean SetSoundChannelRecordDriver(const PString & name);
/**Get the name for the sound channel to be used for input.
This defaults to the value of the PSoundChannel::GetDefaultDevice()
function.
*/
const PString & GetSoundChannelRecordDevice() const { return soundChannelRecordDevice; }
const PString & GetSoundChannelRecordDriver() const { return soundChannelRecordDriver; }
/**Get default the sound channel buffer depth.
*/
unsigned GetSoundChannelBufferDepth() const { return soundChannelBuffers; }
/**Set the default sound channel buffer depth.
*/
void SetSoundChannelBufferDepth(
unsigned depth ///< New depth
);
#endif // P_AUDIO
/**Get the default silence detection mode.
*/
H323AudioCodec::SilenceDetectionMode GetSilenceDetectionMode() const
{ return defaultSilenceDetection; }
/**Set the default silence detection mode.
*/
void SetSilenceDetectionMode(
H323AudioCodec::SilenceDetectionMode mode ///< New default mode
) { defaultSilenceDetection = mode; }
#endif // H323_AUDIO_CODECS
/**Get the default mode for sending User Input Indications.
*/
H323Connection::SendUserInputModes GetSendUserInputMode() const { return defaultSendUserInputMode; }
/**Set the default mode for sending User Input Indications.
*/
void SetSendUserInputMode(H323Connection::SendUserInputModes mode) { defaultSendUserInputMode = mode; }
#ifdef H323_AUDIO_CODECS
/**See if should auto-start receive audio channels on connection.
*/
PBoolean CanAutoStartReceiveAudio() const { return autoStartReceiveAudio; }
/**See if should auto-start transmit audio channels on connection.
*/
PBoolean CanAutoStartTransmitAudio() const { return autoStartTransmitAudio; }
#endif
#ifdef H323_VIDEO
/**See if should auto-start receive video channels on connection.
*/
PBoolean CanAutoStartReceiveVideo() const { return autoStartReceiveVideo; }
/**See if should auto-start transmit video channels on connection.
*/
PBoolean CanAutoStartTransmitVideo() const { return autoStartTransmitVideo; }
#ifdef H323_H239
/**See if should auto-start receive extended Video channels on connection.
*/
PBoolean CanAutoStartReceiveExtVideo() const { return autoStartReceiveExtVideo; }
/**See if should auto-start transmit extended Video channels on connection.
*/
PBoolean CanAutoStartTransmitExtVideo() const { return autoStartTransmitExtVideo; }
#endif // H323_H239
#endif // H323_VIDEO
#ifdef H323_T38
/**See if should auto-start receive fax channels on connection.
*/
PBoolean CanAutoStartReceiveFax() const { return autoStartReceiveFax; }
/**See if should auto-start transmit fax channels on connection.
*/
PBoolean CanAutoStartTransmitFax() const { return autoStartTransmitFax; }
#endif // H323_T38
/**See if should automatically do call forward of connection.
*/
PBoolean CanAutoCallForward() const { return autoCallForward; }
/**Get the set of listeners (incoming call transports) for this endpoint.
*/
const H323ListenerList & GetListeners() const { return listeners; }
/**Get the current capability table for this endpoint.
*/
const H323Capabilities & GetCapabilities() const { return capabilities; }
/**Endpoint types.
*/
enum TerminalTypes {
e_TerminalOnly = 50,
e_TerminalAndMC = 70,
e_GatewayOnly = 60,
e_GatewayAndMC = 80,
e_GatewayAndMCWithDataMP = 90,
e_GatewayAndMCWithAudioMP = 100,
e_GatewayAndMCWithAVMP = 110,
e_GatekeeperOnly = 120,
e_GatekeeperWithDataMP = 130,
e_GatekeeperWithAudioMP = 140,
e_GatekeeperWithAVMP = 150,
e_MCUOnly = 160,
e_MCUWithDataMP = 170,
e_MCUWithAudioMP = 180,
e_MCUWithAVMP = 190
};
/**Get the endpoint terminal type.
*/
TerminalTypes GetTerminalType() const { return terminalType; }
/**Determine if endpoint is terminal type.
*/
PBoolean IsTerminal() const;
/**Determine if endpoint is gateway type.
*/
PBoolean IsGateway() const;
/**Determine if endpoint is gatekeeper type.
*/
PBoolean IsGatekeeper() const;
/**Determine if endpoint is gatekeeper type.
*/
PBoolean IsMCU() const;
#ifdef H323_AUDIO_CODECS
/**Get the default maximum audio jitter delay parameter.
Defaults to 50ms
*/
unsigned GetMinAudioJitterDelay() const { return minAudioJitterDelay; }
/**Get the default maximum audio delay jitter parameter.
Defaults to 250ms.
*/
unsigned GetMaxAudioJitterDelay() const { return maxAudioJitterDelay; }
/**Set the maximum audio delay jitter parameter.
*/
void SetAudioJitterDelay(
unsigned minDelay, ///< New minimum jitter buffer delay in milliseconds
unsigned maxDelay ///< New maximum jitter buffer delay in milliseconds
);
#endif
/**Get the initial bandwidth parameter.
*/
unsigned GetInitialBandwidth() const { return initialBandwidth; }
/**Get the initial bandwidth parameter.
*/
void SetInitialBandwidth(unsigned bandwidth) { initialBandwidth = bandwidth; }
#ifdef H323_VIDEO
virtual void OnSetInitialBandwidth(H323VideoCodec * /*codec*/) {};
#endif
/**Called when an outgoing PDU requires a feature set
*/
virtual PBoolean OnSendFeatureSet(unsigned, H225_FeatureSet &, PBoolean);
/**Called when an incoming PDU contains a feature set
*/
virtual void OnReceiveFeatureSet(unsigned, const H225_FeatureSet &, PBoolean = false);
#ifdef H323_H460
/**Get the complete list of Gatekeeper features
*/
H460_FeatureSet * GetGatekeeperFeatures();
#endif
/**Load the Base FeatureSet usually called when you initialise the endpoint prior to
registering with a gatekeeper.
*/
virtual void LoadBaseFeatureSet();
/**Callback when creating Feature Instance. This can be used to disable features on
a case by case basis by returning FALSE
Default returns TRUE
*/
virtual PBoolean OnFeatureInstance(int instType, const PString & identifer);
/**Handle Unsolicited Information PDU received on the signal listening socket not
associated with a connection.
*/
virtual PBoolean HandleUnsolicitedInformation(const H323SignalPDU & pdu);
#ifdef H323_H460
/** Get the Endpoint FeatureSet
This creates a new instance of the featureSet
*/
H460_FeatureSet * GetFeatureSet() { return features.DeriveNewFeatureSet(); };
/** Is the FeatureSet disabled
*/
PBoolean FeatureSetDisabled() { return disableH460; }
/** Disable all FeatureSets. Use this for pre H323v4 interoperability
*/
void FeatureSetDisable() { disableH460 = TRUE; }
/** Feature Callback
*/
virtual void FeatureCallBack(const PString & FeatID, ///< Feature Identifier
PINDEX msgID, ///< Message Identifer
const PString & message ///< Message
) {};
#ifdef H323_H46018
/** Disable H.460.18 Feature. (By Default it is enabled)
*/
void H46018Enable(PBoolean enable);
/** Query whether we are using H.460.18
*/
PBoolean H46018IsEnabled();
/** Signal that H.460.18 has been received. ie. We are behind a NAT/FW
*/
void H46018Received() {};
/** Whether H.460.18 is in Operation for this call
*/
PBoolean H46018InOperation();
#endif
#ifdef H323_H46023
/** Disable H.460.23 Feature. (By Default it is enabled)
*/
void H46023Enable(PBoolean enable);
/** Query whether we are using H.460.23
*/
PBoolean H46023IsEnabled();
#endif
#ifdef H323_H460P
/** Get the presence handler. By default it returns NULL
Implementor must create an instance of the presencehandler
to enable presence
*/
H460PresenceHandler * GetPresenceHandler() { return presenceHandler; }
/** Set the local Presence State.
Calling this will enable Presence in the endpoint
*/
void PresenceSetLocalState(const PStringList & alias, unsigned localstate, const PString & localdisplay = PString(), PBoolean updateOnly = false);
enum presenceInstruction {
e_subscribe,
e_unsubscribe,
e_block,
e_unblock
};
enum presenceFeature {
e_preAudio,
e_preVideo,
e_preExtVideo,
e_preData
};
struct presenceLocale {
PString m_locale;
PString m_region;
PString m_country;
PString m_countryCode;
PString m_latitude;
PString m_longitude;
PString m_elevation;
};
void PresenceAddFeature(presenceFeature feat);
void PresenceAddFeatureH460();
void PresenceSetLocale(const presenceLocale & info);
/** Set Presence Instructions.
*/
void PresenceSetInstruction(const PString & epalias,
unsigned type,
const PStringList & list,
PBoolean autoSend = true);
/** Submit Presence Authorizations.
*/
void PresenceSendAuthorization(const OpalGloballyUniqueID & id,
const PString & epalias,
PBoolean approved,
const PStringList & subscribe);
/** Received Notifications
*/
virtual void PresenceNotification(const PString & locAlias,
const PString & subAlias,
unsigned state,
const PString & display);
/** Received Instructions
*/
virtual void PresenceInstruction(const PString & locAlias,
unsigned type,
const PString & subAlias);
/** Received Request for authorization
*/
virtual void PresenceAuthorization(const OpalGloballyUniqueID & id,
const PString & locAlias,
const PStringList & Aliases);
#endif
#endif
#ifdef H323_AEC
PBoolean AECEnabled() { return enableAEC; }
void SetAECEnabled(PBoolean enabled) { enableAEC = enabled; }
#endif
#ifdef P_STUN
/**Return the STUN server to use.
Returns NULL if address is a local address as per IsLocalAddress().
Always returns the STUN server if address is zero.
Note, the pointer is NOT to be deleted by the user.
*/
PSTUNClient * GetSTUN(
const PIPSocket::Address & address = 0
) const;
/**Set the STUN server address, is of the form host[:port]
*/
void SetSTUNServer(
const PString & server
);
/**Type of NAT detected (if available) when initialing STUN Client
*/
virtual PBoolean STUNNatType(int /*type*/) { return FALSE; };
/** Retrieve the first available
NAT Traversal Techniques
*/
PNatMethod * GetPreferedNatMethod(
const PIPSocket::Address & address = 0
);
/** Get the Nat Methods List
*/
PNatStrategy & GetNatMethods();
virtual void NATMethodCallBack(const PString & /*NatID*/, ///< Method Identifier
PINDEX /*msgID*/, ///< Message Identifer
const PString & /*message*/ ///< Message
) {};
#endif // P_NONCORE
virtual PBoolean OnUnsolicitedInformation(const H323SignalPDU & /*pdu*/)
{ return FALSE; }
/**Determine if the address is "local", ie does not need STUN
*/
virtual PBoolean IsLocalAddress(
const PIPSocket::Address & remoteAddress
) const;
/**Provide TCP address translation hook
*/
virtual void TranslateTCPAddress(
PIPSocket::Address & /*localAddr*/,
const PIPSocket::Address & /*remoteAddr */
) { }
void InternalTranslateTCPAddress(
PIPSocket::Address & /*localAddr*/,
const PIPSocket::Address & /*remoteAddr */,
const H323Connection * conn = NULL
);
/**Provide TCP Port translation hook
*/
virtual void TranslateTCPPort(
WORD & /*ListenPort*/, ///* Local listening port
const PIPSocket::Address & /*remoteAddr*/ ///* Remote address
) { };
/**Get the TCP port number base for H.245 channels
*/
WORD GetTCPPortBase() const { return tcpPorts.base; }
/**Get the TCP port number base for H.245 channels.
*/
WORD GetTCPPortMax() const { return tcpPorts.max; }
/**Set the TCP port number base and max for H.245 channels.
*/
void SetTCPPorts(unsigned tcpBase, unsigned tcpMax);
/**Get the next TCP port number for H.245 channels
*/
WORD GetNextTCPPort();
/**Get the UDP port number base for RAS channels
*/
WORD GetUDPPortBase() const { return udpPorts.base; }
/**Get the UDP port number base for RAS channels.
*/
WORD GetUDPPortMax() const { return udpPorts.max; }
/**Set the TCP port number base and max for H.245 channels.
*/
void SetUDPPorts(unsigned udpBase, unsigned udpMax);
/**Get the next UDP port number for RAS channels
*/
WORD GetNextUDPPort();
/**Get the UDP port number base for RTP channels.
*/
WORD GetRtpIpPortBase() const { return rtpIpPorts.base; }
/**Get the max UDP port number for RTP channels.
*/
WORD GetRtpIpPortMax() const { return rtpIpPorts.max; }
/**Set the UDP port number base and max for RTP channels.
*/
void SetRtpIpPorts(unsigned udpBase, unsigned udpMax);
/**Get the UDP port number pair for RTP channels.
*/
WORD GetRtpIpPortPair();
#ifdef H323_H46019M
/**Set the UDP port number base for Multiplex RTP/RTCP channels.
*/
void SetMultiplexPort(unsigned rtpPort);
/**Get the UDP port number base for Multiplex RTP/RTCP channels.
*/
WORD GetMultiplexPort();
/**Get next Multiplex RTP/RTCP channel ID.
Each call indexes the counter by 1;
*/
unsigned GetMultiplexID();
#endif
/**Get the IP Type Of Service byte for RTP channels.
*/
BYTE GetRtpIpTypeofService() const { return rtpIpTypeofService; }
/**Set the IP Type Of Service byte for RTP channels.
*/
void SetRtpIpTypeofService(unsigned tos) { rtpIpTypeofService = (BYTE)tos; }
/**Get the IP Type Of Service byte for TCP channels.
*/
BYTE GetTcpIpTypeofService() const { return tcpIpTypeofService; }
/**Set the IP Type Of Service byte for TCP channels.
*/
void SetTcpIpTypeofService(unsigned tos) { tcpIpTypeofService = (BYTE)tos; }
/** Get the default timeout for connecting via TCP
*/
const PTimeInterval & GetSignallingChannelConnectTimeout() const { return signallingChannelConnectTimeout; }
/**Get the default timeout for calling another endpoint.
*/
const PTimeInterval & GetSignallingChannelCallTimeout() const { return signallingChannelCallTimeout; }
/**Get the default timeout for incoming H.245 connection.
*/
const PTimeInterval & GetControlChannelStartTimeout() const { return controlChannelStartTimeout; }
/**Get the default timeout for waiting on an end session.
*/
const PTimeInterval & GetEndSessionTimeout() const { return endSessionTimeout; }
/**Get the default timeout for master slave negotiations.
*/
const PTimeInterval & GetMasterSlaveDeterminationTimeout() const { return masterSlaveDeterminationTimeout; }
/**Get the default retries for H245 master slave negotiations.
*/
unsigned GetMasterSlaveDeterminationRetries() const { return masterSlaveDeterminationRetries; }
/**Get the default timeout for H245 capability exchange negotiations.
*/
const PTimeInterval & GetCapabilityExchangeTimeout() const { return capabilityExchangeTimeout; }
/**Get the default timeout for H245 logical channel negotiations.
*/
const PTimeInterval & GetLogicalChannelTimeout() const { return logicalChannelTimeout; }
/**Get the default timeout for H245 request mode negotiations.
*/
const PTimeInterval & GetRequestModeTimeout() const { return logicalChannelTimeout; }
/**Get the default timeout for H245 round trip delay negotiations.
*/
const PTimeInterval & GetRoundTripDelayTimeout() const { return roundTripDelayTimeout; }
/**Get the default rate H245 round trip delay is calculated by connection.
*/
const PTimeInterval & GetRoundTripDelayRate() const { return roundTripDelayRate; }
/**Get the flag for clearing a call if the round trip delay calculation fails.
*/
PBoolean ShouldClearCallOnRoundTripFail() const { return clearCallOnRoundTripFail; }
/**Get the amount of time with no media that should cause call to clear
*/
const PTimeInterval & GetNoMediaTimeout() const;
/**Set the amount of time with no media that should cause call to clear
*/
PBoolean SetNoMediaTimeout(PTimeInterval newInterval);
/**Get the default timeout for GatekeeperRequest and Gatekeeper discovery.
*/
const PTimeInterval & GetGatekeeperRequestTimeout() const { return gatekeeperRequestTimeout; }
/**Get the default retries for GatekeeperRequest and Gatekeeper discovery.
*/
unsigned GetGatekeeperRequestRetries() const { return gatekeeperRequestRetries; }
/**Get the default timeout for RAS protocol transactions.
*/
const PTimeInterval & GetRasRequestTimeout() const { return rasRequestTimeout; }
/**Get the default retries for RAS protocol transations.
*/
unsigned GetRasRequestRetries() const { return rasRequestRetries; }
/**Get the default time for gatekeeper to reregister.
A value of zero disables the keep alive facility.
*/
const PTimeInterval & GetGatekeeperTimeToLive() const { return registrationTimeToLive; }
/**Get the iNow Gatekeeper Access Token OID.
*/
const PString & GetGkAccessTokenOID() const { return gkAccessTokenOID; }
/**Set the iNow Gatekeeper Access Token OID.
*/
void SetGkAccessTokenOID(const PString & token) { gkAccessTokenOID = token; }
/**Get flag to indicate whether to send GRQ on gatekeeper registration
*/
PBoolean GetSendGRQ() const
{ return sendGRQ; }
/**Sent flag to indicate whether to send GRQ on gatekeeper registration
*/
void SetSendGRQ(PBoolean v)
{ sendGRQ = v; }
#ifdef H323_H450
/**Get the default timeout for Call Transfer Timer CT-T1.
*/
const PTimeInterval & GetCallTransferT1() const { return callTransferT1; }
/**Get the default timeout for Call Transfer Timer CT-T2.
*/
const PTimeInterval & GetCallTransferT2() const { return callTransferT2; }
/**Get the default timeout for Call Transfer Timer CT-T3.
*/
const PTimeInterval & GetCallTransferT3() const { return callTransferT3; }
/**Get the default timeout for Call Transfer Timer CT-T4.
*/
const PTimeInterval & GetCallTransferT4() const { return callTransferT4; }
/** Get Call Intrusion timers timeout */
const PTimeInterval & GetCallIntrusionT1() const { return callIntrusionT1; }
const PTimeInterval & GetCallIntrusionT2() const { return callIntrusionT2; }
const PTimeInterval & GetCallIntrusionT3() const { return callIntrusionT3; }
const PTimeInterval & GetCallIntrusionT4() const { return callIntrusionT4; }
const PTimeInterval & GetCallIntrusionT5() const { return callIntrusionT5; }
const PTimeInterval & GetCallIntrusionT6() const { return callIntrusionT6; }
/**Get the dictionary of <callIdentities, connections>
*/
H323CallIdentityDict& GetCallIdentityDictionary() { return secondaryConnectionsActive; }
/**Get the next available invoke Id for H450 operations
*/
unsigned GetNextH450CallIdentityValue() const { return ++nextH450CallIdentity; }
#endif // H323_H450
/**Get the default stack size of cleaner threads.
*/
PINDEX GetCleanerThreadStackSize() const { return cleanerThreadStackSize; }
/**Get the default stack size of listener threads.
*/
PINDEX GetListenerThreadStackSize() const { return listenerThreadStackSize; }
/**Get the default stack size of signalling channel threads.
*/
PINDEX GetSignallingThreadStackSize() const { return signallingThreadStackSize; }
/**Get the default stack size of control channel threads.
*/
PINDEX GetControlThreadStackSize() const { return controlThreadStackSize; }
/**Get the default stack size of logical channel threads.
*/
PINDEX GetChannelThreadStackSize() const { return logicalThreadStackSize; }
/**Get the default stack size of RAS channel threads.
*/
PINDEX GetRasThreadStackSize() const { return rasThreadStackSize; }
/**Get the default stack size of jitter buffer threads.
*/
PBoolean UseJitterBuffer() const { return useJitterBuffer; }
/**Get the default stack size of jitter buffer threads.
*/
PINDEX GetJitterThreadStackSize() const { return jitterThreadStackSize; }
/** Get the priority at which channel threads run
*/
PThread::Priority GetChannelThreadPriority() const { return channelThreadPriority; }
H323ConnectionDict & GetConnections() { return connectionsActive; };
PBoolean EnableH225KeepAlive() const { return m_useH225KeepAlive; }
PBoolean EnableH245KeepAlive() const { return m_useH245KeepAlive; }
//@}
/**
* default settings H.221 settings
*/
static BYTE defaultT35CountryCode;
static BYTE defaultT35Extension;
static WORD defaultManufacturerCode;
protected:
H323Gatekeeper * InternalCreateGatekeeper(H323Transport * transport);
PBoolean InternalRegisterGatekeeper(H323Gatekeeper * gk, PBoolean discovered);
H323Connection * FindConnectionWithoutLocks(const PString & token);
virtual H323Connection * InternalMakeCall(
const PString & existingToken, /// Existing connection to be transferred
const PString & callIdentity, /// Call identity of the secondary call (if it exists)
unsigned capabilityLevel, /// Intrusion capability level
const PString & remoteParty, /// Remote party to call
H323Transport * transport, /// Transport to use for call.
PString & token, /// String to use/receive token for connection
void * userData, /// user data to pass to CreateConnection
PBoolean supplimentary = false ///< Whether the call is a supplimentary call
);
// Configuration variables, commonly changed
PStringList localAliasNames;
#ifdef H323_AUDIO_CODECS
H323AudioCodec::SilenceDetectionMode defaultSilenceDetection;
unsigned minAudioJitterDelay;
unsigned maxAudioJitterDelay;
#ifdef P_AUDIO
PString soundChannelPlayDevice;
PString soundChannelPlayDriver;
PString soundChannelRecordDevice;
PString soundChannelRecordDriver;
unsigned soundChannelBuffers;
#endif // P_AUDIO
PBoolean autoStartReceiveAudio;
PBoolean autoStartTransmitAudio;
#endif // H323_AUDIO_CODECS
#ifdef H323_VIDEO
PString videoChannelPlayDevice;
PString videoChannelRecordDevice;
PBoolean autoStartReceiveVideo;
PBoolean autoStartTransmitVideo;
#ifdef H323_H239
PBoolean autoStartReceiveExtVideo;
PBoolean autoStartTransmitExtVideo;
#endif // H323_H239
#endif // H323_VIDEO
#ifdef H323_T38
PBoolean autoStartReceiveFax;
PBoolean autoStartTransmitFax;
#endif // H323_T38
PBoolean autoCallForward;
PBoolean disableFastStart;
PBoolean disableH245Tunneling;
PBoolean disableH245inSetup;
PBoolean disableH245QoS;
PBoolean disableDetectInBandDTMF;
PBoolean canDisplayAmountString;
PBoolean canEnforceDurationLimit;
#ifdef H323_H450
unsigned callIntrusionProtectionLevel;
#endif // H323_H450
H323Connection::SendUserInputModes defaultSendUserInputMode;
#ifdef P_LDAP
PString ilsServer;
#endif // P_LDAP
// Some more configuration variables, rarely changed.
BYTE rtpIpTypeofService;
BYTE tcpIpTypeofService;
PTimeInterval signallingChannelConnectTimeout;
PTimeInterval signallingChannelCallTimeout;
PTimeInterval controlChannelStartTimeout;
PTimeInterval endSessionTimeout;
PTimeInterval masterSlaveDeterminationTimeout;
unsigned masterSlaveDeterminationRetries;
PTimeInterval capabilityExchangeTimeout;
PTimeInterval logicalChannelTimeout;
PTimeInterval requestModeTimeout;
PTimeInterval roundTripDelayTimeout;
PTimeInterval roundTripDelayRate;
PTimeInterval noMediaTimeout;
PTimeInterval gatekeeperRequestTimeout;
unsigned gatekeeperRequestRetries;
PTimeInterval rasRequestTimeout;
unsigned rasRequestRetries;
PTimeInterval registrationTimeToLive;
PString gkAccessTokenOID;
PBoolean sendGRQ;
unsigned initialBandwidth; // in 100s of bits/sev
PBoolean clearCallOnRoundTripFail;
struct PortInfo {
void Set(
unsigned base,
unsigned max,
unsigned range,
unsigned dflt
);
WORD GetNext(
unsigned increment
);
PMutex mutex;
WORD base;
WORD max;
WORD current;
} tcpPorts, udpPorts, rtpIpPorts;
#ifdef P_STUN
PNatStrategy * natMethods;
PSTUNClient * stun;
PBoolean disableSTUNTranslate;
#endif
#ifdef H323_H46019M
struct MuxIDInfo {
PMutex mutex;
unsigned base;
unsigned max;
unsigned current;
unsigned GetNext(
unsigned increment
);
} rtpMuxID;
WORD defaultMultiRTPPort;
#endif
BYTE t35CountryCode;
BYTE t35Extension;
WORD manufacturerCode;
TerminalTypes terminalType;
#ifdef H323_H450
/* Protect against absence of a response to the ctIdentify reqest
(Transferring Endpoint - Call Transfer with a secondary Call) */
PTimeInterval callTransferT1;
/* Protect against failure of completion of the call transfer operation
involving a secondary Call (Transferred-to Endpoint) */
PTimeInterval callTransferT2;
/* Protect against failure of the Transferred Endpoint not responding
within sufficient time to the ctInitiate APDU (Transferring Endpoint) */
PTimeInterval callTransferT3;
/* May optionally operate - protects against absence of a response to the
ctSetup request (Transferred Endpoint) */
PTimeInterval callTransferT4;
/** Call Intrusion Timers */
PTimeInterval callIntrusionT1;
PTimeInterval callIntrusionT2;
PTimeInterval callIntrusionT3;
PTimeInterval callIntrusionT4;
PTimeInterval callIntrusionT5;
PTimeInterval callIntrusionT6;
H323CallIdentityDict secondaryConnectionsActive;
mutable PAtomicInteger nextH450CallIdentity;
/// Next available callIdentity for H450 Transfer operations via consultation.
#endif // H323_H450
PINDEX cleanerThreadStackSize;
PINDEX listenerThreadStackSize;
PINDEX signallingThreadStackSize;
PINDEX controlThreadStackSize;
PINDEX logicalThreadStackSize;
PINDEX rasThreadStackSize;
PINDEX jitterThreadStackSize;
PBoolean useJitterBuffer;
#ifdef H323_RTP_AGGREGATE
PINDEX rtpAggregationSize;
PHandleAggregator * rtpAggregator;
#endif
#ifdef H323_SIGNAL_AGGREGATE
PINDEX signallingAggregationSize;
PHandleAggregator * signallingAggregator;
#endif
PThread::Priority channelThreadPriority;
// Dynamic variables
H323ListenerList listeners;
H323Capabilities capabilities;
H323Gatekeeper * gatekeeper;
PString gatekeeperPassword;
H323ConnectionDict connectionsActive;
PMutex connectionsMutex;
PMutex noMediaMutex;
PStringSet connectionsToBeCleaned;
H323ConnectionsCleaner * connectionsCleaner;
PSyncPoint connectionsAreCleaned;
#ifndef DISABLE_CALLAUTH
// Call Authentication
PString EPSecurityUserName; /// Local UserName Authenticated Call
PString EPSecurityPassword; /// Local Password Authenticated Call
PBoolean isSecureCall; /// Flag to Specify Call to make is Authenticated.
EPSecurityPolicy CallAuthPolicy; /// Incoming Call Authentication acceptance level
H235AuthenticatorList EPAuthList; /// List of Usernames & Password to check incoming call Against
#endif
#ifdef H323_H460
H460_FeatureSet features;
PBoolean disableH460;
#ifdef H323_H46018
PBoolean m_h46018enabled;
#endif
#ifdef H323_H46023
PBoolean m_h46023enabled;
#endif
#ifdef H323_H460P
H460PresenceHandler * presenceHandler;
#endif
#endif
#ifdef H323_AEC
PBoolean enableAEC;
#endif
#ifdef H323_GNUGK
GNUGK_Feature * gnugk;
#endif
void RegInvokeReRegistration();
PMutex reregmutex;
PThread * RegThread;
PDECLARE_NOTIFIER(PThread, H323EndPoint, RegMethod);
PBoolean m_useH225KeepAlive;
PBoolean m_useH245KeepAlive;
};
/////////////////////////////////////////////////////////////////////
#endif // __OPAL_H323EP_H
/////////////////////////////////////////////////////////////////////////////
|