/usr/include/pjsua2/account.hpp is in libpjproject-dev 2.5.5~dfsg-6+deb9u1.
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 | /* $Id: account.hpp 4957 2014-11-04 08:00:15Z nanang $ */
/*
* Copyright (C) 2013 Teluu Inc. (http://www.teluu.com)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJSUA2_ACCOUNT_HPP__
#define __PJSUA2_ACCOUNT_HPP__
/**
* @file pjsua2/account.hpp
* @brief PJSUA2 Account operations
*/
#include <pjsua-lib/pjsua.h>
#include <pjsua2/persistent.hpp>
#include <pjsua2/presence.hpp>
#include <pjsua2/siptypes.hpp>
/** PJSUA2 API is inside pj namespace */
namespace pj
{
/**
* @defgroup PJSUA2_ACC Account
* @ingroup PJSUA2_Ref
* @{
*/
using std::string;
/**
* Account registration config. This will be specified in AccountConfig.
*/
struct AccountRegConfig : public PersistentObject
{
/**
* This is the URL to be put in the request URI for the registration,
* and will look something like "sip:serviceprovider".
*
* This field should be specified if registration is desired. If the
* value is empty, no account registration will be performed.
*/
string registrarUri;
/**
* Specify whether the account should register as soon as it is
* added to the UA. Application can set this to PJ_FALSE and control
* the registration manually with pjsua_acc_set_registration().
*
* Default: True
*/
bool registerOnAdd;
/**
* The optional custom SIP headers to be put in the registration
* request.
*/
SipHeaderVector headers;
/**
* Optional interval for registration, in seconds. If the value is zero,
* default interval will be used (PJSUA_REG_INTERVAL, 300 seconds).
*/
unsigned timeoutSec;
/**
* Specify interval of auto registration retry upon registration failure
* (including caused by transport problem), in second. Set to 0 to
* disable auto re-registration. Note that if the registration retry
* occurs because of transport failure, the first retry will be done
* after \a firstRetryIntervalSec seconds instead. Also note that
* the interval will be randomized slightly by some seconds (specified
* in \a reg_retry_random_interval) to avoid all clients re-registering
* at the same time.
*
* See also \a firstRetryIntervalSec and \a randomRetryIntervalSec
* settings.
*
* Default: PJSUA_REG_RETRY_INTERVAL
*/
unsigned retryIntervalSec;
/**
* This specifies the interval for the first registration retry. The
* registration retry is explained in \a retryIntervalSec. Note that
* the value here will also be randomized by some seconds (specified
* in \a reg_retry_random_interval) to avoid all clients re-registering
* at the same time.
*
* See also \a retryIntervalSec and \a randomRetryIntervalSec settings.
*
* Default: 0
*/
unsigned firstRetryIntervalSec;
/**
* This specifies maximum randomized value to be added/substracted
* to/from the registration retry interval specified in \a
* reg_retry_interval and \a reg_first_retry_interval, in second.
* This is useful to avoid all clients re-registering at the same time.
* For example, if the registration retry interval is set to 100 seconds
* and this is set to 10 seconds, the actual registration retry interval
* will be in the range of 90 to 110 seconds.
*
* See also \a retryIntervalSec and \a firstRetryIntervalSec settings.
*
* Default: 10
*/
unsigned randomRetryIntervalSec;
/**
* Specify the number of seconds to refresh the client registration
* before the registration expires.
*
* Default: PJSIP_REGISTER_CLIENT_DELAY_BEFORE_REFRESH, 5 seconds
*/
unsigned delayBeforeRefreshSec;
/**
* Specify whether calls of the configured account should be dropped
* after registration failure and an attempt of re-registration has
* also failed.
*
* Default: FALSE (disabled)
*/
bool dropCallsOnFail;
/**
* Specify the maximum time to wait for unregistration requests to
* complete during library shutdown sequence.
*
* Default: PJSUA_UNREG_TIMEOUT
*/
unsigned unregWaitMsec;
/**
* Specify how the registration uses the outbound and account proxy
* settings. This controls if and what Route headers will appear in
* the REGISTER request of this account. The value is bitmask combination
* of PJSUA_REG_USE_OUTBOUND_PROXY and PJSUA_REG_USE_ACC_PROXY bits.
* If the value is set to 0, the REGISTER request will not use any proxy
* (i.e. it will not have any Route headers).
*
* Default: 3 (PJSUA_REG_USE_OUTBOUND_PROXY | PJSUA_REG_USE_ACC_PROXY)
*/
unsigned proxyUse;
public:
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/** Array of SIP credentials */
typedef std::vector<AuthCredInfo> AuthCredInfoVector;
/**
* Various SIP settings for the account. This will be specified in
* AccountConfig.
*/
struct AccountSipConfig : public PersistentObject
{
/**
* Array of credentials. If registration is desired, normally there should
* be at least one credential specified, to successfully authenticate
* against the service provider. More credentials can be specified, for
* example when the requests are expected to be challenged by the
* proxies in the route set.
*/
AuthCredInfoVector authCreds;
/**
* Array of proxy servers to visit for outgoing requests. Each of the
* entry is translated into one Route URI.
*/
StringVector proxies;
/**
* Optional URI to be put as Contact for this account. It is recommended
* that this field is left empty, so that the value will be calculated
* automatically based on the transport address.
*/
string contactForced;
/**
* Additional parameters that will be appended in the Contact header
* for this account. This will affect the Contact header in all SIP
* messages sent on behalf of this account, including but not limited to
* REGISTER, INVITE, and SUBCRIBE requests or responses.
*
* The parameters should be preceeded by semicolon, and all strings must
* be properly escaped. Example:
* ";my-param=X;another-param=Hi%20there"
*/
string contactParams;
/**
* Additional URI parameters that will be appended in the Contact URI
* for this account. This will affect the Contact URI in all SIP
* messages sent on behalf of this account, including but not limited to
* REGISTER, INVITE, and SUBCRIBE requests or responses.
*
* The parameters should be preceeded by semicolon, and all strings must
* be properly escaped. Example:
* ";my-param=X;another-param=Hi%20there"
*/
string contactUriParams;
/**
* If this flag is set, the authentication client framework will
* send an empty Authorization header in each initial request.
* Default is no.
*/
bool authInitialEmpty;
/**
* Specify the algorithm to use when empty Authorization header
* is to be sent for each initial request (see above)
*/
string authInitialAlgorithm;
/**
* Optionally bind this account to specific transport. This normally is
* not a good idea, as account should be able to send requests using
* any available transports according to the destination. But some
* application may want to have explicit control over the transport to
* use, so in that case it can set this field.
*
* Default: -1 (PJSUA_INVALID_ID)
*
* @see Account::setTransport()
*/
TransportId transportId;
public:
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Account's call settings. This will be specified in AccountConfig.
*/
struct AccountCallConfig : public PersistentObject
{
/**
* Specify how to offer call hold to remote peer. Please see the
* documentation on pjsua_call_hold_type for more info.
*
* Default: PJSUA_CALL_HOLD_TYPE_DEFAULT
*/
pjsua_call_hold_type holdType;
/**
* Specify how support for reliable provisional response (100rel/
* PRACK) should be used for all sessions in this account. See the
* documentation of pjsua_100rel_use enumeration for more info.
*
* Default: PJSUA_100REL_NOT_USED
*/
pjsua_100rel_use prackUse;
/**
* Specify the usage of Session Timers for all sessions. See the
* pjsua_sip_timer_use for possible values.
*
* Default: PJSUA_SIP_TIMER_OPTIONAL
*/
pjsua_sip_timer_use timerUse;
/**
* Specify minimum Session Timer expiration period, in seconds.
* Must not be lower than 90. Default is 90.
*/
unsigned timerMinSESec;
/**
* Specify Session Timer expiration period, in seconds.
* Must not be lower than timerMinSE. Default is 1800.
*/
unsigned timerSessExpiresSec;
public:
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Account presence config. This will be specified in AccountConfig.
*/
struct AccountPresConfig : public PersistentObject
{
/**
* The optional custom SIP headers to be put in the presence
* subscription request.
*/
SipHeaderVector headers;
/**
* If this flag is set, the presence information of this account will
* be PUBLISH-ed to the server where the account belongs.
*
* Default: PJ_FALSE
*/
bool publishEnabled;
/**
* Specify whether the client publication session should queue the
* PUBLISH request should there be another PUBLISH transaction still
* pending. If this is set to false, the client will return error
* on the PUBLISH request if there is another PUBLISH transaction still
* in progress.
*
* Default: PJSIP_PUBLISHC_QUEUE_REQUEST (TRUE)
*/
bool publishQueue;
/**
* Maximum time to wait for unpublication transaction(s) to complete
* during shutdown process, before sending unregistration. The library
* tries to wait for the unpublication (un-PUBLISH) to complete before
* sending REGISTER request to unregister the account, during library
* shutdown process. If the value is set too short, it is possible that
* the unregistration is sent before unpublication completes, causing
* unpublication request to fail.
*
* Value is in milliseconds.
*
* Default: PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC (2000)
*/
unsigned publishShutdownWaitMsec;
/**
* Optional PIDF tuple ID for outgoing PUBLISH and NOTIFY. If this value
* is not specified, a random string will be used.
*/
string pidfTupleId;
public:
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Account MWI (Message Waiting Indication) settings. This will be specified
* in AccountConfig.
*/
struct AccountMwiConfig : public PersistentObject
{
/**
* Subscribe to message waiting indication events (RFC 3842).
*
* See also UaConfig.mwiUnsolicitedEnabled setting.
*
* Default: FALSE
*/
bool enabled;
/**
* Specify the default expiration time (in seconds) for Message
* Waiting Indication (RFC 3842) event subscription. This must not
* be zero.
*
* Default: PJSIP_MWI_DEFAULT_EXPIRES (3600)
*/
unsigned expirationSec;
public:
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Account's NAT (Network Address Translation) settings. This will be
* specified in AccountConfig.
*/
struct AccountNatConfig : public PersistentObject
{
/**
* Control the use of STUN for the SIP signaling.
*
* Default: PJSUA_STUN_USE_DEFAULT
*/
pjsua_stun_use sipStunUse;
/**
* Control the use of STUN for the media transports.
*
* Default: PJSUA_STUN_USE_DEFAULT
*/
pjsua_stun_use mediaStunUse;
/**
* Enable ICE for the media transport.
*
* Default: False
*/
bool iceEnabled;
/**
* Set the maximum number of ICE host candidates.
*
* Default: -1 (maximum not set)
*/
int iceMaxHostCands;
/**
* Specify whether to use aggressive nomination.
*
* Default: True
*/
bool iceAggressiveNomination;
/**
* For controlling agent if it uses regular nomination, specify the delay
* to perform nominated check (connectivity check with USE-CANDIDATE
* attribute) after all components have a valid pair.
*
* Default value is PJ_ICE_NOMINATED_CHECK_DELAY.
*/
unsigned iceNominatedCheckDelayMsec;
/**
* For a controlled agent, specify how long it wants to wait (in
* milliseconds) for the controlling agent to complete sending
* connectivity check with nominated flag set to true for all components
* after the controlled agent has found that all connectivity checks in
* its checklist have been completed and there is at least one successful
* (but not nominated) check for every component.
*
* Default value for this option is
* ICE_CONTROLLED_AGENT_WAIT_NOMINATION_TIMEOUT. Specify -1 to disable
* this timer.
*/
int iceWaitNominationTimeoutMsec;
/**
* Disable RTCP component.
*
* Default: False
*/
bool iceNoRtcp;
/**
* Always send re-INVITE/UPDATE after ICE negotiation regardless of whether
* the default ICE transport address is changed or not. When this is set
* to False, re-INVITE/UPDATE will be sent only when the default ICE
* transport address is changed.
*
* Default: yes
*/
bool iceAlwaysUpdate;
/**
* Enable TURN candidate in ICE.
*/
bool turnEnabled;
/**
* Specify TURN domain name or host name, in in "DOMAIN:PORT" or
* "HOST:PORT" format.
*/
string turnServer;
/**
* Specify the connection type to be used to the TURN server. Valid
* values are PJ_TURN_TP_UDP or PJ_TURN_TP_TCP.
*
* Default: PJ_TURN_TP_UDP
*/
pj_turn_tp_type turnConnType;
/**
* Specify the username to authenticate with the TURN server.
*/
string turnUserName;
/**
* Specify the type of password. Currently this must be zero to
* indicate plain-text password will be used in the password.
*/
int turnPasswordType;
/**
* Specify the password to authenticate with the TURN server.
*/
string turnPassword;
/**
* This option is used to update the transport address and the Contact
* header of REGISTER request. When this option is enabled, the library
* will keep track of the public IP address from the response of REGISTER
* request. Once it detects that the address has changed, it will
* unregister current Contact, update the Contact with transport address
* learned from Via header, and register a new Contact to the registrar.
* This will also update the public name of UDP transport if STUN is
* configured.
*
* See also contactRewriteMethod field.
*
* Default: TRUE
*/
int contactRewriteUse;
/**
* Specify how Contact update will be done with the registration, if
* \a contactRewriteEnabled is enabled. The value is bitmask combination of
* \a pjsua_contact_rewrite_method. See also pjsua_contact_rewrite_method.
*
* Value PJSUA_CONTACT_REWRITE_UNREGISTER(1) is the legacy behavior.
*
* Default value: PJSUA_CONTACT_REWRITE_METHOD
* (PJSUA_CONTACT_REWRITE_NO_UNREG | PJSUA_CONTACT_REWRITE_ALWAYS_UPDATE)
*/
int contactRewriteMethod;
/**
* Specify if source TCP port should be used as the initial Contact
* address if TCP/TLS transport is used. Note that this feature will
* be automatically turned off when nameserver is configured because
* it may yield different destination address due to DNS SRV resolution.
* Also some platforms are unable to report the local address of the
* TCP socket when it is still connecting. In these cases, this
* feature will also be turned off.
*
* Default: 1 (yes).
*/
int contactUseSrcPort;
/**
* This option is used to overwrite the "sent-by" field of the Via header
* for outgoing messages with the same interface address as the one in
* the REGISTER request, as long as the request uses the same transport
* instance as the previous REGISTER request.
*
* Default: TRUE
*/
int viaRewriteUse;
/**
* This option controls whether the IP address in SDP should be replaced
* with the IP address found in Via header of the REGISTER response, ONLY
* when STUN and ICE are not used. If the value is FALSE (the original
* behavior), then the local IP address will be used. If TRUE, and when
* STUN and ICE are disabled, then the IP address found in registration
* response will be used.
*
* Default: PJ_FALSE (no)
*/
int sdpNatRewriteUse;
/**
* Control the use of SIP outbound feature. SIP outbound is described in
* RFC 5626 to enable proxies or registrar to send inbound requests back
* to UA using the same connection initiated by the UA for its
* registration. This feature is highly useful in NAT-ed deployemtns,
* hence it is enabled by default.
*
* Note: currently SIP outbound can only be used with TCP and TLS
* transports. If UDP is used for the registration, the SIP outbound
* feature will be silently ignored for the account.
*
* Default: TRUE
*/
int sipOutboundUse;
/**
* Specify SIP outbound (RFC 5626) instance ID to be used by this
* account. If empty, an instance ID will be generated based on
* the hostname of this agent. If application specifies this parameter, the
* value will look like "<urn:uuid:00000000-0000-1000-8000-AABBCCDDEEFF>"
* without the double-quotes.
*
* Default: empty
*/
string sipOutboundInstanceId;
/**
* Specify SIP outbound (RFC 5626) registration ID. The default value
* is empty, which would cause the library to automatically generate
* a suitable value.
*
* Default: empty
*/
string sipOutboundRegId;
/**
* Set the interval for periodic keep-alive transmission for this account.
* If this value is zero, keep-alive will be disabled for this account.
* The keep-alive transmission will be sent to the registrar's address,
* after successful registration.
*
* Default: 15 (seconds)
*/
unsigned udpKaIntervalSec;
/**
* Specify the data to be transmitted as keep-alive packets.
*
* Default: CR-LF
*/
string udpKaData;
public:
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Account media config (applicable for both audio and video). This will be
* specified in AccountConfig.
*/
struct AccountMediaConfig : public PersistentObject
{
/**
* Media transport (RTP) configuration.
*/
TransportConfig transportConfig;
/**
* If remote sends SDP answer containing more than one format or codec in
* the media line, send re-INVITE or UPDATE with just one codec to lock
* which codec to use.
*
* Default: True (Yes).
*/
bool lockCodecEnabled;
/**
* Specify whether stream keep-alive and NAT hole punching with
* non-codec-VAD mechanism (see PJMEDIA_STREAM_ENABLE_KA) is enabled
* for this account.
*
* Default: False
*/
bool streamKaEnabled;
/**
* Specify whether secure media transport should be used for this account.
* Valid values are PJMEDIA_SRTP_DISABLED, PJMEDIA_SRTP_OPTIONAL, and
* PJMEDIA_SRTP_MANDATORY.
*
* Default: PJSUA_DEFAULT_USE_SRTP
*/
pjmedia_srtp_use srtpUse;
/**
* Specify whether SRTP requires secure signaling to be used. This option
* is only used when \a use_srtp option above is non-zero.
*
* Valid values are:
* 0: SRTP does not require secure signaling
* 1: SRTP requires secure transport such as TLS
* 2: SRTP requires secure end-to-end transport (SIPS)
*
* Default: PJSUA_DEFAULT_SRTP_SECURE_SIGNALING
*/
int srtpSecureSignaling;
/**
* Specify whether IPv6 should be used on media. Default is not used.
*/
pjsua_ipv6_use ipv6Use;
public:
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Account video config. This will be specified in AccountConfig.
*/
struct AccountVideoConfig : public PersistentObject
{
/**
* Specify whether incoming video should be shown to screen by default.
* This applies to incoming call (INVITE), incoming re-INVITE, and
* incoming UPDATE requests.
*
* Regardless of this setting, application can detect incoming video
* by implementing \a on_call_media_state() callback and enumerating
* the media stream(s) with pjsua_call_get_info(). Once incoming
* video is recognised, application may retrieve the window associated
* with the incoming video and show or hide it with
* pjsua_vid_win_set_show().
*
* Default: False
*/
bool autoShowIncoming;
/**
* Specify whether outgoing video should be activated by default when
* making outgoing calls and/or when incoming video is detected. This
* applies to incoming and outgoing calls, incoming re-INVITE, and
* incoming UPDATE. If the setting is non-zero, outgoing video
* transmission will be started as soon as response to these requests
* is sent (or received).
*
* Regardless of the value of this setting, application can start and
* stop outgoing video transmission with pjsua_call_set_vid_strm().
*
* Default: False
*/
bool autoTransmitOutgoing;
/**
* Specify video window's flags. The value is a bitmask combination of
* pjmedia_vid_dev_wnd_flag.
*
* Default: 0
*/
unsigned windowFlags;
/**
* Specify the default capture device to be used by this account. If
* vidOutAutoTransmit is enabled, this device will be used for
* capturing video.
*
* Default: PJMEDIA_VID_DEFAULT_CAPTURE_DEV
*/
pjmedia_vid_dev_index defaultCaptureDevice;
/**
* Specify the default rendering device to be used by this account.
*
* Default: PJMEDIA_VID_DEFAULT_RENDER_DEV
*/
pjmedia_vid_dev_index defaultRenderDevice;
/**
* Rate control method.
*
* Default: PJMEDIA_VID_STREAM_RC_SIMPLE_BLOCKING.
*/
pjmedia_vid_stream_rc_method rateControlMethod;
/**
* Upstream/outgoing bandwidth. If this is set to zero, the video stream
* will use codec maximum bitrate setting.
*
* Default: 0 (follow codec maximum bitrate).
*/
unsigned rateControlBandwidth;
public:
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Account configuration.
*/
struct AccountConfig : public PersistentObject
{
/**
* Account priority, which is used to control the order of matching
* incoming/outgoing requests. The higher the number means the higher
* the priority is, and the account will be matched first.
*/
int priority;
/**
* The Address of Record or AOR, that is full SIP URL that identifies the
* account. The value can take name address or URL format, and will look
* something like "sip:account@serviceprovider".
*
* This field is mandatory.
*/
string idUri;
/**
* Registration settings.
*/
AccountRegConfig regConfig;
/**
* SIP settings.
*/
AccountSipConfig sipConfig;
/**
* Call settings.
*/
AccountCallConfig callConfig;
/**
* Presence settings.
*/
AccountPresConfig presConfig;
/**
* MWI (Message Waiting Indication) settings.
*/
AccountMwiConfig mwiConfig;
/**
* NAT settings.
*/
AccountNatConfig natConfig;
/**
* Media settings (applicable for both audio and video).
*/
AccountMediaConfig mediaConfig;
/**
* Video settings.
*/
AccountVideoConfig videoConfig;
public:
/**
* Default constructor will initialize with default values.
*/
AccountConfig();
/**
* This will return a temporary pjsua_acc_config instance, which contents
* are only valid as long as this AccountConfig structure remains valid
* AND no modifications are done to it AND no further toPj() function call
* is made. Any call to toPj() function will invalidate the content of
* temporary pjsua_acc_config that was returned by the previous call.
*/
void toPj(pjsua_acc_config &cfg) const;
/**
* Initialize from pjsip.
*/
void fromPj(const pjsua_acc_config &prm, const pjsua_media_config *mcfg);
/**
* Read this object from a container node.
*
* @param node Container to read values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container node.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Account information. Application can query the account information
* by calling Account::getInfo().
*/
struct AccountInfo
{
/**
* The account ID.
*/
pjsua_acc_id id;
/**
* Flag to indicate whether this is the default account.
*/
bool isDefault;
/**
* Account URI
*/
string uri;
/**
* Flag to tell whether this account has registration setting
* (reg_uri is not empty).
*/
bool regIsConfigured;
/**
* Flag to tell whether this account is currently registered
* (has active registration session).
*/
bool regIsActive;
/**
* An up to date expiration interval for account registration session.
*/
int regExpiresSec;
/**
* Last registration status code. If status code is zero, the account
* is currently not registered. Any other value indicates the SIP
* status code of the registration.
*/
pjsip_status_code regStatus;
/**
* String describing the registration status.
*/
string regStatusText;
/**
* Last registration error code. When the status field contains a SIP
* status code that indicates a registration failure, last registration
* error code contains the error code that causes the failure. In any
* other case, its value is zero.
*/
pj_status_t regLastErr;
/**
* Presence online status for this account.
*/
bool onlineStatus;
/**
* Presence online status text.
*/
string onlineStatusText;
public:
/** Import from pjsip data */
void fromPj(const pjsua_acc_info &pai);
};
/**
* This structure contains parameters for onIncomingCall() account callback.
*/
struct OnIncomingCallParam
{
/**
* The library call ID allocated for the new call.
*/
int callId;
/**
* The incoming INVITE request.
*/
SipRxData rdata;
};
/**
* This structure contains parameters for onRegStarted() account callback.
*/
struct OnRegStartedParam
{
/**
* True for registration and False for unregistration.
*/
bool renew;
};
/**
* This structure contains parameters for onRegState() account callback.
*/
struct OnRegStateParam
{
/**
* Registration operation status.
*/
pj_status_t status;
/**
* SIP status code received.
*/
pjsip_status_code code;
/**
* SIP reason phrase received.
*/
string reason;
/**
* The incoming message.
*/
SipRxData rdata;
/**
* Next expiration interval.
*/
int expiration;
};
/**
* This structure contains parameters for onIncomingSubscribe() callback.
*/
struct OnIncomingSubscribeParam
{
/**
* Server presence subscription instance. If application delays
* the acceptance of the request, it will need to specify this object
* when calling Account::presNotify().
*/
void *srvPres;
/**
* Sender URI.
*/
string fromUri;
/**
* The incoming message.
*/
SipRxData rdata;
/**
* The status code to respond to the request. The default value is 200.
* Application may set this to other final status code to accept or
* reject the request.
*/
pjsip_status_code code;
/**
* The reason phrase to respond to the request.
*/
string reason;
/**
* Additional data to be sent with the response, if any.
*/
SipTxOption txOption;
};
/**
* Parameters for onInstantMessage() account callback.
*/
struct OnInstantMessageParam
{
/**
* Sender From URI.
*/
string fromUri;
/**
* To URI of the request.
*/
string toUri;
/**
* Contact URI of the sender.
*/
string contactUri;
/**
* MIME type of the message body.
*/
string contentType;
/**
* The message body.
*/
string msgBody;
/**
* The whole message.
*/
SipRxData rdata;
};
/**
* Parameters for onInstantMessageStatus() account callback.
*/
struct OnInstantMessageStatusParam
{
/**
* Token or a user data that was associated with the pager
* transmission.
*/
Token userData;
/**
* Destination URI.
*/
string toUri;
/**
* The message body.
*/
string msgBody;
/**
* The SIP status code of the transaction.
*/
pjsip_status_code code;
/**
* The reason phrase of the transaction.
*/
string reason;
/**
* The incoming response that causes this callback to be called.
* If the transaction fails because of time out or transport error,
* the content will be empty.
*/
SipRxData rdata;
};
/**
* Parameters for onTypingIndication() account callback.
*/
struct OnTypingIndicationParam
{
/**
* Sender/From URI.
*/
string fromUri;
/**
* To URI.
*/
string toUri;
/**
* The Contact URI.
*/
string contactUri;
/**
* Boolean to indicate if sender is typing.
*/
bool isTyping;
/**
* The whole message buffer.
*/
SipRxData rdata;
};
/**
* Parameters for onMwiInfo() account callback.
*/
struct OnMwiInfoParam
{
/**
* MWI subscription state.
*/
pjsip_evsub_state state;
/**
* The whole message buffer.
*/
SipRxData rdata;
};
/**
* Parameters for presNotify() account method.
*/
struct PresNotifyParam
{
/**
* Server presence subscription instance.
*/
void *srvPres;
/**
* Server presence subscription state to set.
*/
pjsip_evsub_state state;
/**
* Optionally specify the state string name, if state is not "active",
* "pending", or "terminated".
*/
string stateStr;
/**
* If the new state is PJSIP_EVSUB_STATE_TERMINATED, optionally specify
* the termination reason.
*/
string reason;
/**
* If the new state is PJSIP_EVSUB_STATE_TERMINATED, this specifies
* whether the NOTIFY request should contain message body containing
* account's presence information.
*/
bool withBody;
/**
* Optional list of headers to be sent with the NOTIFY request.
*/
SipTxOption txOption;
};
/**
* Wrapper class for Buddy matching algo.
*
* Default algo is a simple substring lookup of search-token in the
* Buddy URIs, with case sensitive. Application can implement its own
* matching algo by overriding this class and specifying its instance
* in Account::findBuddy().
*/
class FindBuddyMatch
{
public:
/**
* Default algo implementation.
*/
virtual bool match(const string &token, const Buddy &buddy)
{
BuddyInfo bi = buddy.getInfo();
return bi.uri.find(token) != string::npos;
}
/**
* Destructor.
*/
virtual ~FindBuddyMatch() {}
};
/**
* Account.
*/
class Account
{
public:
/**
* Constructor.
*/
Account();
/**
* Destructor. Note that if the account is deleted, it will also delete
* the corresponding account in the PJSUA-LIB.
*/
virtual ~Account();
/**
* Create the account.
*
* @param cfg The account config.
* @param make_default Make this the default account.
*/
void create(const AccountConfig &cfg,
bool make_default=false) throw(Error);
/**
* Modify the account to use the specified account configuration.
* Depending on the changes, this may cause unregistration or
* reregistration on the account.
*
* @param cfg New account config to be applied to the
* account.
*/
void modify(const AccountConfig &cfg) throw(Error);
/**
* Check if this account is still valid.
*
* @return True if it is.
*/
bool isValid() const;
/**
* Set this as default account to be used when incoming and outgoing
* requests don't match any accounts.
*
* @return PJ_SUCCESS on success.
*/
void setDefault() throw(Error);
/**
* Check if this account is the default account. Default account will be
* used for incoming and outgoing requests that don't match any other
* accounts.
*
* @return True if this is the default account.
*/
bool isDefault() const;
/**
* Get PJSUA-LIB account ID or index associated with this account.
*
* @return Integer greater than or equal to zero.
*/
int getId() const;
/**
* Get the Account class for the specified account Id.
*
* @param acc_id The account ID to lookup
*
* @return The Account instance or NULL if not found.
*/
static Account *lookup(int acc_id);
/**
* Get account info.
*
* @return Account info.
*/
AccountInfo getInfo() const throw(Error);
/**
* Update registration or perform unregistration. Application normally
* only needs to call this function if it wants to manually update the
* registration or to unregister from the server.
*
* @param renew If False, this will start unregistration
* process.
*/
void setRegistration(bool renew) throw(Error);
/**
* Set or modify account's presence online status to be advertised to
* remote/presence subscribers. This would trigger the sending of
* outgoing NOTIFY request if there are server side presence subscription
* for this account, and/or outgoing PUBLISH if presence publication is
* enabled for this account.
*
* @param pres_st Presence online status.
*/
void setOnlineStatus(const PresenceStatus &pres_st) throw(Error);
/**
* Lock/bind this account to a specific transport/listener. Normally
* application shouldn't need to do this, as transports will be selected
* automatically by the library according to the destination.
*
* When account is locked/bound to a specific transport, all outgoing
* requests from this account will use the specified transport (this
* includes SIP registration, dialog (call and event subscription), and
* out-of-dialog requests such as MESSAGE).
*
* Note that transport id may be specified in AccountConfig too.
*
* @param tp_id The transport ID.
*/
void setTransport(TransportId tp_id) throw(Error);
/**
* Send NOTIFY to inform account presence status or to terminate server
* side presence subscription. If application wants to reject the incoming
* request, it should set the param \a PresNotifyParam.state to
* PJSIP_EVSUB_STATE_TERMINATED.
*
* @param prm The sending NOTIFY parameter.
*/
void presNotify(const PresNotifyParam &prm) throw(Error);
/**
* Enumerate all buddies of the account.
*
* @return The buddy list.
*/
const BuddyVector& enumBuddies() const throw(Error);
/**
* Find a buddy in the buddy list with the specified URI.
*
* Exception: if buddy is not found, PJ_ENOTFOUND will be thrown.
*
* @param uri The buddy URI.
* @param buddy_match The buddy match algo.
*
* @return The pointer to buddy.
*/
Buddy* findBuddy(string uri, FindBuddyMatch *buddy_match = NULL) const
throw(Error);
/**
* An internal function to add a Buddy to Account buddy list.
* This function must never be used by application.
*/
void addBuddy(Buddy *buddy);
/**
* An internal function to remove a Buddy from Account buddy list.
* This function must never be used by application.
*/
void removeBuddy(Buddy *buddy);
public:
/*
* Callbacks
*/
/**
* Notify application on incoming call.
*
* @param prm Callback parameter.
*/
virtual void onIncomingCall(OnIncomingCallParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Notify application when registration or unregistration has been
* initiated. Note that this only notifies the initial registration
* and unregistration. Once registration session is active, subsequent
* refresh will not cause this callback to be called.
*
* @param prm Callback parameter.
*/
virtual void onRegStarted(OnRegStartedParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Notify application when registration status has changed.
* Application may then query the account info to get the
* registration details.
*
* @param prm Callback parameter.
*/
virtual void onRegState(OnRegStateParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Notification when incoming SUBSCRIBE request is received. Application
* may use this callback to authorize the incoming subscribe request
* (e.g. ask user permission if the request should be granted).
*
* If this callback is not implemented, all incoming presence subscription
* requests will be accepted.
*
* If this callback is implemented, application has several choices on
* what to do with the incoming request:
* - it may reject the request immediately by specifying non-200 class
* final response in the IncomingSubscribeParam.code parameter.
* - it may immediately accept the request by specifying 200 as the
* IncomingSubscribeParam.code parameter. This is the default value if
* application doesn't set any value to the IncomingSubscribeParam.code
* parameter. In this case, the library will automatically send NOTIFY
* request upon returning from this callback.
* - it may delay the processing of the request, for example to request
* user permission whether to accept or reject the request. In this
* case, the application MUST set the IncomingSubscribeParam.code
* argument to 202, then IMMEDIATELY calls presNotify() with
* state PJSIP_EVSUB_STATE_PENDING and later calls presNotify()
* again to accept or reject the subscription request.
*
* Any IncomingSubscribeParam.code other than 200 and 202 will be treated
* as 200.
*
* Application MUST return from this callback immediately (e.g. it must
* not block in this callback while waiting for user confirmation).
*
* @param prm Callback parameter.
*/
virtual void onIncomingSubscribe(OnIncomingSubscribeParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Notify application on incoming instant message or pager (i.e. MESSAGE
* request) that was received outside call context.
*
* @param prm Callback parameter.
*/
virtual void onInstantMessage(OnInstantMessageParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Notify application about the delivery status of outgoing pager/instant
* message (i.e. MESSAGE) request.
*
* @param prm Callback parameter.
*/
virtual void onInstantMessageStatus(OnInstantMessageStatusParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Notify application about typing indication.
*
* @param prm Callback parameter.
*/
virtual void onTypingIndication(OnTypingIndicationParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Notification about MWI (Message Waiting Indication) status change.
* This callback can be called upon the status change of the
* SUBSCRIBE request (for example, 202/Accepted to SUBSCRIBE is received)
* or when a NOTIFY reqeust is received.
*
* @param prm Callback parameter.
*/
virtual void onMwiInfo(OnMwiInfoParam &prm)
{ PJ_UNUSED_ARG(prm); }
protected:
friend class Endpoint;
private:
pjsua_acc_id id;
string tmpReason; // for saving response's reason
BuddyVector buddyList;
};
/**
* @} // PJSUA2_ACC
*/
} // namespace pj
#endif /* __PJSUA2_ACCOUNT_HPP__ */
|