wns::service::phy::copper::DataTransmission Class Reference

Interface for a wireline transmitter.

#include <service/phy/copper/DataTransmission.hpp>

Inheritance diagram for wns::service::phy::copper::DataTransmission:

[legend]

Collaboration diagram for wns::service::phy::copper::DataTransmission:

[legend]

List of all members.

Public Member Functions
virtual void	cancelData (const wns::osi::PDUPtr &data)=0
	Stop an ongoing transmission.
virtual bool	isFree () const =0
	Indicates if the wire is available for transmission.
virtual void	sendData (const wns::service::dll::UnicastAddress &macAddress, const wns::osi::PDUPtr &data)=0
	Unicast transmission of data.
virtual void	sendData (const wns::service::dll::BroadcastAddress &macAddress, const wns::osi::PDUPtr &data)=0
	Broadcast transmission of data.

---

Detailed Description

Definition at line 26 of file DataTransmission.hpp.

---

Member Function Documentation

virtual void wns::service::phy::copper::DataTransmission::cancelData

(

const wns::osi::PDUPtr &

data

)

[pure virtual]

Implemented in copper::Transmitter.

virtual bool wns::service::phy::copper::DataTransmission::isFree

(

)

const [pure virtual]

Returns:

false if transmission is ongoing, true otherwise

Note:

Depending on the implementation this method might behave differently for the same state of the wire. Consider the following: At time "t" a transmission is started by transmitter A. A second transmitter (B) wants to transmit data, too, at the same time. Normally transmitter B would not be able to detect that the wire is already occupied by another transmission. However, in order to have the ability to test simple Data Link Layer implementations (that assume coillision free transmissions) it might be useful to return "true" in this case. Please check the copper implementation you're using for details.

Implemented in copper::Transmitter.

virtual void wns::service::phy::copper::DataTransmission::sendData	(	const wns::service::dll::UnicastAddress &	macAddress,
		const wns::osi::PDUPtr &	data
	)			[pure virtual]

Parameters:

[in]	macAddress	MAC address of the peer entitiy
[in]	data	Protocol Data Unit to be transmitted

Implemented in copper::Transmitter.

virtual void wns::service::phy::copper::DataTransmission::sendData	(	const wns::service::dll::BroadcastAddress &	macAddress,
		const wns::osi::PDUPtr &	data
	)			[pure virtual]

Parameters:

[in]	macAddress	The Broadcast address
[in]	data	Protocol Data Unit to be transmitted

Implemented in copper::Transmitter.

---

The documentation for this class was generated from the following file:

• framework/library/src/service/phy/copper/DataTransmission.hpp