OPAL  Version 3.18.8
Public Member Functions
SIPConsoleEndPoint Class Reference

#include <console_mgr.h>

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

Public Member Functions

 SIPConsoleEndPoint (OpalManagerConsole &manager)
 
virtual void GetArgumentSpec (ostream &strm) const
 
virtual bool Initialise (PArgList &args, bool verbose, const PString &defaultRoute)
 
virtual void OnRegistrationStatus (const RegistrationStatus &status)
 
bool DoRegistration (ostream &output, bool verbose, const PString &aor, const PString &pwd, const PArgList &args, const char *authId, const char *realm, const char *proxy, const char *mode, const char *ttl)
 
- Public Member Functions inherited from SIPEndPoint
PSafePtr< SIPConnection > GetSIPConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite, SIP_PDU::StatusCodes *errorCode=NULL)
 
virtual PBoolean IsAcceptedAddress (const SIPURL &toAddr)
 
bool Register (const SIPRegister::Params &params, PString &aor, SIP_PDU::StatusCodes *reason=NULL)
 
bool Register (const SIPRegister::Params &params, PString &aor, bool asynchronous)
 
bool P_DEPRECATED Register (const PString &host, const PString &user=PString::Empty(), const PString &autName=PString::Empty(), const PString &password=PString::Empty(), const PString &authRealm=PString::Empty(), unsigned expire=0, const PTimeInterval &minRetryTime=PMaxTimeInterval, const PTimeInterval &maxRetryTime=PMaxTimeInterval)
 Registration function for backward compatibility. More...
 
PBoolean IsRegistered (const PString &aor, bool includeOffline=false)
 
bool Unregister (const PString &aor)
 
bool UnregisterAll ()
 
unsigned GetRegistrationsCount () const
 
PStringList GetRegistrations (bool includeOffline=false) const
 
bool GetRegistrationStatus (const PString &token, RegistrationStatus &status)
 
virtual void OnRegistrationStatus (const PString &aor, PBoolean wasRegistering, PBoolean reRegistering, SIP_PDU::StatusCodes reason)
 
virtual void OnRegistrationFailed (const PString &aor, SIP_PDU::StatusCodes reason, PBoolean wasRegistering)
 
virtual void OnRegistered (const PString &aor, PBoolean wasRegistering)
 
bool Subscribe (const SIPSubscribe::Params &params, PString &token, bool tokenIsAOR=true)
 
bool Subscribe (SIPSubscribe::PredefinedPackages eventPackage, unsigned expire, const PString &aor)
 
bool IsSubscribed (const PString &aor, bool includeOffline=false)
 
bool IsSubscribed (const PString &eventPackage, const PString &aor, bool includeOffline=false)
 
bool Unsubscribe (const PString &aor, bool invalidateNotifiers=false)
 
bool Unsubscribe (SIPSubscribe::PredefinedPackages eventPackage, const PString &aor, bool invalidateNotifiers=false)
 
bool Unsubscribe (const PString &eventPackage, const PString &aor, bool invalidateNotifiers=false)
 
bool UnsubcribeAll (SIPSubscribe::PredefinedPackages eventPackage)
 
bool UnsubcribeAll (const PString &eventPackage)
 
unsigned GetSubscriptionCount (const SIPSubscribe::EventPackage &eventPackage)
 
PStringList GetSubscriptions (const SIPSubscribe::EventPackage &eventPackage, bool includeOffline=false) const
 
bool GetSubscriptionStatus (const PString &token, const PString &eventPackage, SubscriptionStatus &status)
 
virtual void OnSubscriptionStatus (const SubscriptionStatus &status)
 
virtual void OnSubscriptionStatus (const PString &eventPackage, const SIPURL &uri, bool wasSubscribing, bool reSubscribing, SIP_PDU::StatusCodes reason)
 
virtual void OnSubscriptionStatus (SIPSubscribeHandler &handler, const SIPURL &uri, bool wasSubscribing, bool reSubscribing, SIP_PDU::StatusCodes reason)
 
virtual CanNotifyResult CanNotify (const PString &eventPackage, const SIPURL &aor)
 
