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
* SPDX-License-Identifier: GPL-2.0-only
5
*
6
* Author: Nicola Baldo <nbaldo@cttc.es>
7
*/
8
9
#ifndef GENERIC_PHY_H
10
#define GENERIC_PHY_H
11
12
#include <ns3/callback.h>
13
14
namespace
ns3
15
{
16
17
class
Packet;
18
19
/**
20
* This method allows the MAC to instruct the PHY to start a
21
* transmission of a given packet
22
*
23
* @param packet the Packet to be transmitted
24
* @return this method returns false if the PHY will start TX,
25
* true if the PHY refuses to start the TX. If false, the MAC layer
26
* will expect that GenericPhyTxEndCallback is invoked at some point later.
27
*/
28
typedef
Callback<bool, Ptr<Packet>
>
GenericPhyTxStartCallback
;
29
30
/**
31
* this method is invoked by the PHY to notify the MAC that the
32
* transmission of a given packet has been completed.
33
*
34
* @param packet the Packet whose TX has been completed.
35
*/
36
typedef
Callback<void, Ptr<const Packet>
>
GenericPhyTxEndCallback
;
37
38
/**
39
* This method is used by the PHY to notify the MAC that a RX
40
* attempt is being started, i.e., a valid signal has been
41
* recognized by the PHY.
42
*
43
*/
44
typedef
Callback<void>
GenericPhyRxStartCallback
;
45
46
/**
47
* This method is used by the PHY to notify the MAC that a
48
* previously started RX attempt has terminated without success.
49
*/
50
typedef
Callback<void>
GenericPhyRxEndErrorCallback
;
51
52
/**
53
* This method is used by the PHY to notify the MAC that a
54
* previously started RX attempt has been successfully completed.
55
*
56
* @param packet the received Packet
57
*/
58
typedef
Callback<void, Ptr<Packet>
>
GenericPhyRxEndOkCallback
;
59
60
}
// namespace ns3
61
62
#endif
/* GENERIC_PHY_H */
ns3::Callback
Callback template class.
Definition
callback.h:422
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:36
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:50
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:28
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:44
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:58
src
network
utils
generic-phy.h
Generated on Fri Nov 8 2024 13:59:05 for ns-3 by
1.11.0