Zigbee Specification r22.1.0, Section 2.2.3 Class that implements the Zigbee Specification Application Support Sub-layer (APS). More...

#include "zigbee-aps.h"

Inheritance diagram for ns3::zigbee::ZigbeeAps:

Collaboration diagram for ns3::zigbee::ZigbeeAps:

Public Member Functions
	ZigbeeAps ()
	Default constructor.

	~ZigbeeAps () override

void	ApsdeDataRequest (ApsdeDataRequestParams params, Ptr< Packet > asdu)
	Zigbee Specification r22.1.0, Section 2.2.4.1.1 APSDE-DATA.request Request the transmission of data to one or more entities.

void	ApsmeBindRequest (ApsmeBindRequestParams params)
	Zigbee Specification r22.1.0, Section 2.2.4.3.1 APSME-BIND.request Bind a source entry to one or more destination entries in the binding table.

void	ApsmeUnbindRequest (ApsmeBindRequestParams params)
	Zigbee Specification r22.1.0, Section 2.2.4.3.3 APSME-BIND.request Unbind a destination entry from a source entry in the binding table.

Ptr< ZigbeeNwk >	GetNwk () const
	Get the underlying NWK used by the current Zigbee APS.

void	NldeDataConfirm (NldeDataConfirmParams params)
	Zigbee Specification r22.1.0, Section 3.2.1.2 NLDE-DATA.confirm Used to report to the APS the transmission of data from the NWK.

void	NldeDataIndication (NldeDataIndicationParams params, Ptr< Packet > nsdu)
	Zigbee Specification r22.1.0, Section 3.2.1.3 NLDE-DATA.indication Used to report to the APS the reception of data from the NWK.

void	SetApsdeDataConfirmCallback (ApsdeDataConfirmCallback c)
	Set the callback as part of the interconnections between the APS and the next layer or service (typically the application framework).

void	SetApsdeDataIndicationCallback (ApsdeDataIndicationCallback c)
	Set the callback as part of the interconnections between the APS and the next layer or service (typically the application framework).

void	SetApsmeBindConfirmCallback (ApsmeBindConfirmCallback c)
	Set the callback as part of the interconnections between the APS and the next layer or service (typically the application framework).

void	SetApsmeUnbindConfirmCallback (ApsmeUnbindConfirmCallback c)
	Set the callback as part of the interconnections between the APS and the next layer or service (typically the application framework).

void	SetNwk (Ptr< ZigbeeNwk > nwk)
	Set the underlying NWK to use in this Zigbee APS.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const final
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

void	NotifyConstructionCompleted () override
	Notifier called once the ObjectBase is fully constructed.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

Private Member Functions
void	SendDataUcstBcst (ApsdeDataRequestParams params, Ptr< Packet > asdu)
	Send a regular UCST or BCST data transmission to a known 16-bit address destination.

void	SendDataWithBindingTable (ApsdeDataRequestParams params, Ptr< Packet > asdu)
	Send a Groupcast or IEEE address destination from a list of destination in the binding table.

Private Attributes
BindingTable	m_apsBindingTable
	The binding table associated to this APS layer.

SequenceNumber8	m_apsCounter
	The sequence number used in packet Tx with APS headers.

ApsdeDataConfirmCallback	m_apsdeDataConfirmCallback
	This callback is used to to notify the results of a data transmission request to the Application framework (AF) making the request.

ApsdeDataIndicationCallback	m_apsdeDataIndicationCallback
	This callback is used to to notify the reception of data to the Application framework (AF).

ApsmeBindConfirmCallback	m_apsmeBindConfirmCallback
	This callback is used to to notify the result of a binding request in the APS to the Application framework (AF).

ApsmeUnbindConfirmCallback	m_apsmeUnbindConfirmCallback
	This callback is used to to notify the result of a unbinding request in the APS to the Application framework (AF).