virtual bool CanNotify (const PString &eventPackage)
 
bool Notify (const SIPURL &targetAddress, const PString &eventPackage, const PObject &body)
 
virtual bool OnReINVITE (SIPConnection &connection, bool fromRemote, const PString &remoteSDP)
 
virtual void OnDialogInfoReceived (const SIPDialogNotification &info)
 
void SendNotifyDialogInfo (const SIPDialogNotification &info)
 
virtual void OnRegInfoReceived (const SIPRegNotification &info)
 
virtual bool OnReceivedInfoPackage (SIPConnection &connection, const PString &package, const PMultiPartList &content)
 
bool SendMESSAGE (SIPMessage::Params &params)
 
virtual void OnMESSAGECompleted (const SIPMessage::Params &params, SIP_PDU::StatusCodes reason)
 
void SetConnectionlessMessageNotifier (const ConnectionlessMessageNotifier &notifier)
 
virtual bool SendOPTIONS (const SIPOptions::Params &params)
 
virtual void OnOptionsCompleted (const SIPOptions::Params &params, const SIP_PDU &response)
 
bool Publish (const SIPSubscribe::Params &params, const PString &body, PString &aor)
 
bool Publish (const PString &to, const PString &body, unsigned expire=300)
 
PStringList GetPublications (const SIPSubscribe::EventPackage &eventPackage, bool includeOffline=false) const
 
PBoolean Ping (const PURL &to)
 
virtual RegistrarAoR * CreateRegistrarAoR (const SIP_PDU &request)
 
virtual PSafePtr< RegistrarAoR > FindRegistrarAoR (const SIPURL &aor)
 
virtual SIPURLList GetRegistrarAoRs () const
 
virtual void OnChangedRegistrarAoR (RegistrarAoR &ua)
 
void SetRegistrarDomains (const PStringSet &domains)
 
const PStringSet & GetRegistrarDomains () const
 
const PStringSet & GetAllowedEvents () const
 
SIPConnection::PRACKMode GetDefaultPRACKMode () const
 
void SetDefaultPRACKMode (SIPConnection::PRACKMode mode)
 
void SetMaxPacketSizeUDP (PINDEX sz)
 
PINDEX GetMaxPacketSizeUDP () const
 
void SetMaxRetries (unsigned r)
 
unsigned GetMaxRetries () const
 
void SetRetryTimeouts (const PTimeInterval &t1, const PTimeInterval &t2)
 
const PTimeInterval & GetRetryTimeoutMin () const
 
const PTimeInterval & GetRetryTimeoutMax () const
 
void SetNonInviteTimeout (const PTimeInterval &t)
 
const PTimeInterval & GetNonInviteTimeout () const
 
void SetPduCleanUpTimeout (const PTimeInterval &t)
 
const PTimeInterval & GetPduCleanUpTimeout () const
 
void SetInviteTimeout (const PTimeInterval &t)
 
const PTimeInterval & GetInviteTimeout () const
 
void SetProgressTimeout (const PTimeInterval &t)
 
const PTimeInterval & GetProgressTimeout () const
 
void SetAckTimeout (const PTimeInterval &t)
 
const PTimeInterval & GetAckTimeout () const
 
void SetRegistrarTimeToLive (const PTimeInterval &t)
 
const PTimeInterval & GetRegistrarTimeToLive () const
 
void SetNotifierTimeToLive (const PTimeInterval &t)
 
const PTimeInterval & GetNotifierTimeToLive () const
 
P_DEPRECATED void SetNATBindingTimeout (const PTimeInterval &t)
 
P_DEPRECATED const PTimeInterval & GetNATBindingTimeout () const
 
void GetKeepAlive (PTimeInterval &timeout, KeepAliveType &type)
 
void SetKeepAlive (const PTimeInterval &timeout, KeepAliveType type)
 
void AddTransaction (SIPTransaction *transaction)
 
PSafePtr< SIPTransaction > GetTransaction (const PString &transactionID, PSafetyMode mode)
 
unsigned GetNextCSeq ()
 
void SetRegisteredUserMode (bool v)
 
