PSTUNClient Class Reference

#include <pstun.h>

Inheritance diagram for PSTUNClient:

PNatMethod PObject

List of all members.

Public Types

enum  { DefaultPort = 3478 }
enum  NatTypes {
  UnknownNat, OpenNat, ConeNat, RestrictedNat,
  PortRestrictedNat, SymmetricNat, SymmetricFirewall, BlockedNat,
  PartialBlockedNat, NumNatTypes
}
enum  RTPSupportTypes { RTPOK, RTPUnknown, RTPUnsupported, RTPIfSendMedia }

Public Member Functions

 PSTUNClient (const PString &server, WORD portBase=0, WORD portMax=0, WORD portPairBase=0, WORD portPairMax=0)
 PSTUNClient (const PIPSocket::Address &serverAddress, WORD serverPort=DefaultPort, WORD portBase=0, WORD portMax=0, WORD portPairBase=0, WORD portPairMax=0)
PString GetServer () const
BOOL SetServer (const PString &server)
BOOL SetServer (const PIPSocket::Address &serverAddress, WORD serverPort=0)
NatTypes GetNatType (BOOL force=FALSE)
PString GetNatTypeName (BOOL force=FALSE)
RTPSupportTypes IsSupportingRTP (BOOL force=FALSE)
virtual BOOL GetExternalAddress (PIPSocket::Address &externalAddress, const PTimeInterval &maxAge=1000)
BOOL CreateSocket (PUDPSocket *&socket)
virtual BOOL CreateSocketPair (PUDPSocket *&socket1, PUDPSocket *&socket2)
const PTimeInterval GetTimeout () const
void SetTimeout (const PTimeInterval &timeout)
PINDEX GetRetries () const
void SetRetries (PINDEX retries)
PINDEX GetSocketsForPairing () const
void SetSocketsForPairing (PINDEX numSockets)
virtual BOOL IsAvailable ()

Static Public Member Functions

static PString GetNatTypeString (NatTypes type)

Protected Member Functions

bool OpenSocket (PUDPSocket &socket, PortInfo &portInfo) const

Protected Attributes

PIPSocket::Address serverAddress
WORD serverPort
PTimeInterval replyTimeout
PINDEX pollRetries
PINDEX numSocketsForPairing
NatTypes natType
PIPSocket::Address cachedExternalAddress
PTime timeAddressObtained


Detailed Description

STUN client.

Member Enumeration Documentation

anonymous enum

Enumerator:
DefaultPort 

Enumerator:
UnknownNat 
OpenNat 
ConeNat 
RestrictedNat 
PortRestrictedNat 
SymmetricNat 
SymmetricFirewall 
BlockedNat 
PartialBlockedNat 
NumNatTypes 

Enumerator:
RTPOK 
RTPUnknown 
RTPUnsupported 
RTPIfSendMedia 


Constructor & Destructor Documentation

PSTUNClient::PSTUNClient ( const PString server,
WORD  portBase = 0,
WORD  portMax = 0,
WORD  portPairBase = 0,
WORD  portPairMax = 0 
)

PSTUNClient::PSTUNClient ( const PIPSocket::Address serverAddress,
WORD  serverPort = DefaultPort,
WORD  portBase = 0,
WORD  portMax = 0,
WORD  portPairBase = 0,
WORD  portPairMax = 0 
)


Member Function Documentation

BOOL PSTUNClient::CreateSocket ( PUDPSocket *&  socket  ) 

Create a single socket. The STUN protocol is used to create a socket for which the external IP address and port numbers are known. A PUDPSocket descendant is returned which will, in response to GetLocalAddress() return the externally visible IP and port rather than the local machines IP and socket.

The will create a new socket pointer. It is up to the caller to make sure the socket is deleted to avoid memory leaks.

The socket pointer is set to NULL if the function fails and returns FALSE.

virtual BOOL PSTUNClient::CreateSocketPair ( PUDPSocket *&  socket1,
PUDPSocket *&  socket2 
) [virtual]

Create a socket pair. The STUN protocol is used to create a pair of sockets with adjacent port numbers for which the external IP address and port numbers are known. PUDPSocket descendants are returned which will, in response to GetLocalAddress() return the externally visible IP and port rather than the local machines IP and socket.

The will create new socket pointers. It is up to the caller to make sure the sockets are deleted to avoid memory leaks.

