git.cworth.org Git - vogl/blob - src/common/portmgr.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2013-2014 RAD Game Tools and Valve Software
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26 #pragma once
  27
  28 //
  29 //  Class used to manage ports used.  Allows you to keep track of ports used.
  30 //
  31
  32 namespace ports
  33 {
  34
  35     class PortManager
  36     {
  37
  38     public:
  39         PortManager(int portStart, int portIncrement, int portEnd);
  40         ~PortManager();
  41
  42         //
  43         //  returns true if this works...false if it fails (see syslog for details)
  44         bool FInitialize();
  45         bool FInitialize(int portReserved); // Initially reserve this particular port
  46
  47         //
  48         //  Either returns the port to use or -1 if no ports are available.
  49         int GetNextAvailablePort();
  50
  51         //
  52         //  Makes available the port for future use, or -1 if the port passed in is out
  53         //  of range.
  54         int ReleasePort(int port);
  55
  56     private:
  57         bool *m_rgPortUsage;
  58         int m_portStart;
  59         int m_portIncrement;
  60         int m_portEnd;
  61
  62         int m_numPorts;
  63
  64         bool m_fInitialized;
  65         pthread_mutex_t m_portList_mutex;
  66     };
  67 } // namespace ports