A Discrete-Event Network Simulator
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
14namespace ns3
15{
16
17class 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 */
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 */
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 */
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 */
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 */
59
60} // namespace ns3
61
62#endif /* GENERIC_PHY_H */
Callback template class.
Definition callback.h:422
Every class exported by the ns3 library is enclosed in the ns3 namespace.
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
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
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
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
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