OsNatDatagramSocket.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _OsNatDatagramSocket_h_
#define _OsNatDatagramSocket_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsNatSocketBaseImpl.h"
#include "os/OsDatagramSocket.h"
#include "os/OsMsgQ.h"
#include "os/OsTimer.h"
#include "os/OsQueuedEvent.h"

// DEFINES
#define NAT_MSG_TYPE         (OsMsg::USER_START + 1) 
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class NatMsg ;
class OsEvent ;
class OsNatAgentTask;
class OsNatKeepaliveListener;
class OsNotification;


typedef enum
{
    NAT_STATUS_UNKNOWN,     
    NAT_STATUS_SUCCESS,     
    NAT_STATUS_FAILURE      
} NAT_STATUS ;


typedef enum
{
   NO_BINDING,
   STUN_BINDING,
   TURN_BINDING,
   STUN_TURN_BINDING
} NAT_BINDING;

typedef struct
{
    bool       bEnabled ;       
    NAT_STATUS status ;         
    UtlString  mappedAddress ;  
    int        mappedPort ;     
} STUN_STATE ;


typedef struct
{
    bool       bEnabled ;   
    NAT_STATUS status ;     
    UtlString  relayAddress ;   
    int        relayPort ;      
} TURN_STATE ;

class OsNatDatagramSocket : public OsDatagramSocket, public OsNatSocketBaseImpl
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
    friend class OsNatAgentTask ;

/* ============================ CREATORS ================================== */
    OsNatDatagramSocket(int remoteHostPort, 
                        const char* remoteHostName, 
                        int localHostPort = PORT_DEFAULT,
                        const char* localHostName = NULL,
                        OsNotification* pNotification = NULL) ;

    virtual ~OsNatDatagramSocket();

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

    virtual OsSocket* getSocket();
    
    virtual int read(char* buffer, int bufferLength) ;

    virtual int read(char* buffer, int bufferLength,
            UtlString* ipAddress, int* port);

    virtual int read(char* buffer, int bufferLength,
            struct in_addr* ipAddress, int* port);

    virtual int read(char* buffer, int bufferLength, long waitMilliseconds);


    virtual int write(const char* buffer, int bufferLength);

    virtual int socketWrite(const char* buffer, int bufferLength,
                      const char* ipAddress, int port, PacketType packetType=UNKNOWN_PACKET);

    virtual int write(const char* buffer, int bufferLength,
                      const char* ipAddress, int port);

    virtual int write(const char* buffer, int bufferLength, 
                      long waitMilliseconds);

    virtual void enableStun(const char* szStunServer, 
                            int stunPort,
                            int iKeepAlive, 
                            int stunOptions, 
                            bool bReadFromSocket) ;

    virtual void disableStun() ;


    virtual void enableTurn(const char* szTurnSever,
                            int turnPort,
                            int iKeepAlive,
                            const char* username,
                            const char* password,  
                            bool bReadFromSocket) ;

    virtual void disableTurn() ;

    virtual bool waitForBinding(NAT_BINDING binding, bool bWaitUntilReady);

    virtual void enableTransparentReads(bool bEnable) ;


    virtual void addAlternateDestination(const char* szAddress, int iPort, int priority) ;


    virtual void setReadNotification(OsNotification* pNotification) ;


    virtual void readyDestination(const char* szAddress, int iPort) ;

    virtual void setNotifier(OsNotification* pNotification) ;

    virtual UtlBoolean addCrLfKeepAlive(const char* szRemoteIp,
                                        const int   remotePort, 
                                        const int   keepAliveSecs,
                                        OsNatKeepaliveListener* pListener) ;

    virtual UtlBoolean removeCrLfKeepAlive(const char* szRemoteIp, 
                                          const int   remotePort) ;

    virtual UtlBoolean addStunKeepAlive(const char* szRemoteIp, 
                                        const int   remotePort, 
                                        const int   keepAliveSecs,
                                        OsNatKeepaliveListener* pListener) ;

    virtual UtlBoolean removeStunKeepAlive(const char* szRemoteIp, 
                                          const int   remotePort) ;

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

   virtual UtlBoolean getMappedIp(UtlString* ip, int* port) ;


   virtual UtlBoolean getRelayIp(UtlString* ip, int* port) ;

   virtual UtlBoolean getBestDestinationAddress(UtlString& address, int& iPort) ;

   virtual UtlBoolean applyDestinationAddress(const char* szAddress, int iPort) ;
   
   virtual void destroy();



/* ============================ INQUIRY =================================== */


/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

    void setStunAddress(const UtlString& address, const int iPort) ;


    void setTurnAddress(const UtlString& address, const int iPort) ;


    void markStunFailure() ;


    void markStunSuccess(bool bAddressChanged) ;


    void markTurnFailure() ;


    void markTurnSuccess() ;


    void evaluateDestinationAddress(const UtlString& address, int iPort, int priority) ;       

    /* ICE Settings */
    int miDestPriority ;        
    UtlString mDestAddress;     
    int miDestPort ;            
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    STUN_STATE mStunState ; 
    TURN_STATE mTurnState ; 
    /* Global Attributes */
    OsNatAgentTask* mpNatAgent;      
    bool mbTransparentReads ;        
    OsNotification* mpNotification ; 
    bool            mbNotified ;     
};

/* ============================ INLINE METHODS ============================ */


/* ///////////////////////// HELPER CLASSES /////////////////////////////// */



#endif  // _OsNatDatagramSocket_h_