OsNatConnectionSocket.h

Go to the documentation of this file.

// $Id$
//
// Copyright (C) 2005 Pingtel Corp.
//
// $$

#ifndef _OsNatConnectionSocket_h_
#define _OsNatConnectionSocket_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsConnectionSocket.h"
#include "os/OsNatDatagramSocket.h"
#include "os/OsMsgQ.h"
#include "os/OsTimer.h"
#include "os/OsQueuedEvent.h"
#include "os/OsRWMutex.h"
#include "os/OsNatSocketBaseImpl.h"
#include "utl/UtlHashMap.h"


// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS

// TYPEDEFS
// FORWARD DECLARATIONS
class NatMsg ;
class OsEvent ;
class OsNatAgentTask;
class OsNatKeepaliveListener;



class OsNatConnectionSocket : public OsConnectionSocket, public OsNatSocketBaseImpl
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
    friend class OsNatAgentTask ;

/* ============================ CREATORS ================================== */
    OsNatConnectionSocket(int connectedSocketDescriptor,
                          const RtpTcpRoles role);

    OsNatConnectionSocket(const char* szLocalIp,
                          int connectedSocketDescriptor,
                          const RtpTcpRoles role);

    // Constructor
    OsNatConnectionSocket(int serverPort,
                          const char* serverName,
                          UtlBoolean blockingConnect,
                          const char* localIp,
                          const bool bConnect,
                          const RtpTcpRoles role);

    virtual ~OsNatConnectionSocket();

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

    virtual OsSocket* getSocket();

    virtual void setRole(const RtpTcpRoles role);
    virtual const RtpTcpRoles getRole() const;
    
    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 void enableTransparentReads(bool bEnable) ;


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

    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) ;


   const char* frameBuffer(TURN_FRAMING_TYPE type,
                            const char* buffer,
                            const int bufferLength,
                            int& framedBufferLen);
   virtual void destroy();
   
    virtual int clientConnect(const char* szServer, const int port);
    virtual bool isClientConnected(const char* szServer, const int port);
    virtual OsNatConnectionSocket* getClientConnection(const char* szServer, const int port);


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


/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
    RtpTcpRoles mRole;
    
    mutable OsRWMutex mRoleMutex;
    mutable OsMutex mStreamHandlerMutex;

    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) ;    
    


    virtual void handleFramedStream(   char* pData,
                                       const int size,
                                       const char* receivedIp,
                                       const int port);
                                                      
    virtual bool handleUnframedBuffer(const TURN_FRAMING_TYPE type,
                                        const char* buff,
                                        const int buffSize,
                                        const char* receivedIp,
                                        const int port);                                                      
    
    bool mbTransparentReads ;        
    OsNatDatagramSocket* mpDatagramSocket;    
    
    void addClientConnection(const char* ipAddress, const int port, OsNatConnectionSocket* pClient);
    UtlHashMap mClientConnectionSockets;    // map of client connection sockets
                                            // key = destination IP address
                                            // value = OsNatConnectionSocket pointer


/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

    STUN_STATE mStunState ; 
    TURN_STATE mTurnState ; 
    /* Global Attributes */
    OsNatAgentTask* mpNatAgent;      
    OsNotification* mpNotification ; 
    bool            mbNotified ;     
    /* ICE Settings */
    int miDestPriority ;        
    UtlString mDestAddress;     
    int miDestPort ;            
    char      mszFragment[(MAX_RTP_BYTES + 4)];
    int       mFragmentSize;
};


#endif  // _OsNatConnectionSocket_h_