bool GetRegisteredUserMode () const
 
bool GetAuthentication (const PString &realm, PString &authId, PString &password)
 
virtual SIPURL GetDefaultLocalURL (const OpalTransport &transport, const SIPURL &remoteAddress)
 
virtual void AdjustToRegistration (SIP_PDU &pdu, SIPConnection *connection=NULL, const OpalTransport *transport=NULL)
 
const SIPURL & GetProxy () const
 
void SetProxy (const SIPURL &url)
 
void SetProxy (const PString &hostname, const PString &username, const PString &password)
 
int GetDefaultAppearanceCode () const
 
void SetDefaultAppearanceCode (int code)
 
virtual PString GetUserAgent () const
 
void SetUserAgent (const PString &str)
 
virtual unsigned GetAllowedMethods () const
 
P_DEPRECATED void SetNATBindingRefreshMethod (const NATBindingRefreshMethod type)
 
virtual SIPRegisterHandler * CreateRegisterHandler (const SIPRegister::Params &params)
 
virtual void OnStartTransaction (SIPConnection &conn, SIPTransaction &transaction)
 
PSafePtr< SIPHandler > FindSIPHandlerByCallID (const PString &callID, PSafetyMode m)
 
PSafePtr< SIPHandler > FindSIPHandlerByUrl (const PString &aor, SIP_PDU::Methods method, PSafetyMode mode)
 
void UpdateHandlerIndexes (SIPHandler *handler)
 
SIPThreadPool & GetThreadPool ()
 
PINDEX GetSRVIndex (const SIPURL &url)
 
void ResetSRVIndex (const SIPURL &url)
 
OpalTransportAddress NextSRVAddress (const SIPURL &url)
 
 SIPEndPoint (OpalManager &manager, unsigned maxThreads=15)
 
 ~SIPEndPoint ()
 
virtual void ShutDown ()
 
virtual PString GetDefaultTransport () const
 
virtual WORD GetDefaultSignalPort () const
 
virtual PStringList GetNetworkURIs (const PString &name) const
 
virtual void NewIncomingConnection (OpalListener &listener, const OpalTransportPtr &transport)
 
virtual PSafePtr< OpalConnection > MakeConnection (OpalCall &call, const PString &party, void *userData, unsigned int options, OpalConnection::StringOptions *stringOptions)
 
virtual void OnReleased (OpalConnection &connection)
 
virtual void OnConferenceStatusChanged (OpalEndPoint &endpoint, const PString &uri, OpalConferenceState::ChangeType change)
 
virtual PBoolean GarbageCollection ()
 
virtual PStringList GetAvailableStringOptions () const
 
virtual SIPConnection * CreateConnection (const SIPConnection::Init &init)
 
virtual PBoolean SetupTransfer (SIPConnection &connection, const PString &remoteParty, const PString &replaces)
 
virtual PBoolean ForwardConnection (SIPConnection &connection, const PString &forwardParty)
 
bool ClearDialogContext (const PString &descriptor)
 
bool ClearDialogContext (SIPDialogContext &context)
 
OpalTransportPtr GetTransport (const SIPTransactionOwner &transactor, SIP_PDU::StatusCodes &reason)
 
virtual void HandlePDU (const OpalTransportPtr &transport)
 
virtual bool OnReceivedPDU (SIP_PDU *pdu)
 
virtual void OnReceivedResponse (SIPTransaction &transaction, SIP_PDU &response)
 
virtual bool OnReceivedINVITE (SIP_PDU *pdu)
 
virtual bool OnReceivedREFER (SIP_PDU &request)
 
virtual bool OnReceivedNOTIFY (SIP_PDU &request)
 
virtual bool OnReceivedREGISTER (SIP_PDU &request)
 
virtual bool OnReceivedSUBSCRIBE (SIP_PDU &request, SIPDialogContext *dialog)
 
virtual bool OnReceivedMESSAGE (SIP_PDU &request)
 
virtual bool OnReceivedOPTIONS (SIP_PDU &request)
 
virtual void OnTransactionFailed (SIPTransaction &transaction)
 
