remote.h

Go to the documentation of this file.

/*
 *
 *
 * Inter Asterisk Exchange 2
 * 
 * A class to describe the node we are talking to.
 * 
 * Open Phone Abstraction Library (OPAL)
 *
 * 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: remote.h,v $
 *  Revision 1.8  2007/04/19 06:17:21  csoutheren
 *  Fixes for precompiled headers with gcc
 *
 *  Revision 1.7  2007/01/23 02:08:25  dereksmithies
 *  Handle Vnak frames correctly. handle iseqno and oseqno correctly.
 *
 *  Revision 1.6  2006/08/09 03:46:40  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.5  2005/08/28 23:51:29  dereksmithies
 *  Improve test for massaging timestamps in fullframes. Thanks to Adrian Sietsma
 *
 *  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 13:06:18  rjongbloed
 *  Added configuration define for AEC encryption
 *
 *  Revision 1.2  2005/08/24 01:38:38  dereksmithies
 *  Add encryption, iax2 style. Numerous tidy ups. Use the label iax2, not iax
 *
 *  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 REMOTE_H
#define REMOTE_H

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

#include <ptlib/sockets.h>

#if P_SSL_AES
#include <openssl/aes.h>
#endif

#ifdef P_USE_PRAGMA
#pragma interface
#endif

class IAX2FullFrame;


class IAX2Remote : public PObject
{ 
  PCLASSINFO(IAX2Remote, PObject);
  
 public:
  
  IAX2Remote();
  
  virtual ~IAX2Remote() { };
  
  PINDEX DestCallNumber() { return destCallNumber; }
  
  PINDEX SourceCallNumber() { return sourceCallNumber; }
 
  virtual void PrintOn(ostream & strm) const; 
  
  enum {
    callNumberUndefined = 0xffff 
  };
  
  PIPSocket::Address RemoteAddress() { return remoteAddress; }
  
  PINDEX   RemotePort() { return remotePort; }
  
  void Assign(IAX2Remote &);
  
  void SetRemoteAddress(PIPSocket::Address &newVal) { remoteAddress = newVal; }
  
  void SetRemoteAddress(int newVal) { remoteAddress = newVal; }
  
  void SetRemotePort (PINDEX newVal) { remotePort = newVal; }
  
  void SetSourceCallNumber(PINDEX newVal) { sourceCallNumber = newVal; }
  
  void SetDestCallNumber(PINDEX newVal) { destCallNumber = newVal; }
  
  BOOL operator == (IAX2Remote & other);
  
  BOOL operator *= (IAX2Remote & other);
  
  
  BOOL operator != (IAX2Remote & other);
  
  
 protected:
  PINDEX       sourceCallNumber;    
  
  PINDEX       destCallNumber;      
  
  PIPSocket::Address remoteAddress; 
  
  PINDEX               remotePort;    

};


class IAX2FrameIdValue : public PObject
{
  PCLASSINFO(IAX2FrameIdValue, PObject);
 public:
  IAX2FrameIdValue (PINDEX timeStamp, PINDEX seqVal);

  IAX2FrameIdValue (PINDEX val);

  PINDEX GetTimeStamp() const;

  PINDEX GetSequenceVal() const;

  PINDEX GetPlainSequence() const;

  virtual void PrintOn(ostream & strm) const;

  virtual Comparison Compare(const PObject & obj) const;

 protected:

  PUInt64 value;
};


PDECLARE_SORTED_LIST(IAX2PacketIdList, IAX2FrameIdValue)
#ifdef DOC_PLUS_PLUS
class IAX2PacketIdList : public PSortedList
{
#endif
  
  BOOL Contains(IAX2FrameIdValue &src);
  
  PINDEX GetFirstValue();
  
  void AppendNewFrame(IAX2FullFrame &src);
  
  virtual void PrintOn(ostream & strm) const;   
  
 protected:
  void RemoveOldContiguousValues();
};


class IAX2SequenceNumbers
{
 public:
  enum IncomingOrder {
    InSequence,  
    SkippedFrame, 
    RepeatedFrame 
  };



  IAX2SequenceNumbers() 
    { ZeroAllValues();   };
  
  virtual ~IAX2SequenceNumbers() { }
  
  void ZeroAllValues();
  
  PINDEX InSeqNo();
  
  PINDEX OutSeqNo();
  
  BOOL IsSequenceNosZero();

  void SetInSeqNo(PINDEX newVal);
  
  void SetOutSeqNo(PINDEX newVal);

  void SetInOutSeqNo(PINDEX inVal, PINDEX outVal);
  
  void SetAckSequenceInfo(IAX2SequenceNumbers & other);
  
  BOOL  operator !=(IAX2SequenceNumbers &other);
  
  BOOL operator ==(IAX2SequenceNumbers &other);
  
  void MassageSequenceForSending(IAX2FullFrame &src /*<!src will be transmitted to the remote node */
                                 );

  void WrapAroundFrameSequence(IAX2SequenceNumbers & src);
  
  IncomingOrder IncomingMessageInOrder
    (IAX2FullFrame &src /*<!frame to be compared with current data base.*/  );
  
  void CopyContents(IAX2SequenceNumbers &src);
  
  PString AsString() const;
  
  virtual void PrintOn(ostream & strm) const;

  BOOL IsFirstReply() { return (inSeqNo == 1) && (outSeqNo == 0); }

  void AddWrapAroundValue(PINDEX newOffset);


 protected:

  enum sequenceDefines {
    minSpacing = 3   
  };
  
  PINDEX inSeqNo;  
  
  PINDEX outSeqNo; 

  PMutex mutex;

  PINDEX lastSentTimeStamp;

  IAX2PacketIdList receivedLog;
};


class IAX2Encryption : public PObject 
{
  PCLASSINFO(IAX2Encryption, PObject);
 public:
  IAX2Encryption();

  void SetEncryptionOn (BOOL newState = TRUE);

  void SetEncryptionKey(PString & newKey);

  void SetChallengeKey(PString & newKey);

  const PString & EncryptionKey() const;

  const PString & ChallengeKey() const;

  const BOOL IsEncrypted() const;

#if P_SSL_AES

  AES_KEY *AesEncryptKey();

  AES_KEY *AesDecryptKey();
#endif

 protected:
  void CalculateAesKeys();

  PString encryptionKey;

  PString challengeKey;

  BOOL encryptionEnabled;

#if P_SSL_AES

  AES_KEY aesEncryptKey;

  AES_KEY aesDecryptKey;
#endif
};


#endif

/* 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:
 */

---