A Discrete-Event Network Simulator
API
cid-factory.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2007,2008,2009 INRIA, UDcast
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Authors: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
19 * Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
20 * <amine.ismail@UDcast.com>
21 */
22
23
24#ifndef CONNECTION_IDENTIFIER_FACTORY_H
25#define CONNECTION_IDENTIFIER_FACTORY_H
26
27#include <stdint.h>
28#include "cid.h"
29
30namespace ns3 {
31
46{
47public:
51 CidFactory (void);
56 Cid AllocateBasic (void);
61 Cid AllocatePrimary (void);
78
84 bool IsTransport (Cid cid) const;
90 bool IsPrimary (Cid cid) const;
96 bool IsBasic (Cid cid) const;
97
103 void FreeCid (Cid cid);
104
105private:
106 uint16_t m_m;
107
112};
113
114} // namespace ns3
115
116#endif /* CONNECTION_IDENTIFIER_FACTORY_H */
This class is used exclusively by the BS to allocate CIDs to new connections.
Definition: cid-factory.h:46
uint16_t m_m
m
Definition: cid-factory.h:106
uint16_t m_basicIdentifier
basic identifier
Definition: cid-factory.h:108
bool IsBasic(Cid cid) const
This function determines if the CID is basic.
Definition: cid-factory.cc:111
CidFactory(void)
Create a cid factory with a default value for m of 0x5500.
Definition: cid-factory.cc:30
Cid Allocate(enum Cid::Type type)
This function returns the next CID for the specified type.
Definition: cid-factory.cc:74
uint16_t m_transportOrSecondaryIdentifier
transport or secondary identifier
Definition: cid-factory.h:110
Cid AllocateTransportOrSecondary(void)
This function returns the next Transport (or Secondary) CID.
Definition: cid-factory.cc:57
Cid AllocatePrimary(void)
This function returns the next primary basic CID.
Definition: cid-factory.cc:49
uint16_t m_multicastPollingIdentifier
multicast polling identifier
Definition: cid-factory.h:111
Cid AllocateBasic(void)
This function returns the next basic CID.
Definition: cid-factory.cc:41
Cid AllocateMulticast(void)
This function returns the next Multicast CID.
Definition: cid-factory.cc:65
bool IsPrimary(Cid cid) const
This function determines if the CID is primary.
Definition: cid-factory.cc:105
bool IsTransport(Cid cid) const
This function determines if the CID is a transport.
Definition: cid-factory.cc:99
uint16_t m_primaryIdentifier
primary identifier
Definition: cid-factory.h:109
void FreeCid(Cid cid)
Notify the factory that the connection associated to this cid has been killed and that this cid can b...
Definition: cid-factory.cc:119
Cid class.
Definition: cid.h:38
Type
Type enumeration.
Definition: cid.h:42
Every class exported by the ns3 library is enclosed in the ns3 namespace.