/usr/include/ns3/cid-factory.h is in libns3-dev 3.13+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007,2008,2009 INRIA, UDcast
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Authors: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
* Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
* <amine.ismail@UDcast.com>
*/
#ifndef CONNECTION_IDENTIFIER_FACTORY_H
#define CONNECTION_IDENTIFIER_FACTORY_H
#include <stdint.h>
#include "cid.h"
namespace ns3 {
/**
* \ingroup wimax
* This class is used exclusively by the BS to allocate CIDs to new connections.
* This class uses the definitions from Table 345 in ieee-802.16-2004 to
* allocate cids in different integer ranges according to their type.
* The relative allocation of the ranges is controlled by the parameter 'm'
* introduced in the above-mentionned table.
*
* Note: The current implementation merely allocates cids sequentially from
* the start of the allowed range. A proper implementation would be able
* to recycle cids from previous dead connections and should instead look
* at a bitmap of free cids. Some other day :)
*/
class CidFactory
{
public:
/**
* Create a cid factory with a default value for m of 0x5500.
*/
CidFactory (void);
/**
* \brief This function returns the next basic CID.
* \returns the next basic CID.
*/
Cid AllocateBasic (void);
/**
* \brief This function returns the next primary basic CID.
* \returns the next primary CID.
*/
Cid AllocatePrimary (void);
/**
* \brief This function returns the next Transport (or Secondary) CID.
* \returns the next Transport (or Secondary) CID.
*/
Cid AllocateTransportOrSecondary (void);
/**
* \brief This function returns the next Multicast CID.
* \returns the next Multicast CID.
*/
Cid AllocateMulticast (void);
Cid Allocate (enum Cid::Type type);
bool IsTransport (Cid cid) const;
bool IsPrimary (Cid cid) const;
bool IsBasic (Cid cid) const;
/**
* Notify the factory that the connection associated to this
* cid has been killed and that this cid can be reused.
*/
void FreeCid (Cid cid);
private:
uint16_t m_m;
uint16_t m_basicIdentifier;
uint16_t m_primaryIdentifier;
uint16_t m_transportOrSecondaryIdentifier;
uint16_t m_multicastPollingIdentifier;
};
} // namespace ns3
#endif /* CONNECTION_IDENTIFIER_FACTORY_H */
|