IAX2Remote Class Reference

#include <remote.h>

List of all members.

Public Types

enum  { callNumberUndefined = 0xffff }

Public Member Functions

 IAX2Remote ()
virtual ~IAX2Remote ()
PINDEX DestCallNumber ()
PINDEX SourceCallNumber ()
virtual void PrintOn (ostream &strm) const
PIPSocket::Address RemoteAddress ()
PINDEX RemotePort ()
void Assign (IAX2Remote &)
void SetRemoteAddress (PIPSocket::Address &newVal)
void SetRemoteAddress (int newVal)
void SetRemotePort (PINDEX newVal)
void SetSourceCallNumber (PINDEX newVal)
void SetDestCallNumber (PINDEX newVal)
BOOL operator== (IAX2Remote &other)
BOOL operator*= (IAX2Remote &other)
BOOL operator!= (IAX2Remote &other)

Protected Attributes

PINDEX sourceCallNumber
PINDEX destCallNumber
PIPSocket::Address remoteAddress
PINDEX remotePort


Detailed Description

A simple class which contains the different source and dest call numbers, and the remote address + remote port

Member Enumeration Documentation

anonymous enum

Define which is used to indicate the call number is undefined

Enumerator:
callNumberUndefined 


Constructor & Destructor Documentation

IAX2Remote::IAX2Remote (  ) 

Constructor

virtual IAX2Remote::~IAX2Remote (  )  [inline, virtual]


Member Function Documentation

PINDEX IAX2Remote::DestCallNumber (  )  [inline]

Call number as used at the destination of this data frame. If we are receiving this packet, it refers to our call number.

References destCallNumber.

PINDEX IAX2Remote::SourceCallNumber (  )  [inline]

Call number as used at the source of this data frame. If we are receiving this packet, it refers to the call number at the remote host.

References sourceCallNumber.

Referenced by IAX2Processor::MatchingLocalCallNumber().

virtual void IAX2Remote::PrintOn ( ostream &  strm  )  const [virtual]

Pretty print this remote structure (address & port) to the designated stream

PIPSocket::Address IAX2Remote::RemoteAddress (  )  [inline]

Return the current value of the ip address used by the other end of this call

References remoteAddress.

PINDEX IAX2Remote::RemotePort (  )  [inline]

return the current value of the port at the other end of this call

References remotePort.

void IAX2Remote::Assign ( IAX2Remote  ) 

Copy data from supplied Remote structure to this class

void IAX2Remote::SetRemoteAddress ( PIPSocket::Address &  newVal  )  [inline]

Set the remote address as used by this class

References remoteAddress.

void IAX2Remote::SetRemoteAddress ( int  newVal  )  [inline]

Set the remote address as used by this class

References remoteAddress.

void IAX2Remote::SetRemotePort ( PINDEX  newVal  )  [inline]

Set the remote port, as used bye this class

References remotePort.

void IAX2Remote::SetSourceCallNumber ( PINDEX  newVal  )  [inline]

Set the Source Call Number, as used by this class

References sourceCallNumber.

void IAX2Remote::SetDestCallNumber ( PINDEX  newVal  )  [inline]

Set the Dest Call Number, as used by this class

References destCallNumber.

BOOL IAX2Remote::operator== ( IAX2Remote other  ) 

Return true if remote port & address & destCallNumber & source call number match up. This is used when finding a Connection that generated an ethernet frame which is to be transmitted

BOOL IAX2Remote::operator*= ( IAX2Remote other  ) 

Return true if remote port & address & destCallNumber==sourceCallNumber match up. This is used when finding a Connection to process an incoming ethernet frame

BOOL IAX2Remote::operator!= ( IAX2Remote other  ) 

Returns true if these are are different


Member Data Documentation

PINDEX IAX2Remote::sourceCallNumber [protected]

Call number at the local computer.

Referenced by SetSourceCallNumber(), and SourceCallNumber().

PINDEX IAX2Remote::destCallNumber [protected]

Call number at the remote computer.

Referenced by DestCallNumber(), and SetDestCallNumber().

PIPSocket::Address IAX2Remote::remoteAddress [protected]

Ip address used by the remote endpoint

Referenced by RemoteAddress(), and SetRemoteAddress().

PINDEX IAX2Remote::remotePort [protected]

Port number used by the remote endpoint.

Referenced by RemotePort(), and SetRemotePort().


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

Generated on Wed Dec 17 08:09:02 2008 for OPAL by  doxygen 1.5.6