A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
generic-phy.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2010 CTTC
3
*
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License version 2 as
6
* published by the Free Software Foundation;
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU General Public License for more details.
12
*
13
* You should have received a copy of the GNU General Public License
14
* along with this program; if not, write to the Free Software
15
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
*
17
* Author: Nicola Baldo <nbaldo@cttc.es>
18
*/
19
20
#ifndef GENERIC_PHY_H
21
#define GENERIC_PHY_H
22
23
#include <ns3/callback.h>
24
25
namespace
ns3
26
{
27
28
class
Packet;
29
30
/**
31
* This method allows the MAC to instruct the PHY to start a
32
* transmission of a given packet
33
*
34
* @param packet the Packet to be transmitted
35
* @return this method returns false if the PHY will start TX,
36
* true if the PHY refuses to start the TX. If false, the MAC layer
37
* will expect that GenericPhyTxEndCallback is invoked at some point later.
38
*/
39
typedef
Callback<bool, Ptr<Packet>
>
GenericPhyTxStartCallback
;
40
41
/**
42
* this method is invoked by the PHY to notify the MAC that the
43
* transmission of a given packet has been completed.
44
*
45
* @param packet the Packet whose TX has been completed.
46
*/
47
typedef
Callback<void, Ptr<const Packet>
>
GenericPhyTxEndCallback
;
48
49
/**
50
* This method is used by the PHY to notify the MAC that a RX
51
* attempt is being started, i.e., a valid signal has been
52
* recognized by the PHY.
53
*
54
*/
55
typedef
Callback<void>
GenericPhyRxStartCallback
;
56
57
/**
58
* This method is used by the PHY to notify the MAC that a
59
* previously started RX attempt has terminated without success.
60
*/
61
typedef
Callback<void>
GenericPhyRxEndErrorCallback
;
62
63
/**
64
* This method is used by the PHY to notify the MAC that a
65
* previously started RX attempt has been successfully completed.
66
*
67
* @param packet the received Packet
68
*/
69
typedef
Callback<void, Ptr<Packet>
>
GenericPhyRxEndOkCallback
;
70
71
}
// namespace ns3
72
73
#endif
/* GENERIC_PHY_H */
ns3::Callback
Callback template class.
Definition:
callback.h:438
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::GenericPhyTxEndCallback
Callback< void, Ptr< const Packet > > GenericPhyTxEndCallback
this method is invoked by the PHY to notify the MAC that the transmission of a given packet has been ...
Definition:
generic-phy.h:47
ns3::GenericPhyRxEndErrorCallback
Callback< void > GenericPhyRxEndErrorCallback
This method is used by the PHY to notify the MAC that a previously started RX attempt has terminated ...
Definition:
generic-phy.h:61
ns3::GenericPhyTxStartCallback
Callback< bool, Ptr< Packet > > GenericPhyTxStartCallback
This method allows the MAC to instruct the PHY to start a transmission of a given packet.
Definition:
generic-phy.h:39
ns3::GenericPhyRxStartCallback
Callback< void > GenericPhyRxStartCallback
This method is used by the PHY to notify the MAC that a RX attempt is being started,...
Definition:
generic-phy.h:55
ns3::GenericPhyRxEndOkCallback
Callback< void, Ptr< Packet > > GenericPhyRxEndOkCallback
This method is used by the PHY to notify the MAC that a previously started RX attempt has been succes...
Definition:
generic-phy.h:69
src
network
utils
generic-phy.h
Generated on Tue May 28 2024 23:38:43 for ns-3 by
1.9.6