iax2ep.h

Go to the documentation of this file.

/*
 *
 * Inter Asterisk Exchange 2
 * 
 * Open Phone Abstraction Library (OPAL)
 *
 * Describes the IAX2 extension of the OpalEndpoint class.
 *
 * Copyright (c) 2005 Indranet Technologies 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 Indranet Technologies Ltd.
 *
 * The author of this code is Derek J Smithies
 */

#ifndef OPAL_IAX2_IAX2EP_H
#define OPAL_IAX2_IAX2EP_H

#ifndef _PTLIB_H
#include <ptlib.h>
#endif

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_IAX2

#include <opal/endpoint.h>
#include <iax2/iax2con.h>
#include <iax2/processor.h>
#include <iax2/regprocessor.h>
#include <iax2/specialprocessor.h>

class IAX2Receiver;
class IAX2Transmit;
class IAX2Processor;

class IAX2IncomingEthernetFrames : public PThread
{
  PCLASSINFO(IAX2IncomingEthernetFrames, PThread);
public:

  IAX2IncomingEthernetFrames();
   
  ~IAX2IncomingEthernetFrames() { }

  /*The method which gets everythig to happen */
  virtual void Main();
   
  void Assign(IAX2EndPoint *ep);

  void ProcessList() { activate.Signal(); }

  void Terminate();

 protected:
  IAX2EndPoint *endpoint;
   
  PSyncPoint activate;

  PBoolean           keepGoing;
};




class IAX2EndPoint : public OpalEndPoint
{
  PCLASSINFO(IAX2EndPoint, OpalEndPoint);
 public:
   enum { DefaultUdpPort = 4569 };

  IAX2EndPoint(
    OpalManager & manager
  );
  
  ~IAX2EndPoint();
  
    virtual PString GetDefaultTransport() const;

    virtual WORD GetDefaultSignalPort() const;


  virtual PSafePtr<OpalConnection> MakeConnection(
                              OpalCall & call,          
                              const PString & party,    
                              void * userData = NULL,   
                              unsigned int options = 0, 
                              OpalConnection::StringOptions * stringOptions = NULL
                              );
  
  virtual IAX2Connection * CreateConnection(
                                           OpalCall & call,            
                                           const PString & token,      
                                           void * userData,             
                                           const PString & remoteParty, 
             const PString & remotePartyName = PString::Empty() 
                                           );
  
  PBoolean Initialise();

  virtual void IncomingEthernetFrame (IAX2Frame *frame);
  
  PBoolean ConectionForFrameIsAlive(IAX2Frame *f);
  
  PINDEX NextSrcCallNumber(IAX2Processor * processor);
      
  void ReportStoredConnections();
  
  WORD ListenPortNumber()  { return 4569; }
      
  IAX2Transmit *transmitter;
  
  IAX2Receiver    *receiver;
  
  PString GetLocalUserName() { return m_localUserName; }
  
  PString GetLocalNumber() { return m_localNumber; }
  
  void SetLocalUserName(PString newValue); 
  
  void SetLocalNumber(PString newValue);
  
  PString & GetPassword() { return m_password; }
  
  void SetPassword(PString newValue);

  PBoolean ConnectionForFrameIsAlive(IAX2Frame *f);
 
  PINDEX GetOutSequenceNumberForStatusQuery();
  
  void StartRinging(PString remoteCaller);
  
    void NewIncomingConnection(
      IAX2Frame *f  
                );

    void OnEstablished(
       OpalConnection & con
    );

    virtual void OnReleased(
      OpalConnection & connection   
    );

  virtual OpalMediaFormatList GetMediaFormats() const;

  PINDEX GetSupportedCodecs(OpalMediaFormatList & list);
  
  PINDEX GetPreferredCodec(OpalMediaFormatList & list);

  void GetCodecLengths(PINDEX src, PINDEX &compressedBytes, PINDEX &duration);
  
  enum IAX2RemoteAddressFields {
    protoIndex     = 0,     
    userIndex      = 1,     
    transportIndex = 2,     
    addressIndex   = 3,     
    portIndex      = 4,     
    extensionIndex = 5,     
    contextIndex   = 6,     
    maximumIndex   = 7      
  };

  static PStringArray DissectRemoteParty(const PString & other);

  void ProcessReceivedEthernetFrames();

  void ReportTransmitterLists(PString & answer, bool getFullReport = false);

  void CopyLocalMediaFormats(OpalMediaFormatList & list);
  
  void Register(
      const PString & host,
      const PString & username,
      const PString & password = PString::Empty(),
      PINDEX requestedRefreshTime = 60
    );
  
  enum RegisteredError {
    RegisteredFailureUnknown
  };
  
  virtual void OnRegistered(
      const PString & host,
      const PString & userName,
      PBoolean isFailure,
      RegisteredError reason = RegisteredFailureUnknown);
   
  void Unregister(
      const PString & host,
      const PString & username);
      
  enum UnregisteredError {
    UnregisteredFailureUnknown
  };
      
  virtual void OnUnregistered(
      const PString & host,
      const PString & userName,
      PBoolean isFailure,
      UnregisteredError reason = UnregisteredFailureUnknown);
      
  
  PBoolean IsRegistered(const PString & host, const PString & username);
  
  PINDEX GetRegistrationsCount();
  
  PString BuildUrl(
    const PString & host,
    const PString & userName = PString::Empty(),
    const PString & extension = PString::Empty(),
    const PString & context = PString::Empty(),
    const PString & transport = PString::Empty()
  );
  
  PBoolean InitialisedOK() { return (transmitter != NULL) && (receiver != NULL); }

  PBoolean EthernetFramesToBeProcessed() 
  { return m_packetsReadFromEthernet.GetSize() > 0; }
  
 protected:
  IAX2IncomingEthernetFrames m_incomingFrameHandler;

  IAX2FrameList   m_packetsReadFromEthernet;
  
  PUDPSocket  *m_sock;

  int m_callnumbs;
  
  PDECLARE_MUTEX(m_callNumbLock);
  
  PTime m_callStartTime;
  
  PString m_localUserName;
  
  PString m_localNumber;
  
  PString m_password;
  
  PINDEX m_statusQueryCounter;
  
  PDECLARE_MUTEX(m_statusQueryMutex);
  
  IAX2SpecialProcessor * specialPacketHandler;
    
  PBoolean ProcessInMatchingConnection(IAX2Frame *f);  

    PBoolean ProcessFrameInConnection(IAX2Frame *f, const PString & token);  
    
  PBoolean ProcessInConnectionTestAll(IAX2Frame *f);
  
  PStringToString  m_tokenTable;
  
  PReadWriteMutex  m_mutexTokenTable;

  atomic<uint32_t> m_callsEstablished;

  OpalMediaFormatList localMediaFormats;
  
  PDECLARE_MUTEX(m_regProcessorsMutex);
  
  PArrayObjects m_regProcessors;
  
};


#endif // OPAL_IAX2

#endif // OPAL_IAX2_IAX2EP_H

/* The comment below is magic for those who use emacs to edit this file.
 * With the comment below, the tab key does auto indent to 2 spaces.    
 *
 * Local Variables:
 * mode:c
 * c-basic-offset:2
 * End:
 */