/usr/include/opal/sip/sipcon.h is in libopal-dev 3.10.2~dfsg-0ubuntu1.
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 | /*
* sipcon.h
*
* Session Initiation Protocol connection.
*
* Open Phone Abstraction Library (OPAL)
* Formally known as the Open H323 project.
*
* Copyright (c) 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 Phone Abstraction Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Contributor(s): ______________________________________.
*
* $Revision: 26222 $
* $Author: rjongbloed $
* $Date: 2011-07-18 04:52:34 -0500 (Mon, 18 Jul 2011) $
*/
#ifndef OPAL_SIP_SIPCON_H
#define OPAL_SIP_SIPCON_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#include <opal/buildopts.h>
#if OPAL_SIP
#include <opal/buildopts.h>
#include <opal/rtpconn.h>
#include <sip/sippdu.h>
#include <sip/handlers.h>
#if OPAL_VIDEO
#include <opal/pcss.h> // for OpalPCSSConnection
#include <codec/vidcodec.h> // for OpalVideoUpdatePicture command
#endif
#if OPAL_HAS_IM
#include <im/sipim.h>
#include <im/rfc4103.h>
#endif
class OpalCall;
class SIPEndPoint;
/**OpalConnection::StringOption key to a boolean indicating the SDP ptime
parameter should be included in audio session streams. Default false.
*/
#define OPAL_OPT_OFFER_SDP_PTIME "Offer-SDP-PTime"
/**OpalConnection::StringOption key to a boolean indicating the the state
of the "Refer-Sub" header in the REFER request. Default true.
*/
#define OPAL_OPT_REFER_SUB "Refer-Sub"
/**OpalConnection::StringOption key to an integer indicating the the mode
for the reliable provisional response system. See PRACKMode for more
information. Default is from SIPEndPoint::GetDefaultPRACKMode() which
in turn defaults to e_prackSupported.
*/
#define OPAL_OPT_PRACK_MODE "PRACK-Mode"
/**OpalConnection::StringOption key to a boolean indicating that we should
make initial SDP offer. Default true.
*/
#define OPAL_OPT_INITIAL_OFFER "Initial-Offer"
/**OpalConnection::StringOption key to a string for a regular expression to
match the product information, which if matching the remote system, will
indicate the remote does not support asymmetric hold as required by the
standard.
This fault is when SDP sendonly is sent (us putting them on hold), and
they reply inactive, which implies them putting us on hold. When we
subsequently send recvonly to release our hold to them, they continue to
send inactive, and hold is never released.
Note the OpalProductInfo vendor, name & version strings are concatenated
before comparison with the regular expression.
Defaults to empty string.
*/
#define OPAL_OPT_SYMMETRIC_HOLD_PRODUCT "Symmetric-Hold-Product"
/**OpalConnection::StringOption key to a string representing the precise SDP
to be included in the INVITE offer. No media streams are opened or any
checks whstsoever made on the string. It is simply included as the body of
the INVITE.
Note this options presence also prevents handling of the response SDP
Defaults to empty string which generates SDP from available
media formats and media streams.
*/
#define OPAL_OPT_EXTERNAL_SDP "External-SDP"
#define SIP_HEADER_PREFIX "SIP-Header:"
#define SIP_HEADER_REPLACES SIP_HEADER_PREFIX"Replaces"
#define SIP_HEADER_REFERRED_BY SIP_HEADER_PREFIX"Referred-By"
#define SIP_HEADER_CONTACT SIP_HEADER_PREFIX"Contact"
#define OPAL_SIP_REFERRED_CONNECTION "Referred-Connection"
/////////////////////////////////////////////////////////////////////////
/**Session Initiation Protocol connection.
*/
class SIPConnection : public OpalRTPConnection
{
PCLASSINFO(SIPConnection, OpalRTPConnection);
public:
/**@name Construction */
//@{
/**Create a new connection.
*/
SIPConnection(
OpalCall & call, ///< Owner call for connection
SIPEndPoint & endpoint, ///< Owner endpoint for connection
const PString & token, ///< token to identify the connection
const SIPURL & address, ///< Destination address for outgoing call
OpalTransport * transport, ///< Transport INVITE came in on
unsigned int options = 0, ///< Connection options
OpalConnection::StringOptions * stringOptions = NULL ///< complex string options
);
/**Destroy connection.
*/
~SIPConnection();
//@}
/**@name Overrides from OpalConnection */
//@{
/**Get indication of connection being to a "network".
This indicates the if the connection may be regarded as a "network"
connection. The distinction is about if there is a concept of a "remote"
party being connected to and is best described by example: sip, h323,
iax and pstn are all "network" connections as they connect to something
"remote". While pc, pots and ivr are not as the entity being connected
to is intrinsically local.
*/
virtual bool IsNetworkConnection() const { return true; }
/**Get this connections protocol prefix for URLs.
*/
virtual PString GetPrefixName() const;
/**Get the protocol-specific unique identifier for this connection.
*/
virtual PString GetIdentifier() const;
/// Call back for connection to act on changed string options
virtual void OnApplyStringOptions();
/**Start an outgoing connection.
This function will initiate the connection to the remote entity, for
example in H.323 it sends a SETUP, in SIP it sends an INVITE etc.
The default behaviour is .
*/
virtual PBoolean SetUpConnection();
/**Get the destination address of an incoming connection.
This will, for example, collect a phone number from a POTS line, or
get the fields from the H.225 SETUP pdu in a H.323 connection.
The default behaviour for sip returns the request URI in the INVITE.
*/
virtual PString GetDestinationAddress();
/**Get the fulll URL being indicated by the remote for incoming calls. This may
not have any relation to the local name of the endpoint.
The default behaviour returns GetDestinationAddress() normalised to a URL.
The remote may provide a full URL, if it does not then the prefix for the
endpoint is prepended to the destination address.
*/
virtual PString GetCalledPartyURL();
/**Get alerting type information of an incoming call.
The type of "distinctive ringing" for the call. The string is protocol
dependent, so the caller would need to be aware of the type of call
being made. Some protocols may ignore the field completely.
For SIP this corresponds to the string contained in the "Alert-Info"
header field of the INVITE. This is typically a URI for the ring file.
For H.323 this must be a string representation of an integer from 0 to 7
which will be contained in the Q.931 SIGNAL (0x34) Information Element.
Default behaviour returns an empty string.
*/
virtual PString GetAlertingType() const;
/**Set alerting type information for outgoing call.
The type of "distinctive ringing" for the call. The string is protocol
dependent, so the caller would need to be aware of the type of call
being made. Some protocols may ignore the field completely.
For SIP this corresponds to the string contained in the "Alert-Info"
header field of the INVITE. This is typically a URI for the ring file.
For H.323 this must be a string representation of an integer from 0 to 7
which will be contained in the Q.931 SIGNAL (0x34) Information Element.
Default behaviour returns false.
*/
virtual bool SetAlertingType(const PString & info);
/**Get call information of an incoming call.
This is protocol dependent information provided about the call. The
details are outside the scope of this help.
For SIP this corresponds to the string contained in the "Call-Info"
header field of the INVITE.
*/
virtual PString GetCallInfo() const;
/**Initiate the transfer of an existing call (connection) to a new remote
party.
A REFER command is sent to the remote endpoint to cause it to move the
call it has with this endpoint to a new address. This call will, in the
end, be cleared. The OnTransferNotify() function can be used to monitor
the progress of the transfer in case it fails.
If remoteParty is a valid call token, then this is short hand for
the REFER to the remote endpoint of this call to do an INVITE with
Replaces header to the remote party of the supplied tokens call. This
is used for consultation transfer where A calls B, B holds A, B calls C,
B transfers C to A. The last step is a REFER to C with call details of
A that are extracted from the A to B call leg. This short cut is
possible because A nd C may be other endpoints but both B's are in tis
instance of OPAL.
In the end, both calls are cleared. The OnTransferNotify() function can
be used to monitor the progress of the transfer in case it fails.
*/
virtual bool TransferConnection(
const PString & remoteParty ///< Remote party to transfer the existing call to
);
/**Put the current connection on hold, suspending all media streams.
The \p fromRemote parameter indicates if we a putting the remote on
hold (false) or it is a request for the remote to put us on hold (true).
The /p placeOnHold parameter indicates of teh command/request is for
going on hold or retrieving from hold.
*/
virtual bool Hold(
bool fromRemote, ///< Flag for if remote has us on hold, or we have them
bool placeOnHold ///< Flag for setting on or off hold
);
/**Return true if the current connection is on hold.
The \p fromRemote parameter indicates if we are testing if the remote
system has us on hold, or we have them on hold.
*/
virtual bool IsOnHold(
bool fromRemote ///< Flag for if remote has us on hold, or we have them
);
/**Indicate to remote endpoint an alert is in progress.
If this is an incoming connection and the AnswerCallResponse is in a
AnswerCallDeferred or AnswerCallPending state, then this function is
used to indicate to that endpoint that an alert is in progress. This is
usually due to another connection which is in the call (the B party)
has received an OnAlerting() indicating that its remote endpoint is
"ringing".
The default behaviour does nothing.
*/
virtual PBoolean SetAlerting(
const PString & calleeName, ///< Name of endpoint being alerted.
PBoolean withMedia ///< Flag to alert with/without media
);
/**Indicate to remote endpoint we are connected.
The default behaviour does nothing.
*/
virtual PBoolean SetConnected();
/**Get the data formats this endpoint is capable of operating in.
*/
virtual OpalMediaFormatList GetMediaFormats() const;
/**Open source or sink media stream for session.
*/
virtual OpalMediaStreamPtr OpenMediaStream(
const OpalMediaFormat & mediaFormat, ///< Media format to open
unsigned sessionID, ///< Session to start stream on
bool isSource ///< Stream is a source/sink
);
/**Request close of a specific media stream.
Note that this is usually asymchronous, the OnClosedMediaStream() function is
called when the stream is really closed.
*/
virtual bool CloseMediaStream(
OpalMediaStream & stream ///< Stream to close
);
/**Pause media streams for connection.
*/
virtual void OnPauseMediaStream(
OpalMediaStream & strm, ///< Media stream paused/un-paused
bool paused ///< Flag for pausing/un-pausing
);
/**Clean up the termination of the connection.
This function can do any internal cleaning up and waiting on background
threads that may be using the connection object.
Note that there is not a one to one relationship with the
OnEstablishedConnection() function. This function may be called without
that function being called. For example if SetUpConnection() was used
but the call never completed.
Classes that override this function should make sure they call the
ancestor version for correct operation.
An application will not typically call this function as it is used by
the OpalManager during a release of the connection.
The default behaviour calls the OpalEndPoint function of the same name.
*/
virtual void OnReleased();
/**Forward incoming connection to the specified address.
This would typically be called from within the OnIncomingConnection()
function when an application wishes to redirect an unwanted incoming
call.
The return value is true if the call is to be forwarded, false
otherwise. Note that if the call is forwarded, the current connection
is cleared with the ended call code set to EndedByCallForwarded.
*/
virtual PBoolean ForwardCall(
const PString & forwardParty ///< Party to forward call to.
);
/**Get the real user input indication transmission mode.
This will return the user input mode that will actually be used for
transmissions. It will be the value of GetSendUserInputMode() provided
the remote endpoint is capable of that mode.
*/
virtual SendUserInputModes GetRealSendUserInputMode() const;
/**Send a user input indication to the remote endpoint.
This is for sending arbitrary strings as user indications.
The default behaviour is to call SendUserInputTone() for each character
in the string.
*/
virtual PBoolean SendUserInputString(
const PString & value ///< String value of indication
);
/**Send a user input indication to the remote endpoint.
This sends DTMF emulation user input. If something more sophisticated
than the simple tones that can be sent using the SendUserInput()
function.
A duration of zero indicates that no duration is to be indicated.
A non-zero logical channel indicates that the tone is to be syncronised
with the logical channel at the rtpTimestamp value specified.
The tone parameter must be one of "0123456789#*ABCD!" where '!'
indicates a hook flash. If tone is a ' ' character then a
signalUpdate PDU is sent that updates the last tone indication
sent. See the H.245 specifcation for more details on this.
The default behaviour sends the tone using RFC2833.
*/
PBoolean SendUserInputTone(char tone, unsigned duration);
/**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 RTP_Session & session ///< Session with statistics
) const;
//@}
/**@name Protocol handling functions */
//@{
/**Handle the fail of a transaction we initiated.
*/
virtual void OnTransactionFailed(
SIPTransaction & transaction
);
/**Handle an incoming SIP PDU that has been full decoded
*/
virtual void OnReceivedPDU(SIP_PDU & pdu);
/**Handle an incoming INVITE request
*/
virtual void OnReceivedINVITE(SIP_PDU & pdu);
/**Handle an incoming Re-INVITE request
*/
virtual void OnReceivedReINVITE(SIP_PDU & pdu);
/**Handle an incoming ACK PDU
*/
virtual void OnReceivedACK(SIP_PDU & pdu);
/**Handle an incoming OPTIONS PDU
*/
virtual void OnReceivedOPTIONS(SIP_PDU & pdu);
/**Handle an incoming NOTIFY PDU
*/
virtual void OnReceivedNOTIFY(SIP_PDU & pdu);
/**Callback function on receipt of an allowed NOTIFY message.
Allowed events are determined by the m_allowedEvents member variable.
*/
virtual void OnAllowedEventNotify(
const PString & eventName ///< Name of event
);
/**Handle an incoming REFER PDU
*/
virtual void OnReceivedREFER(SIP_PDU & pdu);
/**Handle an incoming INFO PDU
*/
virtual void OnReceivedINFO(SIP_PDU & pdu);
/**Handle an incoming PING PDU
*/
virtual void OnReceivedPING(SIP_PDU & pdu);
/**Handle an incoming PRACK PDU
*/
virtual void OnReceivedPRACK(SIP_PDU & pdu);
/**Handle an incoming BYE PDU
*/
virtual void OnReceivedBYE(SIP_PDU & pdu);
/**Handle an incoming CANCEL PDU
*/
virtual void OnReceivedCANCEL(SIP_PDU & pdu);
/**Handle an incoming response PDU to our INVITE.
Note this is called before th ACK is sent and thus should do as little as possible.
All the hard work (SDP processing etc) should be in the usual OnReceivedResponse().
*/
virtual void OnReceivedResponseToINVITE(
SIPTransaction & transaction,
SIP_PDU & response
);
/**Handle an incoming response PDU.
*/
virtual void OnReceivedResponse(
SIPTransaction & transaction,
SIP_PDU & response
);
/**Handle an incoming Trying response PDU
*/
virtual void OnReceivedTrying(
SIPTransaction & transaction,
SIP_PDU & response
);
/**Handle an incoming Ringing response PDU
*/
virtual void OnReceivedRinging(SIP_PDU & pdu);
/**Handle an incoming Session Progress response PDU
*/
virtual void OnReceivedSessionProgress(SIP_PDU & pdu);
/**Handle an incoming Proxy Authentication Required response PDU
Returns: true if handled, if false is returned connection is released.
*/
virtual PBoolean OnReceivedAuthenticationRequired(
SIPTransaction & transaction,
SIP_PDU & response
);
/**Handle an incoming redirect response PDU
*/
virtual void OnReceivedRedirection(SIP_PDU & pdu);
/**Handle an incoming OK response PDU.
This actually gets any PDU of the class 2xx not just 200.
*/
virtual void OnReceivedOK(
SIPTransaction & transaction,
SIP_PDU & response
);
/**Handle a sending INVITE request
*/
virtual void OnCreatingINVITE(SIPInvite & pdu);
enum TypeOfINVITE {
IsNewINVITE,
IsDuplicateINVITE,
IsReINVITE,
IsLoopedINVITE
};
/// Indicate if this is a duplicate or multi-path INVITE
TypeOfINVITE CheckINVITE(
const SIP_PDU & pdu
) const;
/**Send an OPTIONS command within this calls dialog.
Note if \p reply is non-NULL, this function will block until the
transaction completes. Care must be executed in this case that
no deadlocks occur.
*/
bool SendOPTIONS(
const SIPOptions::Params & params, ///< Parameters for OPTIONS command
SIP_PDU * reply = NULL ///< Reply to message
);
/**Send an INFO command within this calls dialog.
Note if \p reply is non-NULL, this function will block until the
transaction completes. Care must be executed in this case that
no deadlocks occur.
*/
bool SendINFO(
const SIPInfo::Params & params, ///< Parameters for OPTIONS command
SIP_PDU * reply = NULL ///< Reply to message
);
//@}
OpalTransportAddress GetDefaultSDPConnectAddress(WORD port = 0) const;
OpalTransport & GetTransport() const { return *transport; }
bool SetTransport(const SIPURL & destination);
SIPEndPoint & GetEndPoint() const { return endpoint; }
SIPDialogContext & GetDialog() { return m_dialog; }
const SIPDialogContext & GetDialog() const { return m_dialog; }
SIPAuthentication * GetAuthenticator() const { return m_authentication; }
/// Mode for reliable provisional responses.
enum PRACKMode {
e_prackDisabled, /**< Do not use PRACK if remote asks for 100rel in Supported
field, refuse call with 420 Bad Extension if 100rel is
in Require header field. */
e_prackSupported, /** Add 100rel to Supported header in outgoing INVITE. For
incoming INVITE enable PRACK is either Supported or
Require headers include 100rel. */
e_prackRequired /** Add 100rel to Require header in outgoing INVITE. For
incoming INVITE enable PRACK is either Supported or
Require headers include 100rel, fail the call with
a 421 Extension Required if missing. */
};
/**Get active PRACK mode. See PRACKMode enum for details.
*/
PRACKMode GetPRACKMode() const { return m_prackMode; }
#if OPAL_VIDEO
/**Call when SIP INFO of type application/media_control+xml is received.
Return false if default reponse of Failure_UnsupportedMediaType is to be returned
*/
virtual PBoolean OnMediaControlXML(SIP_PDU & pdu);
#endif
virtual void OnMediaCommand(OpalMediaCommand & note, INT extra);
virtual void OnStartTransaction(SIPTransaction & transaction);
virtual void OnReceivedMESSAGE(SIP_PDU & pdu);
P_REMOVE_VIRTUAL_VOID(OnMessageReceived(const SIPURL & /*from*/, const SIP_PDU & /*pdu*/));
P_REMOVE_VIRTUAL_VOID(OnMessageReceived(const SIP_PDU & /*pdu*/));
#if 0 // OPAL_HAS_IM
virtual bool TransmitExternalIM(
const OpalMediaFormat & format,
RTP_IMFrame & body
);
#endif
PString GetLocalPartyURL() const;
protected:
virtual bool GarbageCollection();
PDECLARE_NOTIFIER(PTimer, SIPConnection, OnSessionTimeout);
PDECLARE_NOTIFIER(PTimer, SIPConnection, OnInviteResponseRetry);
PDECLARE_NOTIFIER(PTimer, SIPConnection, OnInviteResponseTimeout);
virtual bool OnSendOfferSDP(
OpalRTPSessionManager & rtpSessions,
SDPSessionDescription & sdpOut
);
virtual bool OnSendOfferSDPSession(
const OpalMediaType & mediaType,
unsigned sessionID,
OpalRTPSessionManager & rtpSessions,
SDPSessionDescription & sdpOut,
bool offerOpenMediaStreamOnly
);
virtual bool OnSendAnswerSDP(
OpalRTPSessionManager & rtpSessions,
SDPSessionDescription & sdpOut
);
virtual bool OnSendAnswerSDPSession(
const SDPSessionDescription & sdpIn,
unsigned sessionIndex,
SDPSessionDescription & sdpOut
);
virtual void OnReceivedAnswerSDP(
SIP_PDU & pdu
);
virtual bool OnReceivedAnswerSDPSession(
SDPSessionDescription & sdp,
unsigned sessionId
);
virtual OpalMediaSession * SetUpMediaSession(
const unsigned rtpSessionId,
const OpalMediaType & mediaType,
const SDPMediaDescription & mediaDescription,
OpalTransportAddress & localAddress,
bool & remoteChanged
);
bool SendReINVITE(PTRACE_PARAM(const char * msg));
void StartPendingReINVITE();
friend class SIPInvite;
static PBoolean WriteINVITE(OpalTransport & transport, void * param);
bool WriteINVITE();
virtual bool SendInviteOK();
virtual PBoolean SendInviteResponse(
SIP_PDU::StatusCodes code,
const SDPSessionDescription * sdp = NULL
);
virtual void AdjustInviteResponse(
SIP_PDU & response
);
void UpdateRemoteAddresses();
void NotifyDialogState(
SIPDialogNotification::States state,
SIPDialogNotification::Events eventType = SIPDialogNotification::NoEvent,
unsigned eventCode = 0
);
// Member variables
SIPEndPoint & endpoint;
OpalTransport * transport;
bool deleteTransport;
unsigned m_allowedMethods;
PStringList m_allowedEvents;
enum HoldState {
eHoldOff,
eRetrieveInProgress,
// Order is important!
eHoldOn,
eHoldInProgress
};
HoldState m_holdToRemote;
bool m_holdFromRemote;
PString forwardParty;
SIPURL m_ciscoRemotePartyID;
SIP_PDU * originalInvite;
PTime originalInviteTime;
time_t m_sdpSessionId;
unsigned m_sdpVersion; // Really a sequence number
bool m_needReINVITE;
bool m_handlingINVITE;
bool m_symmetricOpenStream;
SIPDialogContext m_dialog;
OpalGloballyUniqueID m_dialogNotifyId;
int m_appearanceCode;
PString m_alertInfo;
SIPAuthentication * m_authentication;
unsigned m_authenticatedCseq;
PTimer sessionTimer;
std::map<SIP_PDU::Methods, unsigned> m_lastRxCSeq;
PRACKMode m_prackMode;
bool m_prackEnabled;
unsigned m_prackSequenceNumber;
queue<SIP_PDU> m_responsePackets;
PTimer m_responseFailTimer;
PTimer m_responseRetryTimer;
unsigned m_responseRetryCount;
bool m_referInProgress;
PSafeList<SIPTransaction> forkedInvitations; // Not for re-INVITE
PSafeList<SIPTransaction> pendingInvitations; // For re-INVITE
PSafeList<SIPTransaction> m_pendingTransactions;
#if OPAL_FAX
bool m_switchedToFaxMode;
#endif
enum {
ReleaseWithBYE,
ReleaseWithCANCEL,
ReleaseWithResponse,
ReleaseWithNothing,
} releaseMethod;
OpalMediaFormatList m_remoteFormatList;
OpalMediaFormatList m_answerFormatList;
bool SetRemoteMediaFormats(SDPSessionDescription * sdp);
std::map<std::string, SIP_PDU *> m_responses;
#if OPAL_HAS_IM
PSafePtr<OpalSIPIMContext> m_imContext;
#endif
private:
P_REMOVE_VIRTUAL_VOID(OnCreatingINVITE(SIP_PDU&));
P_REMOVE_VIRTUAL_VOID(OnReceivedTrying(SIP_PDU &));
friend class SIPTransaction;
friend class SIP_RTP_Session;
};
/**This class is for encpsulating the IETF Real Time Protocol interface.
*/
class SIP_RTP_Session : public RTP_UserData
{
PCLASSINFO(SIP_RTP_Session, RTP_UserData);
/**@name Construction */
//@{
/**Create a new channel.
*/
SIP_RTP_Session(
SIPConnection & connection ///< Owner of the RTP session
);
//@}
/**@name Overrides from RTP_UserData */
//@{
/**Callback from the RTP session for transmit statistics monitoring.
This is called every RTP_Session::senderReportInterval packets on the
transmitter indicating that the statistics have been updated.
The default behaviour calls H323Connection::OnRTPStatistics().
*/
virtual void OnTxStatistics(
const RTP_Session & session ///< Session with statistics
) const;
/**Callback from the RTP session for receive statistics monitoring.
This is called every RTP_Session::receiverReportInterval packets on the
receiver indicating that the statistics have been updated.
The default behaviour calls H323Connection::OnRTPStatistics().
*/
virtual void OnRxStatistics(
const RTP_Session & session ///< Session with statistics
) const;
#if OPAL_VIDEO
/**Callback from the RTP session after an IntraFrameRequest is receieved.
The default behaviour executes an OpalVideoUpdatePicture command on the
connection's source video stream if it exists.
*/
virtual void OnRxIntraFrameRequest(
const RTP_Session & session ///< Session with statistics
) const;
/**Callback from the RTP session after an IntraFrameRequest is sent.
The default behaviour does nothing.
*/
virtual void OnTxIntraFrameRequest(
const RTP_Session & session ///< Session with statistics
) const;
#endif
//@}
virtual void SessionFailing(RTP_Session & /*session*/);
protected:
SIPConnection & connection; /// Owner of the RTP session
};
#endif // OPAL_SIP
#endif // OPAL_SIP_SIPCON_H
// End of File ///////////////////////////////////////////////////////////////
|