- Public Member Functions inherited from OpalConsoleEndPoint
virtual ~OpalConsoleEndPoint ()
 
void SetEndpointDisabled (bool disabled)
 

Additional Inherited Members

- Public Types inherited from SIPEndPoint
enum  CanNotifyResult { CannotNotify, CanNotifyImmediate, CanNotifyDeferrred }
 
enum  KeepAliveType { NoKeepAlive, KeepAliveByCRLF, KeepAliveByOPTION, NumMethods }
 
typedef
SIPSubscribe::SubscriptionStatus 		SubscriptionStatus
 
typedef PNotifierTemplate
< ConnectionlessMessageInfo & > 		ConnectionlessMessageNotifier
 
typedef KeepAliveType NATBindingRefreshMethod
 
- Public Types inherited from OpalConsoleEndPoint
enum  InitResult { InitFailed, InitDisabled, InitSuccess }
 
- Protected Types inherited from SIPEndPoint
typedef std::map
< PCaselessString, PINDEX > 		SRVIndexMap
 
typedef std::multimap< PString,
SIPURL > 		ConferenceMap
 
typedef PSafeDictionary
< SIPURL, RegistrarAoR > 		RegistrarDict
 
- Protected Member Functions inherited from SIPEndPoint
void AddTransport (const OpalTransportPtr &transport, KeepAliveType keepAliveType)
 
void TransportThreadMain (OpalTransportPtr transport)
 
SIP_PDU::StatusCodes InternalHandleREGISTER (SIP_PDU &request, SIP_PDU *response)
 
 PDECLARE_MUTEX (m_SRVIndexMutex)
 
 PDECLARE_INSTRUMENTED_MUTEX (m_transportsMutex, SIPTransport, 2000, 1000)
 
PSafePtr< SIPHandler > FindHandlerByPDU (const SIP_PDU &pdu, PSafetyMode mode)
 
 PDECLARE_MUTEX (m_receivedConnectionMutex)
 
 PDECLARE_InterfaceNotifier (SIPEndPoint, OnHighPriorityInterfaceChange)
 
 PDECLARE_InterfaceNotifier (SIPEndPoint, OnLowPriorityInterfaceChange)
 
 P_REMOVE_VIRTUAL_VOID (OnReceivedIntervalTooBrief(SIPTransaction &, SIP_PDU &))
 
 P_REMOVE_VIRTUAL_VOID (OnReceivedAuthenticationRequired(SIPTransaction &, SIP_PDU &))
 
 P_REMOVE_VIRTUAL_VOID (OnReceivedOK(SIPTransaction &, SIP_PDU &))
 
 P_REMOVE_VIRTUAL_VOID (OnMessageFailed(const SIPURL &, SIP_PDU::StatusCodes))
 
 P_REMOVE_VIRTUAL (SIPConnection *, CreateConnection(OpalCall &, const PString &, void *, const SIPURL &, OpalTransport *, SIP_PDU *, unsigned, OpalConnection::StringOptions *), NULL)
 
 P_REMOVE_VIRTUAL (PBoolean, OnReceivedPDU(OpalTransport &, SIP_PDU *), false)
 
 P_REMOVE_VIRTUAL (bool, OnReceivedConnectionlessPDU(OpalTransport &, SIP_PDU *), false)
 
 P_REMOVE_VIRTUAL (bool, OnReceivedConnectionlessPDU(SIP_PDU *), false)
 
 P_REMOVE_VIRTUAL (PBoolean, OnReceivedINVITE(OpalTransport &, SIP_PDU *), false)
 
 P_REMOVE_VIRTUAL (PBoolean, OnReceivedNOTIFY(OpalTransport &, SIP_PDU &), false)
 
 P_REMOVE_VIRTUAL (PBoolean, OnReceivedREGISTER(OpalTransport &, SIP_PDU &), false)
 
 P_REMOVE_VIRTUAL (PBoolean, OnReceivedSUBSCRIBE(OpalTransport &, SIP_PDU &, SIPDialogContext *), false)
 
 P_REMOVE_VIRTUAL (bool, OnReceivedMESSAGE(OpalTransport &, SIP_PDU &), false)
 
 P_REMOVE_VIRTUAL (bool, OnReceivedOPTIONS(OpalTransport &, SIP_PDU &), false)
 
 P_REMOVE_VIRTUAL (bool, OnReceivedInfoPackage(SIPConnection &, const PString &, const PString &), false)
 