Ptr< ZigbeeNwk >	m_nwk
	Pointer to the underlying NWK connected to this Zigbee APS.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Zigbee Specification r22.1.0, Section 2.2.3 Class that implements the Zigbee Specification Application Support Sub-layer (APS).

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Zigbee

Size of this type is 136 bytes (on a 64-bit architecture).

Definition at line 266 of file zigbee-aps.h.

Constructor & Destructor Documentation

◆ ZigbeeAps()

ns3::zigbee::ZigbeeAps::ZigbeeAps ( )

Default constructor.

Definition at line 35 of file zigbee-aps.cc.

References NS_LOG_FUNCTION.

◆ ~ZigbeeAps()

ns3::zigbee::ZigbeeAps::~ZigbeeAps ( )

override

Definition at line 46 of file zigbee-aps.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ApsdeDataRequest()

void ns3::zigbee::ZigbeeAps::ApsdeDataRequest	(	ApsdeDataRequestParams	params,
		Ptr< Packet >	asdu )

Zigbee Specification r22.1.0, Section 2.2.4.1.1 APSDE-DATA.request Request the transmission of data to one or more entities.

Parameters

params	The APSDE data request params
asdu	The packet to transmit

Definition at line 81 of file zigbee-aps.cc.

References ns3::zigbee::DST_ADDR16_DST_ENDPOINT_PRESENT, ns3::zigbee::DST_ADDR64_DST_ENDPOINT_PRESENT, ns3::zigbee::DST_ADDR_AND_DST_ENDPOINT_NOT_PRESENT, ns3::zigbee::GROUP_ADDR_DST_ENDPOINT_NOT_PRESENT, ns3::zigbee::ZigbeeApsTxOptions::IsAckRequired(), ns3::Callback< R, UArgs >::IsNull(), ns3::zigbee::ZigbeeApsTxOptions::IsSecurityEnabled(), m_apsdeDataConfirmCallback, ns3::zigbee::ApsdeDataConfirmParams::m_dstAddr16, ns3::zigbee::ApsdeDataConfirmParams::m_dstAddr64, ns3::zigbee::ApsdeDataConfirmParams::m_dstAddrMode, ns3::zigbee::ApsdeDataConfirmParams::m_dstEndPoint, ns3::zigbee::ApsdeDataConfirmParams::m_srcEndPoint, ns3::zigbee::ApsdeDataConfirmParams::m_status, ns3::zigbee::ApsdeDataConfirmParams::m_txTime, ns3::zigbee::NO_SHORT_ADDRESS, ns3::Simulator::Now(), NS_ABORT_MSG, NS_LOG_FUNCTION, NS_LOG_WARN, ns3::zigbee::SECURITY_FAIL, and SendDataUcstBcst().

Referenced by SendData(), and ZigbeeApsDataTestCase::SendDataUcstDst().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ApsmeBindRequest()

void ns3::zigbee::ZigbeeAps::ApsmeBindRequest ( ApsmeBindRequestParams params )

Zigbee Specification r22.1.0, Section 2.2.4.3.1 APSME-BIND.request Bind a source entry to one or more destination entries in the binding table.

Parameters

params The APSDE bind request params

Definition at line 308 of file zigbee-aps.cc.

Here is the call graph for this function:

◆ ApsmeUnbindRequest()

void ns3::zigbee::ZigbeeAps::ApsmeUnbindRequest ( ApsmeBindRequestParams params )

Zigbee Specification r22.1.0, Section 2.2.4.3.3 APSME-BIND.request Unbind a destination entry from a source entry in the binding table.

Parameters

params The APSDE bind request params

Definition at line 373 of file zigbee-aps.cc.

◆ DoDispose()

void ns3::zigbee::ZigbeeAps::DoDispose ( )

overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 59 of file zigbee-aps.cc.

References ns3::Object::DoDispose(), m_apsdeDataConfirmCallback, m_nwk, and ns3::MakeNullCallback().

Here is the call graph for this function:

