OPAL  Version 3.14.3
Public Member Functions
SIPPing Class Reference

#include <sippdu.h>

Inheritance diagram for SIPPing:
Inheritance graph
[legend]
Collaboration diagram for SIPPing:
Collaboration graph
[legend]

Public Member Functions

 SIPPing (SIPTransactionOwner &owner, OpalTransport &transport, const SIPURL &address)
 
virtual SIPTransaction * CreateDuplicate () const
 
- Public Member Functions inherited from SIPTransaction
 ~SIPTransaction ()
 
bool Start ()
 
bool IsTrying () const
 
bool IsProceeding () const
 
bool IsInProgress () const
 
bool IsFailed () const
 
bool IsCompleted () const
 
bool IsCanceled () const
 
bool IsTerminated () const
 
void WaitForCompletion ()
 
PBoolean Cancel ()
 
void Abort ()
 
virtual PBoolean OnReceivedResponse (SIP_PDU &response)
 
virtual PBoolean OnCompleted (SIP_PDU &response)
 
SIPEndPoint & GetEndPoint () const
 
SIPConnection * GetConnection () const
 
PString GetInterface () const
 
- Public Member Functions inherited from SIPTransactionBase
 SIPTransactionBase (const PString &transactionID)
 
Comparison Compare (const PObject &other) const
 
- Public Member Functions inherited from SIP_PDU
 SIP_PDU (Methods method=SIP_PDU::NumMethods, const OpalTransportPtr &transport=NULL, const PString &transactionID=PString::Empty())
 
 SIP_PDU (const SIP_PDU &request, StatusCodes code, const SDPSessionDescription *sdp=NULL)
 
 SIP_PDU (const SIP_PDU &)
 
SIP_PDU & operator= (const SIP_PDU &)
 
 ~SIP_PDU ()
 
void PrintOn (ostream &strm) const
 
void InitialiseHeaders (const SIPURL &dest, const SIPURL &to, const SIPURL &from, const PString &callID, unsigned cseq)
 
void InitialiseHeaders (SIPDialogContext &dialog, unsigned cseq=0)
 
void InitialiseHeaders (SIPConnection &connection, unsigned cseq=0)
 
void InitialiseHeaders (const SIP_PDU &request)
 
bool SetRoute (const SIPURLList &routeSet)
 
bool SetRoute (const SIPURL &proxy)
 
void SetAllow (unsigned bitmask)
 
StatusCodes Read ()
 
StatusCodes Parse (istream &strm, bool truncated)
 
virtual bool Send ()
 
bool SendResponse (StatusCodes code)
 
void Build (PString &pduStr, PINDEX &pduLen)
 
const PString & GetTransactionID () const
 
Methods GetMethod () const
 
StatusCodes GetStatusCode () const
 
void SetStatusCode (StatusCodes c)
 
const SIPURL & GetURI () const
 
void SetURI (const SIPURL &newuri)
 
unsigned GetVersionMajor () const
 
unsigned GetVersionMinor () const
 
void SetCSeq (unsigned cseq)
 
const PString & GetEntityBody () const
 
void SetEntityBody (const PString &body)
 
void SetEntityBody ()
 
const PString & GetInfo () const
 
void SetInfo (const PString &info)
 
const SIPMIMEInfo & GetMIME () const
 
SIPMIMEInfo & GetMIME ()
 
SDPSessionDescription * GetSDP ()
 
void SetSDP (SDPSessionDescription *sdp)
 
bool DecodeSDP (SIPEndPoint &endpoint, const OpalMediaFormatList &masterList)
 
bool IsContentSDP (bool emptyOK=false) const
 
const PString & GetExternalTransportAddress () const
 
OpalTransportPtr GetTransport () const
 
void SetTransport (const OpalTransportPtr &transport)
 

Additional Inherited Members

- Public Types inherited from SIP_PDU
enum  Methods {
  Method_INVITE, Method_ACK, Method_OPTIONS, Method_BYE,
  Method_CANCEL, Method_REGISTER, Method_SUBSCRIBE, Method_NOTIFY,
  Method_REFER, Method_MESSAGE, Method_INFO, Method_PING,
  Method_PUBLISH, Method_PRACK, NumMethods
}
 
