NetNs.hxx

Go to the documentation of this file.

#if !defined(RESIP_NETNS_HXX) && defined(USE_NETNS)
#define RESIP_NETNS_HXX 
 
#include <vector>
#include "rutil/HashMap.hxx"
#include "rutil/BaseException.hxx"
 
namespace resip
{
 
class NetNs 
{
   public:
 
      class Exception final : public BaseException
      {
      public:
         Exception(const Data& message, const Data& fileName, int lineNumber) :
             BaseException(message, fileName, lineNumber){}
 
         const char* name() const noexcept override { return("NetNs::Exception"); }
      };
 
      virtual ~NetNs();
 
      // @ brief sets the kernel netns for the current thread
      static int setNs(const Data& netNs);
      // @brief gets public netns namespace names
      static int getPublicNetNs(std::vector<Data>& netNsNames);
      // @brief Get the netns id for the given name in the netns dictonary.
      static int getNetNsId(const Data& netNsName, bool shouldAdd = false);
      // @brief construct netns device name to open for name
      static void makeNetNsDeviceName(const Data& netNs, Data& deviceName);
      // @brief Opens the file for the named netns
      static int openNetNs(const Data& netNs);
      // @brief Checks if the named netns exists
      static bool netNsExists(const Data& netNs);
      // @brief Find the netns name for the given netns dictionary id
      static const Data& getNetNsName(int netNsId);
   private:
      // Currently this is just a container for static methods.  So
      // no reason to actually construct one of these.
      NetNs();
      
      NetNs(const NetNs& );
      NetNs& operator=(const NetNs&);
 
      static void initDictionary();
 
      static HashMap<int, Data> sIdDictionaryToNetNs; 
      static HashMap<Data, int> sNetNsDictionaryToId; 
};
 
}
 
#endif
 
/* ====================================================================
 *
 * Copyright (c) Daniel Petrie, SIPez LLC.  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. Neither the name of the author(s) nor the names of any contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, 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.
 *
 * vi: set shiftwidth=3 expandtab:
 */