TransportSelector.hxx

Go to the documentation of this file.

#if !defined(RESIP_TRANSPORTSELECTOR_HXX)
#define RESIP_TRANSPORTSELECTOR_HXX
 
#ifndef WIN32
#include <sys/select.h>
#endif
 
#include <map>
#include <vector>
#include <list>
 
#include "rutil/Data.hxx"
#include "rutil/Fifo.hxx"
#include "rutil/GenericIPAddress.hxx"
#include "resip/stack/Transport.hxx"
#include "resip/stack/DnsInterface.hxx"
#include "rutil/SelectInterruptor.hxx"
 
 
#include "resip/stack/SecurityTypes.hxx"
class TestTransportSelector;
 
namespace osc
{
  class Stack;
}
 
namespace resip
{
 
class DnsHandler;
class Message;
class TransactionMessage;
class SipMessage;
class TransactionController;
class Security;
class Compression;
class FdPollGrp;
 
class TransportSelector
{
   public:
      TransportSelector(Fifo<TransactionMessage>& fifo, Security* security, DnsStub& dnsStub, Compression &compression, bool useDnsVip);
      virtual ~TransportSelector();
 
      bool hasDataToSend() const;
 
      void shutdown();
 
      bool isFinished() const;
 
      void setPollGrp(FdPollGrp *pollGrp);
 
      // thread than the TransactionController; this will allow the thread to be 
      // interrupted when poke() is called.
      void createSelectInterruptor();
 
      void process(FdSet& fdset);
      void process();
      void buildFdSet(FdSet& fdset);
 
      void poke();
 
      void addTransport(std::unique_ptr<Transport> transport, bool isStackRunning);
      void removeTransport(unsigned int transportKey);
 
      DnsResult* createDnsResult(DnsHandler* handler);
      void dnsResolve(DnsResult* result, SipMessage* msg);
 
      typedef enum
      {
         Unsent,
         Sent
      } TransmitState;
      TransmitState transmit( SipMessage* msg, Tuple& target, SendData* sendData=0 );
 
      void retransmit(const SendData& msg);
 
      void closeConnection(const Tuple& peer);
 
      unsigned int sumTransportFifoSizes() const;
 
      unsigned int getTimeTillNextProcessMS();
      Fifo<TransactionMessage>& stateMacFifo() { return mStateMacFifo; }
 
      void registerMarkListener(MarkListener* listener);
      void unregisterMarkListener(MarkListener* listener);
      void setEnumSuffixes(const std::vector<Data>& suffixes);
 
      static Tuple getFirstInterface(bool is_v4, TransportType type);
      void terminateFlow(const resip::Tuple& flow);
      void enableFlowTimer(const resip::Tuple& flow);
 
      bool setUdpOnlyOnNumeric(bool value)
      {
         return mDns.setUdpOnlyOnNumeric(value);
      }
 
      bool getUdpOnlyOnNumeric() const
      {
         return mDns.getUdpOnlyOnNumeric();
      }
 
      void setCongestionManager(CongestionManager* manager)
      {
         for(TransportKeyMap::iterator i=mTransports.begin();
               i!=mTransports.end();++i)
         {
            i->second->setCongestionManager(manager);
         }
      }
 
      void invokeAfterSocketCreationFunc(TransportType type);
 
      class TlsTransportKey
      {
         public:
            TlsTransportKey() = delete;
            TlsTransportKey(const resip::Data& domainName, const resip::Tuple& tuple);
            TlsTransportKey(const TlsTransportKey&) = default;
            TlsTransportKey& operator=(const TlsTransportKey&) = default;
            TlsTransportKey(TlsTransportKey&&) = default;
            TlsTransportKey& operator=(TlsTransportKey&&) = default;
            ~TlsTransportKey() = default;
 
            // Comparison operator which follow strict rules.
            bool operator<(const TlsTransportKey& rhs) const;
 
            resip::Tuple mTuple;
      };
 
   protected:  // for unit tests (testTransportSelector)
      Transport* findTransportBySource(Tuple& src, const SipMessage* msg) const;
      Transport* findTransportByDest(const Tuple& dest);
 
   private:
      void checkTransportAddRemoveQueue();
      Connection* findConnection(const Tuple& dest) const;
      Transport* findLoopbackTransportBySource(bool ignorePort, Tuple& src) const;
      Transport* findTransportByVia(SipMessage* msg, const Tuple& dest, Tuple& src) const;
      Transport* findTlsTransport(const Data& domain, const Tuple& search) const;
      Tuple determineSourceInterface(SipMessage* msg, const Tuple& dest) const;
      void rebuildAnyPortTransportMaps(void);
 
      DnsInterface mDns;
      Fifo<TransactionMessage>& mStateMacFifo;
      Security* mSecurity;// for computing identity header
 
      // specific port and interface
      typedef std::map<Tuple, Transport*> ExactTupleMap;
      ExactTupleMap mExactTransports;
 
      // specific port, ANY interface
      typedef std::map<Tuple, Transport*, Tuple::AnyInterfaceCompare> AnyInterfaceTupleMap;
      AnyInterfaceTupleMap mAnyInterfaceTransports;
 
      // ANY port, specific interface
      typedef std::map<Tuple, Transport*, Tuple::AnyPortCompare> AnyPortTupleMap;
      AnyPortTupleMap mAnyPortTransports;
 
      // ANY port, ANY interface
      typedef std::map<Tuple, Transport*, Tuple::AnyPortAnyInterfaceCompare> AnyPortAnyInterfaceTupleMap;
      AnyPortAnyInterfaceTupleMap mAnyPortAnyInterfaceTransports;
 
      typedef std::map<unsigned int, Transport*> TransportKeyMap;
      TransportKeyMap mTransports; // owns all Transports
 
      typedef std::map<TlsTransportKey, Transport*> TlsTransportMap ;
      TlsTransportMap mTlsTransports;
 
      typedef std::list<Transport*> TransportList;
      TransportList mSharedProcessTransports;  // Warning - only access this from the TransportSelector process loop / thread
      TransportList mHasOwnProcessTransports;
 
      typedef std::multimap<Tuple, Transport*, Tuple::AnyPortAnyInterfaceCompare> TypeToTransportMap;
      TypeToTransportMap mTypeToTransportMap;
 
      // fake socket(s) one for each netns, for connect() and route table lookups
      mutable HashMap<Data, Socket> mSockets;
      mutable HashMap<Data, Socket> mSocket6s;
 
      // An AF_UNSPEC addr_in for rapid unconnect
      GenericIPAddress mUnspecified;
      GenericIPAddress mUnspecified6;
 
      Compression &mCompression;
      osc::Stack  *mSigcompStack;
 
      // epoll support, for sharedprocess transports
      FdPollGrp* mPollGrp;
 
      int mAvgBufferSize;
      Fifo<Transport> mTransportsToAddRemove;
      std::unique_ptr<SelectInterruptor> mSelectInterruptor;
      FdPollItemHandle mInterruptorHandle;
 
      friend class TestTransportSelector;
      friend class SipStack; // for debug only
};
 
EncodeStream&
operator<<(EncodeStream& ostrm, const TransportSelector::TlsTransportKey& tlsTransportKey);
 
}
 
#endif
 
/* ====================================================================
 * The Vovida Software License, Version 1.0
 *
 * Copyright (c) 2026 SIP Spectrum, Inc. https://www.sipspectrum.com
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 * ====================================================================
 *
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */
 
// vim: softtabstop=3:shiftwidth=3:expandtab