Transport.hxx

Go to the documentation of this file.

#if !defined(RESIP_TRANSPORT_HXX)
#define RESIP_TRANSPORT_HXX
 
#include "rutil/BaseException.hxx"
#include "rutil/Data.hxx"
#include "rutil/FdSetIOObserver.hxx"
#include "rutil/ProducerFifoBuffer.hxx"
#include "resip/stack/TransportFailure.hxx"
#include "resip/stack/TcpConnectState.hxx"
#include "resip/stack/Tuple.hxx"
#include "resip/stack/NameAddr.hxx"
#include "resip/stack/Compression.hxx"
#include "resip/stack/SendData.hxx"
 
#include <list>
#include <memory>
#include <utility>
 
#include <atomic>
 
namespace resip
{
 
class TransactionMessage;
class SipMessage;
class Connection;
class Compression;
class FdPollGrp;
 
#define RESIP_TRANSPORT_FLAG_NOBIND                (1<<0)
#define RESIP_TRANSPORT_FLAG_RXALL                 (1<<1)
#define RESIP_TRANSPORT_FLAG_TXALL                 (1<<2)
#define RESIP_TRANSPORT_FLAG_TXNOW                 (1<<4)
#define RESIP_TRANSPORT_FLAG_OWNTHREAD             (1<<5)
#define RESIP_TRANSPORT_FLAG_SYMMETRIC_CONNECTIONS (1<<6)
 
class Transport : public FdSetIOObserver
{
   public:
 
      class SipMessageLoggingHandler
      {
      public:
          SipMessageLoggingHandler() = default;
          SipMessageLoggingHandler(const SipMessageLoggingHandler&) = delete;
          SipMessageLoggingHandler(SipMessageLoggingHandler&&) = delete;
          virtual ~SipMessageLoggingHandler() = default;
 
          SipMessageLoggingHandler& operator=(const SipMessageLoggingHandler&) = delete;
          SipMessageLoggingHandler& operator=(SipMessageLoggingHandler&&) = delete;
 
          virtual void outboundMessage(const Tuple &source, const Tuple &destination, const SipMessage &msg) = 0;
          // Note:  retransmissions store already encoded messages, so callback doesn't send SipMessage it sends
          //        the encoded version of the SipMessage instead.  If you need a SipMessage you will need to
          //        re-parse back into a SipMessage in the callback handler.
          virtual void outboundRetransmit(const Tuple &source, const Tuple &destination, const SendData &data) {}
          virtual void inboundMessage(const Tuple& source, const Tuple& destination, const SipMessage &msg) = 0;
      };
 
      using SipMessageLoggingHandlerList = std::vector<std::shared_ptr<SipMessageLoggingHandler> >;
 
      void setSipMessageLoggingHandler(std::shared_ptr<SipMessageLoggingHandler> handler);
      void addSipMessageLoggingHandler(std::shared_ptr<SipMessageLoggingHandler> handler);
      void setSipMessageLoggingHandlers(const SipMessageLoggingHandlerList& handlers);
      void unsetSipMessageLoggingHandler() noexcept;
      SipMessageLoggingHandlerList getSipMessageLoggingHandlers() const noexcept;
 
      class Exception final : public BaseException
      {
         public:
            Exception(const Data& msg, const Data& file, int line);
            const char* name() const noexcept override { return "TransportException"; }
      };
      
      Transport(Fifo<TransactionMessage>& rxFifo, 
                const GenericIPAddress& address,
                const Data& tlsDomain = Data::Empty, // !dcm! where is this used?
                AfterSocketCreationFuncPtr socketFunc = nullptr,
                Compression &compression = Compression::Disabled
         );
 
      Transport(Fifo<TransactionMessage>& rxFifo, 
                int portNum, 
                IpVersion version, 
                const Data& interfaceObj,
                const Data& tlsDomain = Data::Empty,
                AfterSocketCreationFuncPtr socketFunc = nullptr,
                Compression &compression = Compression::Disabled,
                unsigned transportFlags = 0,
                const Data& netNs = Data::Empty);
 
      virtual ~Transport();
 
      virtual void onReload();
 
      virtual bool isFinished() const=0;
      
      std::unique_ptr<SendData> makeSendData( const Tuple& tuple, const Data& data, const Data& tid, const Data &sigcompId = Data::Empty);
      
      virtual void send(std::unique_ptr<SendData> data)=0;
 
      virtual void poke(){};
 
      virtual void process(FdSet& fdset) = 0;
 
      virtual void buildFdSet( FdSet& fdset) =0;
 
      virtual unsigned int getTimeTillNextProcessMS(){return UINT_MAX;}
 
      virtual void process() = 0;
 
      virtual void setPollGrp(FdPollGrp *grp) = 0;
 
      void flowTerminated(const Tuple& flow, 
                          TransportFailure::FailureReason failureReason, 
                          int failureSubCode, 
                          const Data& failureString, 
                          const std::list<Data> additionalFailureStrings);
      void keepAlivePong(const Tuple& flow);
 
      void fail(const Data& tid,
                TransportFailure::FailureReason reason = TransportFailure::Failure,
                int subCode = 0);
 
      void setTcpConnectState(const Data& tid, TcpConnectState::State state);
 
      static void error(int e);
      static Data errorToString(int e);
 
      // These methods are used by the TransportSelector
      const Data& interfaceName() const { return mInterface; }
 
      int port() const { return mTuple.getPort(); } 
    
      bool isV4() const { return mTuple.isV4(); } // !dcm! -- deprecate ASAP
 
      IpVersion ipVersion() const { return mTuple.ipVersion(); }
    
      const Data& tlsDomain() const { return mTlsDomain; }
      const sockaddr& boundInterface() const { return mTuple.getSockaddr(); }
      const Tuple& getTuple() const { return mTuple; }
    
      const TransportType transport() const { return mTuple.getType(); }
      virtual bool isReliable() const =0;
      virtual bool isDatagram() const =0;
 
      const Data& netNs() const { return(mTuple.getNetNs()); }
 
      virtual bool hasSpecificContact() const { return false; }
 
      bool basicCheck(const SipMessage& msg);
 
      void makeFailedResponse(const SipMessage& msg,
                              int responseCode = 400,
                              const char * warning = nullptr);
      std::unique_ptr<SendData> make503(SipMessage& msg,
                                      uint16_t retryAfter);
 
      std::unique_ptr<SendData> make100(SipMessage& msg);
      void setRemoteSigcompId(SipMessage&msg, Data& id);
      // mark the received= and rport parameters if necessary
      static void stampReceived(SipMessage* request);
 
      virtual bool shareStackProcessAndSelect() const=0;
 
      virtual void startOwnProcessing()=0;
 
      virtual bool hasDataToSend() const = 0;
      
      virtual void shutdown()
      {
         // !jf! should use the fifo to pass this in
         mShuttingDown = true;
      }
      virtual bool isShuttingDown() { return mShuttingDown; }
 
      // also used by the TransportSelector.
      // requires that the two transports be
      bool operator==(const Transport& rhs) const;
 
      //# queued messages on this transport
      virtual unsigned int getFifoSize() const=0;
 
      void callSocketFunc(Socket sock) const;
      virtual void invokeAfterSocketCreationFunc() const = 0;  //used to invoke the after socket creation func immediately for all existing sockets - can be used to modify QOS settings at runtime
 
      bool setDscp(int dscp);
 
      int effectiveDscp() const;
 
      int effectiveDscp(int wanted) const;
 
      void applySocketOptions(Socket sock) const;
 
      void applyDscpToOwnSockets();
 
   protected:
 
      void drainDscpRefresh();
 
   private:
 
      void reportDscp(int wanted) const;
 
   public:
 
      virtual void setCongestionManager(CongestionManager* manager)
      {
         mCongestionManager=manager;
      }
 
      CongestionManager::RejectionBehavior getRejectionBehaviorForIncoming() const
      {
         if(mCongestionManager)
         {
            return mCongestionManager->getRejectionBehavior(&mStateMachineFifo.getFifo());
         }
         return CongestionManager::NORMAL;
      }
 
      void flushStateMacFifo()
      {
          mStateMachineFifo.flush();
      }
 
      uint32_t getExpectedWaitForIncoming() const
      {
         return (uint32_t)mStateMachineFifo.getFifo().expectedWaitTimeMilliSec()/1000;
      }
 
      // called by Connection to deliver a received message
      virtual void pushRxMsgUp(SipMessage* msg);
 
      // set the receive buffer length (SO_RCVBUF)
      virtual void setRcvBufLen(int buflen) { };    // make pure?
 
      inline unsigned int getKey() const {return mTuple.mTransportKey;} 
      inline void setKey(unsigned int pKey) { mTuple.mTransportKey = pKey;} // should only be called once after creation
 
   protected:
 
      virtual Socket getListenerSocket() const { return INVALID_SOCKET; }
 
      Data mInterface;
      Tuple mTuple;
 
      CongestionManager* mCongestionManager;
      ProducerFifoBuffer<TransactionMessage> mStateMachineFifo; // passed in
      bool mShuttingDown;
 
      void setTlsDomain(const Data& domain) { mTlsDomain = domain; }
   private:
      static const Data transportNames[MAX_TRANSPORT];
      friend EncodeStream& operator<<(EncodeStream& strm, const Transport& rhs);
 
      Data mTlsDomain;
      SipMessageLoggingHandlerList mSipMessageLoggingHandlers;
 
   protected:
      AfterSocketCreationFuncPtr mSocketFunc;
      Compression &mCompression;
      unsigned mTransportFlags;
 
      // The signalling DSCP class, and the state its refresh needs.
      std::atomic<int> mDscp { -1 };           
      std::atomic<bool> mDscpRefreshPending { false };
      std::atomic<bool> mDscpReportPending { false };
      mutable std::atomic<bool> mWasMarkRequested { false };
};
 
EncodeStream& operator<<(EncodeStream& strm, const Transport& rhs);
 
}
 
#endif
 
/* ====================================================================
 * The Vovida Software License, Version 1.0
 *
 * 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/>.
 *
 * vi: set shiftwidth=3 expandtab:
 */