- Protected Member Functions inherited from OpalRTPConsoleEndPoint
 OpalRTPConsoleEndPoint (OpalManagerConsole &console, OpalRTPEndPoint *endpoint)
 
bool Initialise (PArgList &args, ostream &output, bool verbose)
 
bool SetUIMode (const PCaselessString &str)
 
- Protected Member Functions inherited from OpalConsoleEndPoint
 OpalConsoleEndPoint (OpalManagerConsole &console)
 
void AddRoutesFor (const OpalEndPoint *endpoint, const PString &defaultRoute)
 
- Protected Attributes inherited from SIPEndPoint
SRVIndexMap m_SRVIndex
 
SIPURL m_proxy
 
PString m_userAgentString
 
PStringSet m_allowedEvents
 
SIPConnection::PRACKMode m_defaultPrackMode
 
PINDEX m_maxPacketSizeUDP
 
unsigned m_maxRetries
 
PTimeInterval m_retryTimeoutMin
 
PTimeInterval m_retryTimeoutMax
 
PTimeInterval m_nonInviteTimeout
 
PTimeInterval m_pduCleanUpTimeout
 
PTimeInterval m_inviteTimeout
 
PTimeInterval m_progressTimeout
 
PTimeInterval m_ackTimeout
 
PTimeInterval m_registrarTimeToLive
 
PTimeInterval m_notifierTimeToLive
 
PTimeInterval m_keepAliveTimeout
 
KeepAliveType m_keepAliveType
 
bool m_registeredUserMode
 
bool m_shuttingDown
 
PSafeDictionary
< OpalTransportAddress,
OpalTransport > 		m_transportsTable
 
SIPHandlers m_activeSIPHandlers
 
PStringToString m_receivedConnectionTokens
 
PSafeDictionary< PString,
SIPTransactionBase > 		m_activeTransactions
 
atomic< unsigned > m_lastSentCSeq
 
int m_defaultAppearanceCode
 
std::map< PString,
RegistrationCompletion > 		m_registrationComplete
 
ConnectionlessMessageNotifier m_onConnectionlessMessage
 
ConferenceMap m_conferenceAOR
 
RegistrarDict m_registeredUAs
 
PStringSet m_registrarDomains
 
SIPThreadPool m_threadPool
 
PInterfaceMonitor::Notifier m_onHighPriorityInterfaceChange
 
PInterfaceMonitor::Notifier m_onLowPriorityInterfaceChange
 
bool m_disableTrying
 
- Protected Attributes inherited from OpalRTPConsoleEndPoint
OpalRTPEndPoint & m_endpoint
 
- Protected Attributes inherited from OpalConsoleEndPoint
OpalManagerConsole & m_console
 
bool m_endpointDisabled
 

Constructor & Destructor Documentation

SIPConsoleEndPoint::SIPConsoleEndPoint ( OpalManagerConsole &  manager)

Member Function Documentation

bool SIPConsoleEndPoint::DoRegistration ( ostream &  output,
bool  verbose,
const PString &  aor,
const PString &  pwd,
const PArgList &  args,
const char *  authId,
const char *  realm,
const char *  proxy,
const char *  mode,
const char *  ttl 
)
virtual void SIPConsoleEndPoint::GetArgumentSpec ( ostream &  strm) const
virtual

Reimplemented from OpalRTPConsoleEndPoint.

virtual bool SIPConsoleEndPoint::Initialise ( PArgList &  args,
bool  verbose,
const PString &  defaultRoute 
)
virtual

Implements OpalConsoleEndPoint.

virtual void SIPConsoleEndPoint::OnRegistrationStatus ( const RegistrationStatus &  status)
virtual

Callback called when a registration to a SIP registrar status.

Reimplemented from SIPEndPoint.

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