IStunSocket.h

Go to the documentation of this file.

// 
// Copyright (C) 2006 Pingtel Corp.
// 
// $$

#ifndef _IStunSocket_h_
#define _IStunSocket_h_

#include "os/OsDateTime.h"
#include "os/OsMsg.h"
#include "utl/UtlString.h"

// DEFINES
#define NAT_MSG_TYPE         (OsMsg::USER_START + 1) 
// The follow defines are used to keep track of what has been recorded for
// various time-based metrics.
#define ONDS_MARK_NONE           0x00000000
#define ONDS_MARK_FIRST_READ     0x00000001
#define ONDS_MARK_LAST_READ      0x00000002
#define ONDS_MARK_FIRST_WRITE    0x00000004
#define ONDS_MARK_LAST_WRITE     0x00000008

#define MAX_RTP_BYTES 4096

typedef enum
{
    UNKNOWN_PACKET,
    MEDIA_PACKET,
    STUN_PROBE_PACKET,
    STUN_DISCOVERY_PACKET,
    TURN_PACKET,
    CRLF_KEEPALIVE_PACKET,
    STUN_KEEPALIVE_PACKET,
    OTHER_PACKET
} PacketType ;

 typedef enum 
 {
   RTP_TRANSPORT_UNKNOWN = 0x00000000,
   RTP_TRANSPORT_UDP = 0x00000001,
   RTP_TRANSPORT_TCP = 0x00000002,
   RTP_TCP_ROLE_ACTIVE = 0x00000004,
   RTP_TCP_ROLE_PASSIVE = 0x00000008,
   RTP_TCP_ROLE_ACTPASS = 0x00000010,
   RTP_TCP_ROLE_CONNECTION = 0x00000020,
} RTP_TRANSPORT ;

typedef int RtpTransportOptions;
typedef int RtpTcpRoles;

class OsSocket;
class OsNotification; 

typedef enum 
{
    STUN = 0x02,
    DATA = 0x03
} TURN_FRAMING_TYPE;

class IStunSocket
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ MANIPULATORS ============================== */

    virtual ~IStunSocket() {};
    
    
    virtual OsSocket* getSocket() = 0;
    
    virtual int socketWrite(const char* buffer, int bufferLength,
                      const char* ipAddress, int port, PacketType packetType=UNKNOWN_PACKET) = 0;    
    
    virtual UtlBoolean getRelayIp(UtlString* ip, int* port) = 0;
    virtual UtlBoolean getMappedIp(UtlString* ip, int* port) = 0;
    
    virtual void enableTransparentReads(bool bEnable) = 0;    
    
    virtual void enableStun(const char* szStunServer, 
                            int stunPort,
                            int iKeepAlive, 
                            int stunOptions, 
                            bool bReadFromSocket) = 0;



    virtual void setStunAddress(const UtlString& address, const int iPort) = 0;
    
    virtual void setTurnAddress(const UtlString& address, const int iPort) = 0;


    virtual void markStunFailure() = 0;


    virtual void markStunSuccess(bool bAddressChanged) = 0;


    virtual void markTurnFailure() = 0;


    virtual void markTurnSuccess() = 0;


    virtual void evaluateDestinationAddress(const UtlString& address, int iPort, int priority) = 0;    
    
    
    virtual void enableTurn(const char* szTurnSever,
                            int turnPort,
                            int iKeepAlive,
                            const char* username,
                            const char* password,  
                            bool bReadFromSocket) = 0;
                            
   virtual void readyDestination(const char* szAddress, int iPort) = 0;        
    
   virtual UtlBoolean applyDestinationAddress(const char* szAddress, int iPort) = 0;
   
   virtual UtlBoolean getBestDestinationAddress(UtlString& address, int& iPort) = 0;   
                           
    virtual void addAlternateDestination(const char* szAddress, int iPort, int priority) = 0;                           


    virtual void setReadNotification(OsNotification* pNotification) = 0 ;

/* ============================ ACCESSORS ================================= */

    virtual bool getFirstReadTime(OsDateTime& time) = 0 ;

    virtual bool getLastReadTime(OsDateTime& time) = 0 ;

    virtual bool getFirstWriteTime(OsDateTime& time) = 0 ;

    virtual bool getLastWriteTime(OsDateTime& time) = 0 ;
    
    virtual void destroy() = 0;

};




#endif // #ifndef _IStunSocket_h_