◆ DoInitialize()

void ns3::zigbee::ZigbeeAps::DoInitialize ( )

overrideprotectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 52 of file zigbee-aps.cc.

References ns3::Object::DoInitialize(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetNwk()

Ptr< ZigbeeNwk > ns3::zigbee::ZigbeeAps::GetNwk ( ) const

Get the underlying NWK used by the current Zigbee APS.

Returns: The pointer to the underlying NWK object currently connected to the Zigbee APS.

Definition at line 75 of file zigbee-aps.cc.

References m_nwk.

◆ GetTypeId()

TypeId ns3::zigbee::ZigbeeAps::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 26 of file zigbee-aps.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ NldeDataConfirm()

void ns3::zigbee::ZigbeeAps::NldeDataConfirm ( NldeDataConfirmParams params )

Zigbee Specification r22.1.0, Section 3.2.1.2 NLDE-DATA.confirm Used to report to the APS the transmission of data from the NWK.

Parameters

params The NLDE data confirm params

Definition at line 378 of file zigbee-aps.cc.

Referenced by ns3::zigbee::ZigbeeStack::DoInitialize().

Here is the caller graph for this function:

◆ NldeDataIndication()

void ns3::zigbee::ZigbeeAps::NldeDataIndication	(	NldeDataIndicationParams	params,
		Ptr< Packet >	nsdu )

Zigbee Specification r22.1.0, Section 3.2.1.3 NLDE-DATA.indication Used to report to the APS the reception of data from the NWK.

Parameters

params	The NLDE data indication params
nsdu	The packet received

Definition at line 383 of file zigbee-aps.cc.

Referenced by ns3::zigbee::ZigbeeStack::DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NotifyConstructionCompleted()

void ns3::zigbee::ZigbeeAps::NotifyConstructionCompleted ( )

overrideprotectedvirtual

Notifier called once the ObjectBase is fully constructed.

This method is invoked once all member attributes have been initialized. Subclasses can override this method to be notified of this event but if they do this, they must chain up to their parent's NotifyConstructionCompleted method.

Reimplemented from ns3::ObjectBase.

Definition at line 41 of file zigbee-aps.cc.

References NS_LOG_FUNCTION.

◆ SendDataUcstBcst()

void ns3::zigbee::ZigbeeAps::SendDataUcstBcst	(	ApsdeDataRequestParams	params,
		Ptr< Packet >	asdu )

private

Send a regular UCST or BCST data transmission to a known 16-bit address destination.

Parameters

params	The APSDE data request params
asdu	The packet to transmit

Definition at line 232 of file zigbee-aps.cc.

Referenced by ApsdeDataRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendDataWithBindingTable()

void ns3::zigbee::ZigbeeAps::SendDataWithBindingTable	(	ApsdeDataRequestParams	params,
		Ptr< Packet >	asdu )

private

Send a Groupcast or IEEE address destination from a list of destination in the binding table.

Parameters

params	The APSDE data request params
asdu	The packet to transmit

Definition at line 158 of file zigbee-aps.cc.

References ns3::zigbee::APS_DATA, ns3::zigbee::APS_UCST, ns3::zigbee::DST_ADDR64_DST_ENDPOINT_PRESENT, ns3::zigbee::ENABLE_ROUTE_DISCOVERY, ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), ns3::Callback< R, UArgs >::IsNull(), ns3::zigbee::ZigbeeApsTxOptions::IsSecurityEnabled(), ns3::zigbee::BindingTable::LookUpEntries(), m_apsBindingTable, m_apsCounter, m_apsdeDataConfirmCallback, ns3::zigbee::NldeDataRequestParams::m_discoverRoute, ns3::zigbee::NldeDataRequestParams::m_dstAddr, ns3::zigbee::ApsdeDataConfirmParams::m_dstAddr16, ns3::zigbee::ApsdeDataConfirmParams::m_dstAddr64, ns3::zigbee::ApsdeDataConfirmParams::m_dstAddrMode, ns3::zigbee::NldeDataRequestParams::m_dstAddrMode, ns3::zigbee::ApsdeDataConfirmParams::m_dstEndPoint, m_nwk, ns3::zigbee::NldeDataRequestParams::m_radius, ns3::zigbee::NldeDataRequestParams::m_securityEnable, ns3::zigbee::ApsdeDataConfirmParams::m_srcEndPoint, ns3::zigbee::ApsdeDataConfirmParams::m_status, ns3::zigbee::ApsdeDataConfirmParams::m_txTime, ns3::zigbee::ZigbeeNwk::NldeDataRequest(), ns3::zigbee::NO_BOUND_DEVICE, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_WARN, ns3::Simulator::ScheduleNow(), ns3::zigbee::ZigbeeApsHeader::SetApsCounter(), ns3::zigbee::ZigbeeApsHeader::SetClusterId(), ns3::zigbee::ZigbeeApsHeader::SetDeliveryMode(), ns3::zigbee::ZigbeeApsHeader::SetExtHeaderPresent(), ns3::zigbee::ZigbeeApsHeader::SetFrameType(), ns3::zigbee::ZigbeeApsHeader::SetProfileId(), ns3::zigbee::ZigbeeApsHeader::SetSrcEndpoint(), ns3::zigbee::SUCCESS, and ns3::zigbee::UCST_BCST.

