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
 *
 *  $Log: iax2ep.h,v $
 *  Revision 1.17  2007/08/13 04:24:26  csoutheren
 *  Normalise IAX2 answer logic
 *
 *  Revision 1.16  2007/08/09 22:15:44  dereksmithies
 *  Formatting tidyup. No functional difference.
 *
 *  Revision 1.15  2007/08/03 01:24:06  dereksmithies
 *  Tidyups so it compiles...
 *
 *  Revision 1.14  2007/08/02 23:25:07  dereksmithies
 *  Rework iax2 handling of incoming calls. This should ensure that woomera/simpleopal etc
 *  will correctly advise on receiving an incoming call.
 *
 *  Revision 1.13  2007/04/19 06:17:21  csoutheren
 *  Fixes for precompiled headers with gcc
 *
 *  Revision 1.12  2007/03/13 00:32:16  csoutheren
 *  Simple but messy changes to allow compile time removal of protocol
 *  options such as H.450 and H.460
 *  Fix MakeConnection overrides
 *
 *  Revision 1.11  2007/03/01 05:51:03  rjongbloed
 *  Fixed backward compatibility of OnIncomingConnection() virtual
 *    functions on various classes. If an old override returned FALSE
 *    then it will now abort the call as it used to.
 *
 *  Revision 1.10  2007/01/24 04:00:55  csoutheren
 *  Arrrghh. Changing OnIncomingConnection turned out to have a lot of side-effects
 *  Added some pure viritual functions to prevent old code from breaking silently
 *  New OpalEndpoint and OpalConnection descendants will need to re-implement
 *  OnIncomingConnection. Sorry :)
 *
 *  Revision 1.9  2007/01/12 02:39:00  dereksmithies
 *  Remove the notion of srcProcessors and dstProcessor lists from the ep.
 *  Ensure that the connection looks after the callProcessor.
 *
 *  Revision 1.8  2007/01/09 03:32:23  dereksmithies
 *  Tidy up and improve the close down process - make it more robust.
 *  Alter level of several PTRACE statements. Add Terminate() method to transmitter and receiver.
 *
 *  Revision 1.7  2006/12/18 03:18:41  csoutheren
 *  Messy but simple fixes
 *    - Add access to SIP REGISTER timeout
 *    - Ensure OpalConnection options are correctly progagated
 *
 *  Revision 1.6  2006/09/11 03:08:51  dereksmithies
 *  Add fixes from Stephen Cook (sitiveni@gmail.com) for new patches to
 *  improve call handling. Notably, IAX2 call transfer. Many thanks.
 *  Thanks also to the Google summer of code for sponsoring this work.
 *
 *  Revision 1.5  2006/08/09 03:46:39  dereksmithies
 *  Add ability to register to a remote Asterisk box. The iaxProcessor class is split
 *  into a callProcessor and a regProcessor class.
 *  Big thanks to Stephen Cook, (sitiveni@gmail.com) for this work.
 *
 *  Revision 1.4  2005/08/26 03:07:38  dereksmithies
 *  Change naming convention, so all class names contain the string "IAX2"
 *
 *  Revision 1.3  2005/08/24 01:38:38  dereksmithies
 *  Add encryption, iax2 style. Numerous tidy ups. Use the label iax2, not iax
 *
 *  Revision 1.2  2005/08/04 08:14:17  rjongbloed
 *  Fixed Windows build under DevStudio 2003 of IAX2 code
 *
 *  Revision 1.1  2005/07/30 07:01:32  csoutheren
 *  Added implementation of IAX2 (Inter Asterisk Exchange 2) protocol
 *  Thanks to Derek Smithies of Indranet Technologies Ltd. for
 *  writing and contributing this code
 *
 *
 *
 *
 *
 */

#ifndef IAX_ENDPOINT_H
#define IAX_ENDPOINT_H

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

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#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();

  void Terminate();

 protected:
  IAX2EndPoint *endpoint;
   
  PSyncPoint activate;

  BOOL           keepGoing;
};




class IAX2EndPoint : public OpalEndPoint
{
  PCLASSINFO(IAX2EndPoint, OpalEndPoint);
 public:
  IAX2EndPoint(
    OpalManager & manager
  );
  
  ~IAX2EndPoint();
  
  virtual BOOL NewIncomingConnection(
    OpalTransport * transport  
  );
  
  virtual BOOL 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() 
                                           );
  
  BOOL Initialise();

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

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

    void OnEstablished(
       OpalConnection & con
    );

  virtual OpalMediaFormatList GetMediaFormats() const;

  virtual BOOL OnIncomingCall(IAX2Connection & conn);

  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,     
    extensionIndex = 4,     
    contextIndex   = 5,     
    maximumIndex   = 6      
  };

  static PStringList DissectRemoteParty(const PString & other);

  void ProcessReceivedEthernetFrames();


  void ReportTransmitterLists();

  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,
      BOOL isFailure,
      RegisteredError reason = RegisteredFailureUnknown);
   
  void Unregister(
      const PString & host,
      const PString & username);
      
  enum UnregisteredError {
    UnregisteredFailureUnknown
  };
      
  virtual void OnUnregistered(
      const PString & host,
      const PString & userName,
      BOOL isFailure,
      UnregisteredError reason = UnregisteredFailureUnknown);
      
  
  BOOL 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()
  );
  
  
 protected:
  IAX2IncomingEthernetFrames incomingFrameHandler;

  IAX2FrameList   packetsReadFromEthernet;
  
  PUDPSocket  *sock;
  
  int callnumbs;
  
  PMutex callNumbLock;
  
  PTime callStartTime;
  
  PString localUserName;
  
  PString localNumber;
  
  PString password;
  
  PINDEX statusQueryCounter;
  
  PMutex statusQueryMutex;
  
  IAX2SpecialProcessor * specialPacketHandler;
    
  BOOL ProcessInMatchingConnection(IAX2Frame *f);  
    
  BOOL AddNewTranslationEntry(IAX2Frame *f);
  
  PStringToString    tokenTable;
  
  PMutex             mutexTokenTable;

  PAtomicInteger callsEstablished;

  OpalMediaFormatList localMediaFormats;
  
  PMutex regProcessorsMutex;
  
  PArrayObjects regProcessors;
  
};

#endif // IAX_ENDPOINT_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 4 spaces.     */

/*
 * Local Variables:
 * mode:c
 * c-file-style:linux
 * c-basic-offset:2
 * End:
 */

---