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

#ifndef OPAL_IAX2_REMOTE_H
#define OPAL_IAX2_REMOTE_H

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

#include <opal_config.h>

#if OPAL_IAX2

#include <ptlib/sockets.h>
#include <ptclib/pssl.h>

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

  PString BuildOurConnectionToken();

  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);
  
  PBoolean operator == (IAX2Remote & other);
  
  PBoolean operator *= (IAX2Remote & other);
  
  
  PBoolean 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
  
  PBoolean 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();
  
  PBoolean IsFirstReplyFrame();

  PBoolean IsSequenceNosZero();

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

  void SetInOutSeqNo(PINDEX inVal, PINDEX outVal);
  
  void SetAckSequenceInfo(IAX2SequenceNumbers & other);
  
  PBoolean  operator !=(IAX2SequenceNumbers &other);
  
  PBoolean 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;

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

  void AddWrapAroundValue(PINDEX newOffset);


 protected:

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

  PDECLARE_MUTEX(mutex);

  PINDEX lastSentTimeStamp;

  IAX2PacketIdList receivedLog;
};


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

  void SetEncryptionOn (PBoolean newState = true);

  void SetEncryptionKey(PString & newKey);

  void SetChallengeKey(PString & newKey);

  const PString & EncryptionKey() const;

  const PString & ChallengeKey() const;

  PBoolean IsEncrypted() const;

#ifdef P_SSL_AES

  PAESContext & AesEncryptKey() { return m_aesEncryptKey; }

  PAESContext & AesDecryptKey() { return m_aesDecryptKey; }
#endif

 protected:
  void CalculateAesKeys();

  PString encryptionKey;

  PString challengeKey;

  PBoolean encryptionEnabled;

#ifdef P_SSL_AES

  PAESContext m_aesEncryptKey;

  PAESContext m_aesDecryptKey;
#endif
};



#endif // OPAL_IAX2

#endif // OPAL_IAX2_REMOTE_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:
 */