Here is the call graph for this function:

◆ SetApsdeDataConfirmCallback()

void ns3::zigbee::ZigbeeAps::SetApsdeDataConfirmCallback ( ApsdeDataConfirmCallback c )

Set the callback as part of the interconnections between the APS and the next layer or service (typically the application framework).

The callback implements the callback used in a APSDE-DATA.confirm

Parameters

c	the ApsdeDataConfirm callback

Definition at line 449 of file zigbee-aps.cc.

References m_apsdeDataConfirmCallback.

◆ SetApsdeDataIndicationCallback()

void ns3::zigbee::ZigbeeAps::SetApsdeDataIndicationCallback ( ApsdeDataIndicationCallback c )

Set the callback as part of the interconnections between the APS and the next layer or service (typically the application framework).

The callback implements the callback used in a APSDE-DATA.indication

Parameters

c	the ApsdeDataIndication callback

Definition at line 455 of file zigbee-aps.cc.

References m_apsdeDataIndicationCallback.

◆ SetApsmeBindConfirmCallback()

void ns3::zigbee::ZigbeeAps::SetApsmeBindConfirmCallback ( ApsmeBindConfirmCallback c )

Set the callback as part of the interconnections between the APS and the next layer or service (typically the application framework).

The callback implements the callback used in a APSME-BIND.confirm

Parameters

c	the ApsmeBindConfirm callback

Definition at line 461 of file zigbee-aps.cc.

References m_apsmeBindConfirmCallback.

◆ SetApsmeUnbindConfirmCallback()

void ns3::zigbee::ZigbeeAps::SetApsmeUnbindConfirmCallback ( ApsmeUnbindConfirmCallback c )

Set the callback as part of the interconnections between the APS and the next layer or service (typically the application framework).

The callback implements the callback used in a APSDE-UNBIND.confirm

Parameters

c	the ApsdeUnbindConfirm callback

Definition at line 467 of file zigbee-aps.cc.

References m_apsmeUnbindConfirmCallback.

◆ SetNwk()

void ns3::zigbee::ZigbeeAps::SetNwk ( Ptr< ZigbeeNwk > nwk )

Set the underlying NWK to use in this Zigbee APS.

Parameters

nwk	The pointer to the underlying Zigbee NWK to set to this Zigbee APS

Definition at line 69 of file zigbee-aps.cc.

References m_nwk.

Member Data Documentation

◆ m_apsBindingTable

BindingTable ns3::zigbee::ZigbeeAps::m_apsBindingTable

private