enum  StatusCodes {
  IllegalStatusCode, Local_TransportError, Local_BadTransportAddress, Local_Timeout,
  Local_NoCompatibleListener, Local_CannotMapScheme, Local_TransportLost, Local_KeepAlive,
  Local_NotAuthenticated, Information_Trying = 100, Information_Ringing = 180, Information_CallForwarded = 181,
  Information_Queued = 182, Information_Session_Progress = 183, Successful_OK = 200, Successful_Accepted = 202,
  Redirection_MultipleChoices = 300, Redirection_MovedPermanently = 301, Redirection_MovedTemporarily = 302, Redirection_UseProxy = 305,
  Redirection_AlternativeService = 380, Failure_BadRequest = 400, Failure_UnAuthorised = 401, Failure_PaymentRequired = 402,
  Failure_Forbidden = 403, Failure_NotFound = 404, Failure_MethodNotAllowed = 405, Failure_NotAcceptable = 406,
  Failure_ProxyAuthenticationRequired = 407, Failure_RequestTimeout = 408, Failure_Conflict = 409, Failure_Gone = 410,
  Failure_LengthRequired = 411, Failure_RequestEntityTooLarge = 413, Failure_RequestURITooLong = 414, Failure_UnsupportedMediaType = 415,
  Failure_UnsupportedURIScheme = 416, Failure_BadExtension = 420, Failure_ExtensionRequired = 421, Failure_IntervalTooBrief = 423,
  Failure_UnresolvableDestination = 476, Failure_TemporarilyUnavailable = 480, Failure_TransactionDoesNotExist = 481, Failure_LoopDetected = 482,
  Failure_TooManyHops = 483, Failure_AddressIncomplete = 484, Failure_Ambiguous = 485, Failure_BusyHere = 486,
  Failure_RequestTerminated = 487, Failure_NotAcceptableHere = 488, Failure_BadEvent = 489, Failure_RequestPending = 491,
  Failure_Undecipherable = 493, Failure_InternalServerError = 500, Failure_NotImplemented = 501, Failure_BadGateway = 502,
  Failure_ServiceUnavailable = 503, Failure_ServerTimeout = 504, Failure_SIPVersionNotSupported = 505, Failure_MessageTooLarge = 513,
  GlobalFailure_BusyEverywhere = 600, GlobalFailure_Decline = 603, GlobalFailure_DoesNotExistAnywhere = 604, GlobalFailure_NotAcceptable = 606,
  MaxStatusCode = 699
}
 
- Static Public Member Functions inherited from SIPTransaction
static PString GenerateCallID ()
 
- Protected Types inherited from SIPTransaction
typedef SIPPoolTimer
< SIPTransaction > 		PoolTimer
 
- Protected Member Functions inherited from SIPTransaction
 SIPTransaction (Methods method, SIPTransactionOwner *owner, OpalTransport *transport, bool deleteOwner=false, const PString &transactionID=PString::Empty())
 
bool ResendCANCEL ()
 
void SetParameters (const SIPParameters &params)
 
void OnRetry ()
 
void OnTimeout ()
 
 P_DECLARE_TRACED_ENUM (States, NotStarted, Trying, Proceeding, Cancelling, Completed, Terminated_Success, Terminated_Timeout, Terminated_RetriesExceeded, Terminated_TransportError, Terminated_Cancelled, Terminated_Aborted)
 
virtual void SetTerminated (States newState)
 
- Protected Attributes inherited from SIPTransaction
SIPTransactionOwner * m_owner
 
bool m_deleteOwner
 
PTimeInterval m_retryTimeoutMin
 
PTimeInterval m_retryTimeoutMax
 
States m_state
 
unsigned m_retry
 
PoolTimer m_retryTimer
 
PoolTimer m_completionTimer
 
PSyncPoint m_completed
 
bool m_pduSizeOK
 
PString m_localInterface
 

Constructor & Destructor Documentation

SIPPing::SIPPing ( SIPTransactionOwner &  owner,
OpalTransport &  transport,
const SIPURL &  address 
)

Member Function Documentation

virtual SIPTransaction* SIPPing::CreateDuplicate ( ) const
virtual

Implements SIPTransaction.

The documentation for this class was generated from the following file: