Connection.hxx

Go to the documentation of this file.

#ifndef RESIP_Connection_hxx
#define RESIP_Connection_hxx
 
#include <list>
 
#include "resip/stack/ConnectionBase.hxx"
//#include "rutil/Fifo.hxx"
#include "rutil/Socket.hxx"
#include "rutil/FdPoll.hxx"
#include "rutil/Timer.hxx"
#include "resip/stack/Transport.hxx"
#include "resip/stack/MsgHeaderScanner.hxx"
#include "rutil/IntrusiveListElement.hxx"
#include "rutil/dns/ExternalDns.hxx"
 
namespace resip
{
 
class Message;
class TlsConnection;
class ConnectionManager;
class Connection;
class Compression;
 
typedef IntrusiveListElement<Connection*> ConnectionLruList;
typedef IntrusiveListElement1<Connection*> ConnectionReadList;
typedef IntrusiveListElement2<Connection*> ConnectionWriteList;
typedef IntrusiveListElement3<Connection*> FlowTimerLruList;
 
class Connection : public ConnectionBase, 
                   public ConnectionLruList, 
                   public ConnectionReadList, 
                   public ConnectionWriteList, 
                   public FlowTimerLruList, 
                   public FdPollItemIf
{
      friend class ConnectionManager;
      friend EncodeStream& operator<<(EncodeStream& strm, const resip::Connection& c);
 
   public:
      Connection(Transport* transport,const Tuple& who, Socket socket, Compression &compression, bool isServer);
      virtual ~Connection();
      
      Socket getSocket() const {return mWho.mFlowKey;}
 
      virtual bool hasDataToRead();
      virtual bool isGood();
      virtual bool checkConnectionTimedout();
      virtual bool isWritable();
      virtual bool transportWrite(){return false;}
 
      void requestWrite(SendData* sendData);
 
      int performWrite();
 
      bool performWrites(unsigned int max=0);
 
      void ensureWritable();
 
      int read();
 
      bool performReads(unsigned int max=0);
 
      void enableFlowTimer();
      bool isFlowTimerEnabled() { return mFlowTimerEnabled; }
 
      bool mFirstWriteAfterConnectedPending;
      static volatile bool mEnablePostConnectSocketFuncCall;
      // also covers the DNS resolver's sockets (see ExternalDns)
      static void setEnablePostConnectSocketFuncCall(bool enabled = true)
      {
         mEnablePostConnectSocketFuncCall = enabled;
         ExternalDns::setEnablePostConnectSocketFuncCall(enabled);
      }
      bool isServer()const;
   protected:
      virtual int read(char* /* buffer */, const int /* count */) { return 0; }
      virtual int write(const char* /* buffer */, const int /* count */) { return 0; }
      virtual void onDoubleCRLF();
      virtual void onSingleCRLF();
      virtual void onWsClose(const Data& payload);
      virtual void onWsPing(const Data& payload);
 
      /* callback method of FdPollItemIf */
      virtual void processPollEvent(FdPollEventMask mask);
 
      virtual void invokeAfterSocketCreationFunc() const;
 
   private:
      ConnectionManager& getConnectionManager() const;
      void removeFrontOutstandingSend();
      bool mInWritable;
      bool mFlowTimerEnabled;
      FdPollItemHandle mPollItemHandle;
      
      Connection();
 
      Connection(const Connection&);
      Connection& operator=(const Connection&);
      bool mIsServer;
};
 
EncodeStream& 
operator<<(EncodeStream& strm, const resip::Connection& c);
 
}
 
#endif
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2026 SIP Spectrum, Inc. https://www.sipspectrum.com
 * Copyright (c) 2000
 * 
 * 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/>.
 *
 */