The socket pointers are set to NULL if the function fails and returns FALSE.

Implements PNatMethod.

virtual BOOL PSTUNClient::GetExternalAddress ( PIPSocket::Address externalAddress,
const PTimeInterval maxAge = 1000 
) [virtual]

Determine the external router address. This will send UDP packets out using the STUN protocol to determine the intervening routers external IP address.

A cached address is returned provided it is no older than the time specified.

Parameters:
externalAddress External address of router
maxAge Maximum age for caching

Implements PNatMethod.

NatTypes PSTUNClient::GetNatType ( BOOL  force = FALSE  ) 

Determine via the STUN protocol the NAT type for the router. This will cache the last determine NAT type. Use the force variable to guarantee an up to date value.

Parameters:
force Force a new check

Referenced by GetNatTypeName().

PString PSTUNClient::GetNatTypeName ( BOOL  force = FALSE  )  [inline]

Determine via the STUN protocol the NAT type for the router. As for GetNatType() but returns an English string for the type.

Parameters:
force Force a new check

References GetNatType(), and GetNatTypeString().

static PString PSTUNClient::GetNatTypeString ( NatTypes  type  )  [static]

Get NatTypes enumeration as an English string for the type.

Parameters:
type NAT Type to get name of

Referenced by GetNatTypeName(), and operator<<().

PINDEX PSTUNClient::GetRetries (  )  const [inline]

Get the number of retries for responses from STUN server.

References pollRetries.

PString PSTUNClient::GetServer (  )  const

Get the current STUN server address and port being used.

PINDEX PSTUNClient::GetSocketsForPairing (  )  const [inline]

Get the number of sockets to create in attempt to get a port pair. RTP requires a pair of consecutive ports. To get this several sockets must be opened and fired through the NAT firewall to get a pair. The busier the firewall the more sockets will be required.

References numSocketsForPairing.

const PTimeInterval PSTUNClient::GetTimeout (  )  const [inline]

Get the timeout for responses from STUN server.

References replyTimeout.

virtual BOOL PSTUNClient::IsAvailable (  )  [virtual]

Returns whether the Nat Method is ready and available in assisting in NAT Traversal. The principal is this function is to allow the EP to detect various methods and if a method is detected then this method is available for NAT traversal. The availablity of the STUN Method is dependant on the Type of NAT being used.

Reimplemented from PNatMethod.

RTPSupportTypes PSTUNClient::IsSupportingRTP ( BOOL  force = FALSE  ) 

Return an indication if the current STUN type supports RTP Use the force variable to guarantee an up to date test

Parameters:
force Force a new check

bool PSTUNClient::OpenSocket ( PUDPSocket socket,
PortInfo portInfo 
) const [protected]

void PSTUNClient::SetRetries ( PINDEX  retries  )  [inline]

Set the number of retries for responses from STUN server.

Parameters:
retries Number of retries

References pollRetries.

BOOL PSTUNClient::SetServer ( const PIPSocket::Address serverAddress,
WORD  serverPort = 0 
)

Set the STUN server to use by IP address and port. If serverPort is zero then the default port of 3478 is used.

BOOL PSTUNClient::SetServer ( const PString server  ) 

Set the STUN server to use. The server string may be of the form host:port. If :port is absent then the default port 3478 is used. The substring port can also be a service name as found in /etc/services. The host substring may be a DNS name or explicit IP address.

void PSTUNClient::SetSocketsForPairing ( PINDEX  numSockets  )  [inline]

Set the number of sockets to create in attempt to get a port pair. RTP requires a pair of consecutive ports. To get this several sockets must be opened and fired through the NAT firewall to get a pair. The busier the firewall the more sockets will be required.

Parameters:
numSockets Number opf sockets to create

References numSocketsForPairing.

void PSTUNClient::SetTimeout ( const PTimeInterval timeout  )  [inline]

Set the timeout for responses from STUN server.

Parameters:
timeout New timeout in milliseconds

References replyTimeout.


Member Data Documentation

PINDEX PSTUNClient::pollRetries [protected]

Referenced by GetRetries(), and SetRetries().

Referenced by GetTimeout(), and SetTimeout().

WORD PSTUNClient::serverPort [protected]


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

Generated on Thu Aug 20 12:07:41 2009 for PWLib by  doxygen 1.5.9