The binding table associated to this APS layer.

Definition at line 404 of file zigbee-aps.h.

Referenced by ApsmeBindRequest(), and SendDataWithBindingTable().

◆ m_apsCounter

SequenceNumber8 ns3::zigbee::ZigbeeAps::m_apsCounter

private

The sequence number used in packet Tx with APS headers.

Definition at line 403 of file zigbee-aps.h.

Referenced by SendDataUcstBcst(), and SendDataWithBindingTable().

◆ m_apsdeDataConfirmCallback

ApsdeDataConfirmCallback ns3::zigbee::ZigbeeAps::m_apsdeDataConfirmCallback

private

This callback is used to to notify the results of a data transmission request to the Application framework (AF) making the request.

See Zigbee specification r22.1.0, Section 2.2.4.1.2

Definition at line 411 of file zigbee-aps.h.

Referenced by ApsdeDataRequest(), DoDispose(), SendDataUcstBcst(), SendDataWithBindingTable(), and SetApsdeDataConfirmCallback().

◆ m_apsdeDataIndicationCallback

ApsdeDataIndicationCallback ns3::zigbee::ZigbeeAps::m_apsdeDataIndicationCallback

private

This callback is used to to notify the reception of data to the Application framework (AF).

See Zigbee specification r22.1.0, Section 2.2.4.1.3

Definition at line 418 of file zigbee-aps.h.

Referenced by NldeDataIndication(), and SetApsdeDataIndicationCallback().

◆ m_apsmeBindConfirmCallback

ApsmeBindConfirmCallback ns3::zigbee::ZigbeeAps::m_apsmeBindConfirmCallback

private

This callback is used to to notify the result of a binding request in the APS to the Application framework (AF).

See Zigbee specification r22.1.0, Section 2.2.4.3.2

Definition at line 425 of file zigbee-aps.h.

Referenced by ApsmeBindRequest(), and SetApsmeBindConfirmCallback().

◆ m_apsmeUnbindConfirmCallback

ApsmeUnbindConfirmCallback ns3::zigbee::ZigbeeAps::m_apsmeUnbindConfirmCallback

private

This callback is used to to notify the result of a unbinding request in the APS to the Application framework (AF).

See Zigbee specification r22.1.0, Section 2.2.4.3.4

Definition at line 432 of file zigbee-aps.h.

Referenced by SetApsmeUnbindConfirmCallback().

◆ m_nwk

Ptr<ZigbeeNwk> ns3::zigbee::ZigbeeAps::m_nwk

private

Pointer to the underlying NWK connected to this Zigbee APS.

Definition at line 402 of file zigbee-aps.h.

Referenced by DoDispose(), GetNwk(), NldeDataIndication(), SendDataUcstBcst(), SendDataWithBindingTable(), and SetNwk().

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

src/zigbee/model/zigbee-aps.h
src/zigbee/model/zigbee-aps.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ZigbeeAps()

◆ ~ZigbeeAps()

Member Function Documentation

◆ ApsdeDataRequest()

◆ ApsmeBindRequest()

◆ ApsmeUnbindRequest()

◆ DoDispose()

◆ DoInitialize()

◆ GetNwk()

◆ GetTypeId()

◆ NldeDataConfirm()

◆ NldeDataIndication()

◆ NotifyConstructionCompleted()

◆ SendDataUcstBcst()

◆ SendDataWithBindingTable()

◆ SetApsdeDataConfirmCallback()

◆ SetApsdeDataIndicationCallback()

◆ SetApsmeBindConfirmCallback()

◆ SetApsmeUnbindConfirmCallback()

◆ SetNwk()

Member Data Documentation

◆ m_apsBindingTable

◆ m_apsCounter

◆ m_apsdeDataConfirmCallback

◆ m_apsdeDataIndicationCallback

◆ m_apsmeBindConfirmCallback

◆ m_apsmeUnbindConfirmCallback

◆ m_nwk