/usr/include/pjsua2/endpoint.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 | /* $Id: endpoint.hpp 5297 2016-05-13 10:56:48Z ming $ */
/*
* 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_UA_HPP__
#define __PJSUA2_UA_HPP__
/**
* @file pjsua2/endpoint.hpp
* @brief PJSUA2 Base Agent Operation
*/
#include <pjsua2/persistent.hpp>
#include <pjsua2/media.hpp>
#include <pjsua2/siptypes.hpp>
#include <list>
#include <map>
/** PJSUA2 API is inside pj namespace */
namespace pj
{
/**
* @defgroup PJSUA2_UA Endpoint
* @ingroup PJSUA2_Ref
* @{
*/
using std::string;
using std::vector;
//////////////////////////////////////////////////////////////////////////////
/**
* Argument to Endpoint::onNatDetectionComplete() callback.
*/
struct OnNatDetectionCompleteParam
{
/**
* Status of the detection process. If this value is not PJ_SUCCESS,
* the detection has failed and \a nat_type field will contain
* PJ_STUN_NAT_TYPE_UNKNOWN.
*/
pj_status_t status;
/**
* The text describing the status, if the status is not PJ_SUCCESS.
*/
string reason;
/**
* This contains the NAT type as detected by the detection procedure.
* This value is only valid when the \a status is PJ_SUCCESS.
*/
pj_stun_nat_type natType;
/**
* Text describing that NAT type.
*/
string natTypeName;
};
/**
* Argument to Endpoint::onNatCheckStunServersComplete() callback.
*/
struct OnNatCheckStunServersCompleteParam
{
/**
* Arbitrary user data that was passed to Endpoint::natCheckStunServers()
* function.
*/
Token userData;
/**
* This will contain PJ_SUCCESS if at least one usable STUN server
* is found, otherwise it will contain the last error code during
* the operation.
*/
pj_status_t status;
/**
* The server name that yields successful result. This will only
* contain value if status is successful.
*/
string name;
/**
* The server IP address and port in "IP:port" format. This will only
* contain value if status is successful.
*/
SocketAddress addr;
};
/**
* Parameter of Endpoint::onTimer() callback.
*/
struct OnTimerParam
{
/**
* Arbitrary user data that was passed to Endpoint::utilTimerSchedule()
* function.
*/
Token userData;
/**
* The interval of this timer, in miliseconds.
*/
unsigned msecDelay;
};
/**
* Parameter of Endpoint::onTransportState() callback.
*/
struct OnTransportStateParam
{
/**
* The transport handle.
*/
TransportHandle hnd;
/**
* Transport current state.
*/
pjsip_transport_state state;
/**
* The last error code related to the transport state.
*/
pj_status_t lastError;
};
/**
* Parameter of Endpoint::onSelectAccount() callback.
*/
struct OnSelectAccountParam
{
/**
* The incoming request.
*/
SipRxData rdata;
/**
* The account index to be used to handle the request.
* Upon entry, this will be filled by the account index
* chosen by the library. Application may change it to
* another value to use another account.
*/
int accountIndex;
};
//////////////////////////////////////////////////////////////////////////////
/**
* SIP User Agent related settings.
*/
struct UaConfig : public PersistentObject
{
/**
* Maximum calls to support (default: 4). The value specified here
* must be smaller than the compile time maximum settings
* PJSUA_MAX_CALLS, which by default is 32. To increase this
* limit, the library must be recompiled with new PJSUA_MAX_CALLS
* value.
*/
unsigned maxCalls;
/**
* Number of worker threads. Normally application will want to have at
* least one worker thread, unless when it wants to poll the library
* periodically, which in this case the worker thread can be set to
* zero.
*/
unsigned threadCnt;
/**
* When this flag is non-zero, all callbacks that come from thread
* other than main thread will be posted to the main thread and
* to be executed by Endpoint::libHandleEvents() function. This
* includes the logging callback. Note that this will only work if
* threadCnt is set to zero and Endpoint::libHandleEvents() is
* performed by main thread. By default, the main thread is set
* from the thread that invoke Endpoint::libCreate()
*
* Default: false
*/
bool mainThreadOnly;
/**
* Array of nameservers to be used by the SIP resolver subsystem.
* The order of the name server specifies the priority (first name
* server will be used first, unless it is not reachable).
*/
StringVector nameserver;
/**
* Optional user agent string (default empty). If it's empty, no
* User-Agent header will be sent with outgoing requests.
*/
string userAgent;
/**
* Array of STUN servers to try. The library will try to resolve and
* contact each of the STUN server entry until it finds one that is
* usable. Each entry may be a domain name, host name, IP address, and
* it may contain an optional port number. For example:
* - "pjsip.org" (domain name)
* - "sip.pjsip.org" (host name)
* - "pjsip.org:33478" (domain name and a non-standard port number)
* - "10.0.0.1:3478" (IP address and port number)
*
* When nameserver is configured in the \a pjsua_config.nameserver field,
* if entry is not an IP address, it will be resolved with DNS SRV
* resolution first, and it will fallback to use DNS A resolution if this
* fails. Port number may be specified even if the entry is a domain name,
* in case the DNS SRV resolution should fallback to a non-standard port.
*
* When nameserver is not configured, entries will be resolved with
* pj_gethostbyname() if it's not an IP address. Port number may be
* specified if the server is not listening in standard STUN port.
*/
StringVector stunServer;
/**
* This specifies if the library startup should ignore failure with the
* STUN servers. If this is set to PJ_FALSE, the library will refuse to
* start if it fails to resolve or contact any of the STUN servers.
*
* Default: TRUE
*/
bool stunIgnoreFailure;
/**
* Support for adding and parsing NAT type in the SDP to assist
* troubleshooting. The valid values are:
* - 0: no information will be added in SDP, and parsing is disabled.
* - 1: only the NAT type number is added.
* - 2: add both NAT type number and name.
*
* Default: 1
*/
int natTypeInSdp;
/**
* Handle unsolicited NOTIFY requests containing message waiting
* indication (MWI) info. Unsolicited MWI is incoming NOTIFY requests
* which are not requested by client with SUBSCRIBE request.
*
* If this is enabled, the library will respond 200/OK to the NOTIFY
* request and forward the request to Endpoint::onMwiInfo() callback.
*
* See also AccountMwiConfig.enabled.
*
* Default: PJ_TRUE
*/
bool mwiUnsolicitedEnabled;
public:
/**
* Default constructor to initialize with default values.
*/
UaConfig();
/**
* Construct from pjsua_config.
*/
void fromPj(const pjsua_config &ua_cfg);
/**
* Export to pjsua_config
*/
pjsua_config toPj() const;
/**
* Read this object from a container.
*
* @param node Container to write values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Data containing log entry to be written by the LogWriter.
*/
struct LogEntry
{
/** Log verbosity level of this message */
int level;
/** The log message */
string msg;
/** ID of current thread */
long threadId;
/** The name of the thread that writes this log */
string threadName;
};
/**
* Interface for writing log messages. Applications can inherit this class
* and supply it in the LogConfig structure to implement custom log
* writing facility.
*/
class LogWriter
{
public:
/** Destructor */
virtual ~LogWriter() {}
/** Write a log entry. */
virtual void write(const LogEntry &entry) = 0;
};
/**
* Logging configuration, which can be (optionally) specified when calling
* Lib::init().
*/
struct LogConfig : public PersistentObject
{
/** Log incoming and outgoing SIP message? Yes! */
unsigned msgLogging;
/** Input verbosity level. Value 5 is reasonable. */
unsigned level;
/** Verbosity level for console. Value 4 is reasonable. */
unsigned consoleLevel;
/** Log decoration. */
unsigned decor;
/** Optional log filename if app wishes the library to write to log file.
*/
string filename;
/**
* Additional flags to be given to pj_file_open() when opening
* the log file. By default, the flag is PJ_O_WRONLY. Application
* may set PJ_O_APPEND here so that logs are appended to existing
* file instead of overwriting it.
*
* Default is 0.
*/
unsigned fileFlags;
/**
* Custom log writer, if required. This instance will be destroyed
* by the endpoint when the endpoint is destroyed.
*/
LogWriter *writer;
public:
/** Default constructor initialises with default values */
LogConfig();
/** Construct from pjsua_logging_config */
void fromPj(const pjsua_logging_config &lc);
/** Generate pjsua_logging_config. */
pjsua_logging_config toPj() const;
/**
* Read this object from a container.
*
* @param node Container to write values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* This structure describes media configuration, which will be specified
* when calling Lib::init().
*/
struct MediaConfig : public PersistentObject
{
public:
/**
* Clock rate to be applied to the conference bridge.
* If value is zero, default clock rate will be used
* (PJSUA_DEFAULT_CLOCK_RATE, which by default is 16KHz).
*/
unsigned clockRate;
/**
* Clock rate to be applied when opening the sound device.
* If value is zero, conference bridge clock rate will be used.
*/
unsigned sndClockRate;
/**
* Channel count be applied when opening the sound device and
* conference bridge.
*/
unsigned channelCount;
/**
* Specify audio frame ptime. The value here will affect the
* samples per frame of both the sound device and the conference
* bridge. Specifying lower ptime will normally reduce the
* latency.
*
* Default value: PJSUA_DEFAULT_AUDIO_FRAME_PTIME
*/
unsigned audioFramePtime;
/**
* Specify maximum number of media ports to be created in the
* conference bridge. Since all media terminate in the bridge
* (calls, file player, file recorder, etc), the value must be
* large enough to support all of them. However, the larger
* the value, the more computations are performed.
*
* Default value: PJSUA_MAX_CONF_PORTS
*/
unsigned maxMediaPorts;
/**
* Specify whether the media manager should manage its own
* ioqueue for the RTP/RTCP sockets. If yes, ioqueue will be created
* and at least one worker thread will be created too. If no,
* the RTP/RTCP sockets will share the same ioqueue as SIP sockets,
* and no worker thread is needed.
*
* Normally application would say yes here, unless it wants to
* run everything from a single thread.
*/
bool hasIoqueue;
/**
* Specify the number of worker threads to handle incoming RTP
* packets. A value of one is recommended for most applications.
*/
unsigned threadCnt;
/**
* Media quality, 0-10, according to this table:
* 5-10: resampling use large filter,
* 3-4: resampling use small filter,
* 1-2: resampling use linear.
* The media quality also sets speex codec quality/complexity to the
* number.
*
* Default: 5 (PJSUA_DEFAULT_CODEC_QUALITY).
*/
unsigned quality;
/**
* Specify default codec ptime.
*
* Default: 0 (codec specific)
*/
unsigned ptime;
/**
* Disable VAD?
*
* Default: 0 (no (meaning VAD is enabled))
*/
bool noVad;
/**
* iLBC mode (20 or 30).
*
* Default: 30 (PJSUA_DEFAULT_ILBC_MODE)
*/
unsigned ilbcMode;
/**
* Percentage of RTP packet to drop in TX direction
* (to simulate packet lost).
*
* Default: 0
*/
unsigned txDropPct;
/**
* Percentage of RTP packet to drop in RX direction
* (to simulate packet lost).
*
* Default: 0
*/
unsigned rxDropPct;
/**
* Echo canceller options (see pjmedia_echo_create())
*
* Default: 0.
*/
unsigned ecOptions;
/**
* Echo canceller tail length, in miliseconds. Setting this to zero
* will disable echo cancellation.
*
* Default: PJSUA_DEFAULT_EC_TAIL_LEN
*/
unsigned ecTailLen;
/**
* Audio capture buffer length, in milliseconds.
*
* Default: PJMEDIA_SND_DEFAULT_REC_LATENCY
*/
unsigned sndRecLatency;
/**
* Audio playback buffer length, in milliseconds.
*
* Default: PJMEDIA_SND_DEFAULT_PLAY_LATENCY
*/
unsigned sndPlayLatency;
/**
* Jitter buffer initial prefetch delay in msec. The value must be
* between jb_min_pre and jb_max_pre below.
*
* Default: -1 (to use default stream settings, currently 150 msec)
*/
int jbInit;
/**
* Jitter buffer minimum prefetch delay in msec.
*
* Default: -1 (to use default stream settings, currently 60 msec)
*/
int jbMinPre;
/**
* Jitter buffer maximum prefetch delay in msec.
*
* Default: -1 (to use default stream settings, currently 240 msec)
*/
int jbMaxPre;
/**
* Set maximum delay that can be accomodated by the jitter buffer msec.
*
* Default: -1 (to use default stream settings, currently 360 msec)
*/
int jbMax;
/**
* Specify idle time of sound device before it is automatically closed,
* in seconds. Use value -1 to disable the auto-close feature of sound
* device
*
* Default : 1
*/
int sndAutoCloseTime;
/**
* Specify whether built-in/native preview should be used if available.
* In some systems, video input devices have built-in capability to show
* preview window of the device. Using this built-in preview is preferable
* as it consumes less CPU power. If built-in preview is not available,
* the library will perform software rendering of the input. If this
* field is set to PJ_FALSE, software preview will always be used.
*
* Default: PJ_TRUE
*/
bool vidPreviewEnableNative;
public:
/** Default constructor initialises with default values */
MediaConfig();
/** Construct from pjsua_media_config. */
void fromPj(const pjsua_media_config &mc);
/** Export */
pjsua_media_config toPj() const;
/**
* Read this object from a container.
*
* @param node Container to write values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/**
* Endpoint configuration
*/
struct EpConfig : public PersistentObject
{
/** UA config */
UaConfig uaConfig;
/** Logging config */
LogConfig logConfig;
/** Media config */
MediaConfig medConfig;
/**
* Read this object from a container.
*
* @param node Container to write values from.
*/
virtual void readObject(const ContainerNode &node) throw(Error);
/**
* Write this object to a container.
*
* @param node Container to write values to.
*/
virtual void writeObject(ContainerNode &node) const throw(Error);
};
/* This represents posted job */
struct PendingJob
{
/** Perform the job */
virtual void execute(bool is_pending) = 0;
/** Virtual destructor */
virtual ~PendingJob() {}
};
//////////////////////////////////////////////////////////////////////////////
/**
* Endpoint represents an instance of pjsua library. There can only be
* one instance of pjsua library in an application, hence this class
* is a singleton.
*/
class Endpoint
{
public:
/** Retrieve the singleton instance of the endpoint */
static Endpoint &instance() throw(Error);
/** Default constructor */
Endpoint();
/** Virtual destructor */
virtual ~Endpoint();
/*************************************************************************
* Base library operations
*/
/**
* Get library version.
*/
Version libVersion() const;
/**
* Instantiate pjsua application. Application must call this function before
* calling any other functions, to make sure that the underlying libraries
* are properly initialized. Once this function has returned success,
* application must call libDestroy() before quitting.
*/
void libCreate() throw(Error);
/**
* Get library state.
*
* @return library state.
*/
pjsua_state libGetState() const;
/**
* Initialize pjsua with the specified settings. All the settings are
* optional, and the default values will be used when the config is not
* specified.
*
* Note that create() MUST be called before calling this function.
*
* @param prmEpConfig Endpoint configurations
*/
void libInit( const EpConfig &prmEpConfig) throw(Error);
/**
* Call this function after all initialization is done, so that the
* library can do additional checking set up. Application may call this
* function any time after init().
*/
void libStart() throw(Error);
/**
* Register a thread that was created by external or native API to the
* library. Note that each time this function is called, it will allocate
* some memory to store the thread description, which will only be freed
* when the library is destroyed.
*
* @param name The optional name to be assigned to the thread.
*/
void libRegisterThread(const string &name) throw(Error);
/**
* Check if this thread has been registered to the library. Note that
* this function is only applicable for library main & worker threads and
* external/native threads registered using libRegisterThread().
*/
bool libIsThreadRegistered();
/**
* Stop all worker threads.
*/
void libStopWorkerThreads();
/**
* Poll pjsua for events, and if necessary block the caller thread for
* the specified maximum interval (in miliseconds).
*
* Application doesn't normally need to call this function if it has
* configured worker thread (\a thread_cnt field) in pjsua_config
* structure, because polling then will be done by these worker threads
* instead.
*
* If EpConfig::UaConfig::mainThreadOnly is enabled and this function
* is called from the main thread (by default the main thread is thread
* that calls libCreate()), this function will also scan and run any
* pending jobs in the list.
*
* @param msec_timeout Maximum time to wait, in miliseconds.
*
* @return The number of events that have been handled during the
* poll. Negative value indicates error, and application
* can retrieve the error as (status = -return_value).
*/
int libHandleEvents(unsigned msec_timeout);
/**
* Destroy pjsua. Application is recommended to perform graceful shutdown
* before calling this function (such as unregister the account from the
* SIP server, terminate presense subscription, and hangup active calls),
* however, this function will do all of these if it finds there are
* active sessions that need to be terminated. This function will
* block for few seconds to wait for replies from remote.
*
* Application.may safely call this function more than once if it doesn't
* keep track of it's state.
*
* @param prmFlags Combination of pjsua_destroy_flag enumeration.
*/
void libDestroy(unsigned prmFlags=0) throw(Error);
/*************************************************************************
* Utilities
*/
/**
* Retrieve the error string for the specified status code.
*
* @param prmErr The error code.
*/
string utilStrError(pj_status_t prmErr);
/**
* Write a log message.
*
* @param prmLevel Log verbosity level (1-5)
* @param prmSender The log sender.
* @param prmMsg The log message.
*/
void utilLogWrite(int prmLevel,
const string &prmSender,
const string &prmMsg);
/**
* Write a log entry.
*
* @param e The log entry.
*/
void utilLogWrite(LogEntry &e);
/**
* This is a utility function to verify that valid SIP url is given. If the
* URL is a valid SIP/SIPS scheme, PJ_SUCCESS will be returned.
*
* @param prmUri The URL string.
*
* @return PJ_SUCCESS on success, or the appropriate error
* code.
*
* @see utilVerifyUri()
*/
pj_status_t utilVerifySipUri(const string &prmUri);
/**
* This is a utility function to verify that valid URI is given. Unlike
* utilVerifySipUri(), this function will return PJ_SUCCESS if tel: URI
* is given.
*
* @param prmUri The URL string.
*
* @return PJ_SUCCESS on success, or the appropriate error
* code.
*
* @see pjsua_verify_sip_url()
*/
pj_status_t utilVerifyUri(const string &prmUri);
/**
* Schedule a timer with the specified interval and user data. When the
* interval elapsed, onTimer() callback will be
* called. Note that the callback may be executed by different thread,
* depending on whether worker thread is enabled or not.
*
* @param prmMsecDelay The time interval in msec.
* @param prmUserData Arbitrary user data, to be given back to
* application in the callback.
*
* @return Token to identify the timer, which could be
* given to utilTimerCancel().
*/
Token utilTimerSchedule(unsigned prmMsecDelay,
Token prmUserData) throw (Error);
/**
* Cancel previously scheduled timer with the specified timer token.
*
* @param prmToken The timer token, which was returned from
* previous utilTimerSchedule() call.
*/
void utilTimerCancel(Token prmToken);
/**
* Utility to register a pending job to be executed by main thread.
* If EpConfig::UaConfig::mainThreadOnly is false, the job will be
* executed immediately.
*
* @param job The job class.
*/
void utilAddPendingJob(PendingJob *job);
/**
* Get cipher list supported by SSL/TLS backend.
*/
IntVector utilSslGetAvailableCiphers() throw (Error);
/*************************************************************************
* NAT operations
*/
/**
* This is a utility function to detect NAT type in front of this endpoint.
* Once invoked successfully, this function will complete asynchronously
* and report the result in onNatDetectionComplete().
*
* After NAT has been detected and the callback is called, application can
* get the detected NAT type by calling natGetType(). Application
* can also perform NAT detection by calling natDetectType()
* again at later time.
*
* Note that STUN must be enabled to run this function successfully.
*/
void natDetectType(void) throw(Error);
/**
* Get the NAT type as detected by natDetectType() function. This
* function will only return useful NAT type after natDetectType()
* has completed successfully and onNatDetectionComplete()
* callback has been called.
*
* Exception: if this function is called while detection is in progress,
* PJ_EPENDING exception will be raised.
*/
pj_stun_nat_type natGetType() throw(Error);
/**
* Update the STUN servers list. The libInit() must have been called
* before calling this function.
*
* @param prmServers Array of STUN servers to try. The endpoint
* will try to resolve and contact each of the
* STUN server entry until it finds one that is
* usable. Each entry may be a domain name, host
* name, IP address, and it may contain an
* optional port number. For example:
* - "pjsip.org" (domain name)
* - "sip.pjsip.org" (host name)
* - "pjsip.org:33478" (domain name and a non-
* standard port number)
* - "10.0.0.1:3478" (IP address and port number)
* @param prmWait Specify if the function should block until
* it gets the result. In this case, the
* function will block while the resolution
* is being done, and the callback
* onNatCheckStunServersComplete() will be called
* before this function returns.
*
*/
void natUpdateStunServers(const StringVector &prmServers,
bool prmWait) throw(Error);
/**
* Auxiliary function to resolve and contact each of the STUN server
* entries (sequentially) to find which is usable. The libInit() must
* have been called before calling this function.
*
* @param prmServers Array of STUN servers to try. The endpoint
* will try to resolve and contact each of the
* STUN server entry until it finds one that is
* usable. Each entry may be a domain name, host
* name, IP address, and it may contain an
* optional port number. For example:
* - "pjsip.org" (domain name)
* - "sip.pjsip.org" (host name)
* - "pjsip.org:33478" (domain name and a non-
* standard port number)
* - "10.0.0.1:3478" (IP address and port number)
* @param prmWait Specify if the function should block until
* it gets the result. In this case, the function
* will block while the resolution is being done,
* and the callback will be called before this
* function returns.
* @param prmUserData Arbitrary user data to be passed back to
* application in the callback.
*
* @see natCancelCheckStunServers()
*/
void natCheckStunServers(const StringVector &prmServers,
bool prmWait,
Token prmUserData) throw(Error);
/**
* Cancel pending STUN resolution which match the specified token.
*
* @param token The token to match. This token was given to
* natCheckStunServers()
* @param notify_cb Boolean to control whether the callback should
* be called for cancelled resolutions. When the
* callback is called, the status in the result
* will be set as PJ_ECANCELLED.
*
* Exception: PJ_ENOTFOUND if there is no matching one, or other error.
*/
void natCancelCheckStunServers(Token token,
bool notify_cb = false) throw(Error);
/*************************************************************************
* Transport operations
*/
/**
* Create and start a new SIP transport according to the specified
* settings.
*
* @param type Transport type.
* @param cfg Transport configuration.
*
* @return The transport ID.
*/
TransportId transportCreate(pjsip_transport_type_e type,
const TransportConfig &cfg) throw(Error);
/**
* Enumerate all transports currently created in the system. This
* function will return all transport IDs, and application may then
* call transportGetInfo() function to retrieve detailed information
* about the transport.
*
* @return Array of transport IDs.
*/
IntVector transportEnum() throw(Error);
/**
* Get information about transport.
*
* @param id Transport ID.
*
* @return Transport info.
*/
TransportInfo transportGetInfo(TransportId id) throw(Error);
/**
* Disable a transport or re-enable it. By default transport is always
* enabled after it is created. Disabling a transport does not necessarily
* close the socket, it will only discard incoming messages and prevent
* the transport from being used to send outgoing messages.
*
* @param id Transport ID.
* @param enabled Enable or disable the transport.
*
*/
void transportSetEnable(TransportId id, bool enabled) throw(Error);
/**
* Close the transport. The system will wait until all transactions are
* closed while preventing new users from using the transport, and will
* close the transport when its usage count reaches zero.
*
* @param id Transport ID.
*/
void transportClose(TransportId id) throw(Error);
/*************************************************************************
* Call operations
*/
/**
* Terminate all calls. This will initiate call hangup for all
* currently active calls.
*/
void hangupAllCalls(void);
/*************************************************************************
* Media operations
*/
/**
* Add media to the media list.
*
* @param media media to be added.
*/
void mediaAdd(AudioMedia &media);
/**
* Remove media from the media list.
*
* @param media media to be removed.
*/
void mediaRemove(AudioMedia &media);
/**
* Check if media has been added to the media list.
*
* @param media media to be check.
*
* @return True if media has been added, false otherwise.
*/
bool mediaExists(const AudioMedia &media) const;
/**
* Get maximum number of media port.
*
* @return Maximum number of media port in the conference bridge.
*/
unsigned mediaMaxPorts() const;
/**
* Get current number of active media port in the bridge.
*
* @return The number of active media port.
*/
unsigned mediaActivePorts() const;
/**
* Enumerate all media port.
*
* @return The list of media port.
*/
const AudioMediaVector &mediaEnumPorts() const throw(Error);
/**
* Get the instance of Audio Device Manager.
*
* @return The Audio Device Manager.
*/
AudDevManager &audDevManager();
/**
* Get the instance of Video Device Manager.
*
* @return The Video Device Manager.
*/
VidDevManager &vidDevManager();
/*************************************************************************
* Codec management operations
*/
/**
* Enum all supported codecs in the system.
*
* @return Array of codec info.
*/
const CodecInfoVector &codecEnum() throw(Error);
/**
* Change codec priority.
*
* @param codec_id Codec ID, which is a string that uniquely identify
* the codec (such as "speex/8000").
* @param priority Codec priority, 0-255, where zero means to disable
* the codec.
*
*/
void codecSetPriority(const string &codec_id,
pj_uint8_t priority) throw(Error);
/**
* Get codec parameters.
*
* @param codec_id Codec ID.
*
* @return Codec parameters. If codec is not found, Error
* will be thrown.
*
*/
CodecParam codecGetParam(const string &codec_id) const throw(Error);
/**
* Set codec parameters.
*
* @param codec_id Codec ID.
* @param param Codec parameter to set. Set to NULL to reset
* codec parameter to library default settings.
*
*/
void codecSetParam(const string &codec_id,
const CodecParam param) throw(Error);
/**
* Enum all supported video codecs in the system.
*
* @return Array of video codec info.
*/
const CodecInfoVector &videoCodecEnum() throw(Error);
/**
* Change video codec priority.
*
* @param codec_id Codec ID, which is a string that uniquely identify
* the codec (such as "H263/90000"). Please see pjsua
* manual or pjmedia codec reference for details.
* @param priority Codec priority, 0-255, where zero means to disable
* the codec.
*
*/
void videoCodecSetPriority(const string &codec_id,
pj_uint8_t priority) throw(Error);
/**
* Get video codec parameters.
*
* @param codec_id Codec ID.
*
* @return Codec parameters. If codec is not found, Error
* will be thrown.
*
*/
VidCodecParam getVideoCodecParam(const string &codec_id) const throw(Error);
/**
* Set video codec parameters.
*
* @param codec_id Codec ID.
* @param param Codec parameter to set.
*
*/
void setVideoCodecParam(const string &codec_id,
const VidCodecParam ¶m) throw(Error);
/**
* Reset video codec parameters to library default settings.
*
* @param codec_id Codec ID.
*
*/
void resetVideoCodecParam(const string &codec_id) throw(Error);
public:
/*
* Overrideables callbacks
*/
/**
* Callback when the Endpoint has finished performing NAT type
* detection that is initiated with natDetectType().
*
* @param prm Callback parameters containing the detection
* result.
*/
virtual void onNatDetectionComplete(
const OnNatDetectionCompleteParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Callback when the Endpoint has finished performing STUN server
* checking that is initiated when calling libInit(), or by
* calling natCheckStunServers() or natUpdateStunServers().
*
* @param prm Callback parameters.
*/
virtual void onNatCheckStunServersComplete(
const OnNatCheckStunServersCompleteParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* This callback is called when transport state has changed.
*
* @param prm Callback parameters.
*/
virtual void onTransportState(
const OnTransportStateParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* Callback when a timer has fired. The timer was scheduled by
* utilTimerSchedule().
*
* @param prm Callback parameters.
*/
virtual void onTimer(const OnTimerParam &prm)
{ PJ_UNUSED_ARG(prm); }
/**
* This callback can be used by application to override the account
* to be used to handle an incoming message. Initially, the account to
* be used will be calculated automatically by the library. This initial
* account will be used if application does not implement this callback,
* or application sets an invalid account upon returning from this
* callback.
*
* Note that currently the incoming messages requiring account assignment
* are INVITE, MESSAGE, SUBSCRIBE, and unsolicited NOTIFY. This callback
* may be called before the callback of the SIP event itself, i.e:
* incoming call, pager, subscription, or unsolicited-event.
*
* @param prm Callback parameters.
*/
virtual void onSelectAccount(OnSelectAccountParam &prm)
{ PJ_UNUSED_ARG(prm); }
private:
static Endpoint *instance_; // static instance
LogWriter *writer; // Custom writer, if any
AudioMediaVector mediaList;
AudDevManager audioDevMgr;
VidDevManager videoDevMgr;
CodecInfoVector codecInfoList;
CodecInfoVector videoCodecInfoList;
std::map<pj_thread_t*, pj_thread_desc*> threadDescMap;
/* Pending logging */
bool mainThreadOnly;
void *mainThread;
unsigned pendingJobSize;
std::list<PendingJob*> pendingJobs;
void performPendingJobs();
/* Endpoint static callbacks */
static void logFunc(int level, const char *data, int len);
static void stun_resolve_cb(const pj_stun_resolve_result *result);
static void on_timer(pj_timer_heap_t *timer_heap,
struct pj_timer_entry *entry);
static void on_nat_detect(const pj_stun_nat_detect_result *res);
static void on_transport_state(pjsip_transport *tp,
pjsip_transport_state state,
const pjsip_transport_state_info *info);
private:
/*
* Account & Call lookups
*/
static Account *lookupAcc(int acc_id, const char *op);
static Call *lookupCall(int call_id, const char *op);
/* static callbacks */
static void on_incoming_call(pjsua_acc_id acc_id,
pjsua_call_id call_id,
pjsip_rx_data *rdata);
static void on_reg_started(pjsua_acc_id acc_id,
pj_bool_t renew);
static void on_reg_state2(pjsua_acc_id acc_id,
pjsua_reg_info *info);
static void on_incoming_subscribe(pjsua_acc_id acc_id,
pjsua_srv_pres *srv_pres,
pjsua_buddy_id buddy_id,
const pj_str_t *from,
pjsip_rx_data *rdata,
pjsip_status_code *code,
pj_str_t *reason,
pjsua_msg_data *msg_data);
static void on_pager2(pjsua_call_id call_id,
const pj_str_t *from,
const pj_str_t *to,
const pj_str_t *contact,
const pj_str_t *mime_type,
const pj_str_t *body,
pjsip_rx_data *rdata,
pjsua_acc_id acc_id);
static void on_pager_status2(pjsua_call_id call_id,
const pj_str_t *to,
const pj_str_t *body,
void *user_data,
pjsip_status_code status,
const pj_str_t *reason,
pjsip_tx_data *tdata,
pjsip_rx_data *rdata,
pjsua_acc_id acc_id);
static void on_typing2(pjsua_call_id call_id,
const pj_str_t *from,
const pj_str_t *to,
const pj_str_t *contact,
pj_bool_t is_typing,
pjsip_rx_data *rdata,
pjsua_acc_id acc_id);
static void on_mwi_info(pjsua_acc_id acc_id,
pjsua_mwi_info *mwi_info);
static void on_acc_find_for_incoming(const pjsip_rx_data *rdata,
pjsua_acc_id* acc_id);
static void on_buddy_state(pjsua_buddy_id buddy_id);
// Call callbacks
static void on_call_state(pjsua_call_id call_id, pjsip_event *e);
static void on_call_tsx_state(pjsua_call_id call_id,
pjsip_transaction *tsx,
pjsip_event *e);
static void on_call_media_state(pjsua_call_id call_id);
static void on_call_sdp_created(pjsua_call_id call_id,
pjmedia_sdp_session *sdp,
pj_pool_t *pool,
const pjmedia_sdp_session *rem_sdp);
static void on_stream_created(pjsua_call_id call_id,
pjmedia_stream *strm,
unsigned stream_idx,
pjmedia_port **p_port);
static void on_stream_destroyed(pjsua_call_id call_id,
pjmedia_stream *strm,
unsigned stream_idx);
static void on_dtmf_digit(pjsua_call_id call_id, int digit);
static void on_call_transfer_request(pjsua_call_id call_id,
const pj_str_t *dst,
pjsip_status_code *code);
static void on_call_transfer_request2(pjsua_call_id call_id,
const pj_str_t *dst,
pjsip_status_code *code,
pjsua_call_setting *opt);
static void on_call_transfer_status(pjsua_call_id call_id,
int st_code,
const pj_str_t *st_text,
pj_bool_t final,
pj_bool_t *p_cont);
static void on_call_replace_request(pjsua_call_id call_id,
pjsip_rx_data *rdata,
int *st_code,
pj_str_t *st_text);
static void on_call_replace_request2(pjsua_call_id call_id,
pjsip_rx_data *rdata,
int *st_code,
pj_str_t *st_text,
pjsua_call_setting *opt);
static void on_call_replaced(pjsua_call_id old_call_id,
pjsua_call_id new_call_id);
static void on_call_rx_offer(pjsua_call_id call_id,
const pjmedia_sdp_session *offer,
void *reserved,
pjsip_status_code *code,
pjsua_call_setting *opt);
static void on_call_tx_offer(pjsua_call_id call_id,
void *reserved,
pjsua_call_setting *opt);
static pjsip_redirect_op on_call_redirected(pjsua_call_id call_id,
const pjsip_uri *target,
const pjsip_event *e);
static pj_status_t
on_call_media_transport_state(pjsua_call_id call_id,
const pjsua_med_tp_state_info *info);
static void on_call_media_event(pjsua_call_id call_id,
unsigned med_idx,
pjmedia_event *event);
static pjmedia_transport*
on_create_media_transport(pjsua_call_id call_id,
unsigned media_idx,
pjmedia_transport *base_tp,
unsigned flags);
private:
void clearCodecInfoList(CodecInfoVector &codec_list);
void updateCodecInfoList(pjsua_codec_info pj_codec[], unsigned count,
CodecInfoVector &codec_list);
};
/**
* @} PJSUA2_UA
*/
}
/* End pj namespace */
#endif /* __PJSUA2_UA_HPP__ */
|