--- a/src/sixlowpan/helper/sixlowpan-helper.h Sat Jul 25 20:17:45 2015 +0200
+++ b/src/sixlowpan/helper/sixlowpan-helper.h Sat Jul 25 23:55:40 2015 +0200
@@ -46,8 +46,8 @@
* Set an attribute on each ns3::SixlowpanNetDevice created by
* SixlowpanHelper::Install.
*
- * \param n1 the name of the attribute to set
- * \param v1 the value of the attribute to set
+ * \param n1 [in] The name of the attribute to set.
+ * \param v1 [in] The value of the attribute to set.
*/
void SetDeviceAttribute (std::string n1,
const AttributeValue &v1);
@@ -74,8 +74,8 @@
* examples directory.
*
*
- * \param c the NetDevice container
- * \return a container with the newly created SixLowPanNetDevices
+ * \param [in] c The NetDevice container.
+ * \return A container with the newly created SixLowPanNetDevices.
*/
NetDeviceContainer Install (NetDeviceContainer c);
@@ -85,15 +85,15 @@
* have been assigned. The Install() method should have previously been
* called by the user.
*
- * \param c NetDeviceContainer of the set of net devices for which the
- * SixLowPanNetDevice should be modified to use a fixed stream
- * \param stream first stream index to use
- * \return the number of stream indices assigned by this helper
+ * \param [in] c NetDeviceContainer of the set of net devices for which the
+ * SixLowPanNetDevice should be modified to use a fixed stream.
+ * \param [in] stream First stream index to use.
+ * \return The number of stream indices assigned by this helper.
*/
int64_t AssignStreams (NetDeviceContainer c, int64_t stream);
private:
- ObjectFactory m_deviceFactory; //!< Object factory
+ ObjectFactory m_deviceFactory; //!< Object factory.
};
} // namespace ns3
--- a/src/sixlowpan/model/sixlowpan-header.h Sat Jul 25 20:17:45 2015 +0200
+++ b/src/sixlowpan/model/sixlowpan-header.h Sat Jul 25 23:55:40 2015 +0200
@@ -48,7 +48,7 @@
{
public:
/**
- * \brief Dispatch values, as defined in RFC4944 and RFC6282
+ * \brief Dispatch values, as defined in \RFC{4944} and \RFC{6282}
\verbatim
Pattern Header Type
+------------+------------------------------------------------+
@@ -112,15 +112,15 @@
/**
* \brief Get the Dispatch type.
- * \param dispatch the dispatch value
- * \return the Dispatch type
+ * \param [in] dispatch The dispatch value.
+ * \return The Dispatch type.
*/
static Dispatch_e GetDispatchType (uint8_t dispatch);
/**
* \brief Get the NhcDispatch type.
- * \param dispatch the dispatch value
- * \return the NhcDispatch type
+ * \param [in] dispatch The dispatch value.
+ * \return The NhcDispatch type.
*/
static NhcDispatch_e GetNhcDispatchType (uint8_t dispatch);
@@ -128,7 +128,7 @@
/**
* \ingroup sixlowpan
- * \brief 6LoWPAN HC1 header - see RFC 4944
+ * \brief 6LoWPAN HC1 header - see \RFC{4944}.
*/
class SixLowPanHc1 : public Header
{
@@ -138,7 +138,7 @@
*
* The address compression is handled in 4 bits and might mean:
* PI: Prefix inline, PC: Prefix Compressed,
- * II: Interface Identifier, Inline, IC: Interface Identifier Compressed
+ * II: Interface Identifier, Inline, IC: Interface Identifier Compressed.
*/
enum LowPanHc1Addr_e
{
@@ -166,13 +166,13 @@
/**
* \brief Get the type ID.
- * \return the object TypeId
+ * \return The object TypeId.
*/
static TypeId GetTypeId (void);
/**
* \brief Return the instance type identifier.
- * \return instance type ID
+ * \return Instance type ID.
*/
virtual TypeId GetInstanceTypeId (void) const;
@@ -181,195 +181,195 @@
/**
* \brief Get the serialized size of the packet.
- * \return size
+ * \return Size.
*/
virtual uint32_t GetSerializedSize (void) const;
/**
* \brief Serialize the packet.
- * \param start Buffer iterator
+ * \param [in] start Buffer iterator.
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
- * \param start Buffer iterator
- * \return size of the packet
+ * \param [in] start Buffer iterator.
+ * \return Size of the packet.
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
* \brief Set the "Hop limit" field (TTL).
- * \param limit the hop limit value
+ * \param [in] Limit The hop limit value.
*/
void SetHopLimit (uint8_t limit);
/**
* \brief Get the "Hop limit" field (TTL).
- * \return the hop limit value
+ * \return The hop limit value.
*/
uint8_t GetHopLimit (void) const;
/**
- * \brief Get Destination Compression type
- * \returns the kind of address compression
+ * \brief Get Destination Compression type.
+ * \returns The kind of address compression.
*/
LowPanHc1Addr_e GetDstCompression () const;
/**
- * \brief Get the destination interface
- * \returns the destination interface
+ * \brief Get the destination interface.
+ * \returns The destination interface.
*/
const uint8_t* GetDstInterface () const;
/**
- * \brief Get the destination prefix
- * \returns the destination prefix
+ * \brief Get the destination prefix.
+ * \returns The destination prefix.
*/
const uint8_t* GetDstPrefix () const;
/**
- * \brief Get the Flow Label value
- * \returns the Flow Label
+ * \brief Get the Flow Label value.
+ * \returns The Flow Label.
*/
uint32_t GetFlowLabel () const;
/**
- * \brief Get the Next Header value
- * \returns the Next Header value
+ * \brief Get the Next Header value.
+ * \returns The Next Header value.
*/
uint8_t GetNextHeader () const;
/**
- * \brief Get Source Compression type
- * \returns the kind of address compression
+ * \brief Get Source Compression type.
+ * \returns The kind of address compression.
*/
LowPanHc1Addr_e GetSrcCompression () const;
/**
- * \brief Get the source interface
- * \returns the source interface
+ * \brief Get the source interface.
+ * \returns The source interface.
*/
const uint8_t* GetSrcInterface () const;
/**
- * \brief Get the source prefix
- * \returns the source prefix
+ * \brief Get the source prefix.
+ * \returns The source prefix.
*/
const uint8_t* GetSrcPrefix () const;
/**
- * \brief Get the Traffic Class value
- * \returns the Traffic Class value
+ * \brief Get the Traffic Class value.
+ * \returns The Traffic Class value.
*/
uint8_t GetTrafficClass () const;
/**
- * \brief Check if the Traffic Class and Flow Labels are compressed
- * \returns true if TC and FL are compressed
+ * \brief Check if the Traffic Class and Flow Labels are compressed.
+ * \returns True if TC and FL are compressed.
*/
bool IsTcflCompression () const;
/**
- * \brief Check if there is a HC2 compressed header
- * \returns true if next header is HC2 copressed
+ * \brief Check if there is a HC2 compressed header.
+ * \returns True if next header is HC2 compressed.
*/
bool IsHc2HeaderPresent () const;
/**
- * \brief Set Destination Compression type
- * \param dstCompression the kind of address compression
+ * \brief Set Destination Compression type.
+ * \param [in] dstCompression The kind of address compression.
*/
void SetDstCompression (LowPanHc1Addr_e dstCompression);
/**
- * \brief Set the destination interface
- * \param dstInterface the destination interface
+ * \brief Set the destination interface.
+ * \param [in] dstInterface The destination interface.
*/
void SetDstInterface (const uint8_t* dstInterface);
/**
- * \brief Set the destination prefix
- * \param dstPrefix the destination prefix
+ * \brief Set the destination prefix.
+ * \param [in] dstPrefix The destination prefix.
*/
void SetDstPrefix (const uint8_t* dstPrefix);
/**
- * \brief Set the Flow Label value
- * \param flowLabel the Flow Label
+ * \brief Set the Flow Label value.
+ * \param [in] flowLabel The Flow Label.
*/
void SetFlowLabel (uint32_t flowLabel);
/**
- * \brief Set the Next Header value
- * \param nextHeader the Next Header value
+ * \brief Set the Next Header value.
+ * \param [in] nextHeader The Next Header value.
*/
void SetNextHeader (uint8_t nextHeader);
/**
- * \brief Set Source Compression type
- * \param srcCompression the kind of address compression
+ * \brief Set Source Compression type.
+ * \param [in] srcCompression The kind of address compression.
*/
void SetSrcCompression (LowPanHc1Addr_e srcCompression);
/**
- * \brief Set the source interface
- * \param srcInterface the source interface
+ * \brief Set the source interface.
+ * \param [in] srcInterface The source interface.
*/
void SetSrcInterface (const uint8_t* srcInterface);
/**
- * \brief Set the source prefix
- * \param srcPrefix the source prefix
+ * \brief Set the source prefix.
+ * \param [in] srcPrefix The source prefix.
*/
void SetSrcPrefix (const uint8_t* srcPrefix);
/**
- * \brief Set the Traffic Class and Flow Labels as compressed
- * \param tcflCompression true if TC and FL are compressed
+ * \brief Set the Traffic Class and Flow Labels as compressed.
+ * \param [in] tcflCompression True if TC and FL are compressed.
*/
void SetTcflCompression (bool tcflCompression);
/**
- * \brief Set the next header a HC2 compressed header
- * \param hc2HeaderPresent true if next header is HC2 compressed
+ * \brief Set the next header a HC2 compressed header.
+ * \param [in] hc2HeaderPresent True if next header is HC2 compressed.
*/
void SetHc2HeaderPresent (bool hc2HeaderPresent);
/**
- * \brief Set the Traffic Class value
- * \param trafficClass the Traffic Class value
+ * \brief Set the Traffic Class value.
+ * \param [in] trafficClass The Traffic Class value.
*/
void SetTrafficClass (uint8_t trafficClass);
private:
- uint8_t m_hopLimit; //!< Hop Limit
- uint8_t m_srcPrefix[8]; //!< Source prefix
- uint8_t m_srcInterface[8]; //!< Source interface
- uint8_t m_dstPrefix[8]; //!< Destination prefix
- uint8_t m_dstInterface[8]; //!< Destination interface
- uint8_t m_trafficClass; //!< Traffic Class
- uint32_t m_flowLabel; //!< Flow Label
- uint8_t m_nextHeader; //!< Next header
- LowPanHc1Addr_e m_srcCompression; //!< Source compression type
- LowPanHc1Addr_e m_dstCompression; //!< Destination compression type
- bool m_tcflCompression; //!< is TC and FL compressed
- LowPanHc1NextHeader_e m_nextHeaderCompression; //!< next header compression
- bool m_hc2HeaderPresent; //!< is next header HC2 compressed
+ uint8_t m_hopLimit; //!< Hop Limit.
+ uint8_t m_srcPrefix[8]; //!< Source prefix.
+ uint8_t m_srcInterface[8]; //!< Source interface.
+ uint8_t m_dstPrefix[8]; //!< Destination prefix.
+ uint8_t m_dstInterface[8]; //!< Destination interface.
+ uint8_t m_trafficClass; //!< Traffic Class.
+ uint32_t m_flowLabel; //!< Flow Label.
+ uint8_t m_nextHeader; //!< Next header.
+ LowPanHc1Addr_e m_srcCompression; //!< Source compression type.
+ LowPanHc1Addr_e m_dstCompression; //!< Destination compression type.
+ bool m_tcflCompression; //!< Is TC and FL compressed.
+ LowPanHc1NextHeader_e m_nextHeaderCompression; //!< Next header compression.
+ bool m_hc2HeaderPresent; //!< Is next header HC2 compressed.
};
/**
* \brief Stream insertion operator.
*
- * \param os the reference to the output stream
- * \param header the HC1 Header
- * \returns the reference to the output stream
+ * \param [in] os The reference to the output stream.
+ * \param [in] header The HC1 Header.
+ * \returns The reference to the output stream.
*/
std::ostream & operator<< (std::ostream & os, SixLowPanHc1 const &header);
/**
* \ingroup sixlowpan
- * \brief 6LoWPAN FRAG1 header - see RFC 4944
+ * \brief 6LoWPAN FRAG1 header - see \RFC{4944}.
*/
class SixLowPanFrag1 : public Header
{
@@ -378,13 +378,13 @@
/**
* \brief Get the type ID.
- * \return the object TypeId
+ * \return The object TypeId.
*/
static TypeId GetTypeId (void);
/**
* \brief Return the instance type identifier.
- * \return instance type ID
+ * \return Instance type ID.
*/
virtual TypeId GetInstanceTypeId (void) const;
@@ -392,65 +392,65 @@
/**
* \brief Get the serialized size of the packet.
- * \return size
+ * \return Size.
*/
virtual uint32_t GetSerializedSize (void) const;
/**
* \brief Serialize the packet.
- * \param start Buffer iterator
+ * \param [in] start Buffer iterator.
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
- * \param start Buffer iterator
- * \return size of the packet
+ * \param [in] start Buffer iterator.
+ * \return Size of the packet.
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
- * \brief Set the datagram size
- * \param datagramSize the datagram size
+ * \brief Set the datagram size.
+ * \param [in] datagramSize The datagram size.
*/
void SetDatagramSize (uint16_t datagramSize);
/**
- * \brief Get the datagram size
- * \returns the datagram size
+ * \brief Get the datagram size.
+ * \returns The datagram size.
*/
uint16_t GetDatagramSize (void) const;
/**
- * \brief Set the datagram tag
- * \param datagramTag the datagram tag
+ * \brief Set the datagram tag.
+ * \param [in] datagramTag The datagram tag.
*/
void SetDatagramTag (uint16_t datagramTag);
/**
- * \brief Get the datagram tag
- * \returns the datagram tag
+ * \brief Get the datagram tag.
+ * \returns The datagram tag.
*/
uint16_t GetDatagramTag (void) const;
private:
- uint16_t m_datagramSize; //!< datagram size
- uint16_t m_datagramTag; //!< datagram tag
+ uint16_t m_datagramSize; //!< Datagram size.
+ uint16_t m_datagramTag; //!< Datagram tag.
};
/**
* \brief Stream insertion operator.
*
- * \param os the reference to the output stream
- * \param header the Frag1 Header
- * \returns the reference to the output stream
+ * \param [in] os The reference to the output stream.
+ * \param [in] header The Frag1 Header.
+ * \returns The reference to the output stream.
*/
std::ostream & operator<< (std::ostream & os, SixLowPanFrag1 const & header);
/**
* \ingroup sixlowpan
- * \brief 6LoWPAN FRAGN header - see RFC 4944
+ * \brief 6LoWPAN FRAGN header - see \RFC{4944}.
*/
class SixLowPanFragN : public Header
{
@@ -459,13 +459,13 @@
/**
* \brief Get the type ID.
- * \return the object TypeId
+ * \return The object TypeId.
*/
static TypeId GetTypeId (void);
/**
* \brief Return the instance type identifier.
- * \return instance type ID
+ * \return Instance type ID.
*/
virtual TypeId GetInstanceTypeId (void) const;
@@ -473,78 +473,78 @@
/**
* \brief Get the serialized size of the packet.
- * \return size
+ * \return Size.
*/
virtual uint32_t GetSerializedSize (void) const;
/**
* \brief Serialize the packet.
- * \param start Buffer iterator
+ * \param [in] start Buffer iterator.
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
- * \param start Buffer iterator
- * \return size of the packet
+ * \param [in] start Buffer iterator.
+ * \return Size of the packet.
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
- * \brief Set the datagram size
- * \param datagramSize the datagram size
+ * \brief Set the datagram size.
+ * \param [in] datagramSize The datagram size.
*/
void SetDatagramSize (uint16_t datagramSize);
/**
- * \brief Get the datagram size
- * \returns the datagram size
+ * \brief Get the datagram size.
+ * \returns The datagram size.
*/
uint16_t GetDatagramSize (void) const;
/**
- * \brief Set the datagram tag
- * \param datagramTag the datagram tag
+ * \brief Set the datagram tag.
+ * \param [in] datagramTag The datagram tag.
*/
void SetDatagramTag (uint16_t datagramTag);
/**
- * \brief Get the datagram tag
- * \returns the datagram tag
+ * \brief Get the datagram tag.
+ * \returns The datagram tag.
*/
uint16_t GetDatagramTag (void) const;
/**
- * \brief Set the datagram offset
- * \param datagramOffset the datagram offset
+ * \brief Set the datagram offset.
+ * \param [in] datagramOffset The datagram offset.
*/
void SetDatagramOffset (uint8_t datagramOffset);
/**
- * \brief Get the datagram offset
- * \returns the datagram offset
+ * \brief Get the datagram offset.
+ * \returns The datagram offset.
*/
uint8_t GetDatagramOffset (void) const;
private:
- uint16_t m_datagramSize; //!< datagram size
- uint16_t m_datagramTag; //!< datagram tag
- uint8_t m_datagramOffset; //!< datagram offset
+ uint16_t m_datagramSize; //!< Datagram size.
+ uint16_t m_datagramTag; //!< Datagram tag.
+ uint8_t m_datagramOffset; //!< Datagram offset.
};
/**
* \brief Stream insertion operator.
*
- * \param os the reference to the output stream
- * \param header the FragN Header
- * \returns the reference to the output stream
+ * \param [in] os The reference to the output stream.
+ * \param [in] header The FragN Header.
+ * \returns The reference to the output stream.
*/
std::ostream & operator<< (std::ostream & os, SixLowPanFragN const &header);
/**
* \ingroup sixlowpan
- * \brief 6LoWPAN IPv6 uncompressed header - see RFC 4944
+ * \brief 6LoWPAN IPv6 uncompressed header - see \RFC{4944}.
*/
class SixLowPanIpv6 : public Header
{
@@ -553,13 +553,13 @@
/**
* \brief Get the type ID.
- * \return the object TypeId
+ * \return The object TypeId.
*/
static TypeId GetTypeId (void);
/**
* \brief Return the instance type identifier.
- * \return instance type ID
+ * \return Instance type ID.
*/
virtual TypeId GetInstanceTypeId (void) const;
@@ -567,20 +567,20 @@
/**
* \brief Get the serialized size of the packet.
- * \return size
+ * \return Size.
*/
virtual uint32_t GetSerializedSize (void) const;
/**
* \brief Serialize the packet.
- * \param start Buffer iterator
+ * \param [in] start Buffer iterator.
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
- * \param start Buffer iterator
- * \return size of the packet
+ * \param [in] start Buffer iterator.
+ * \return Size of the packet.
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
@@ -589,15 +589,15 @@
/**
* \brief Stream insertion operator.
*
- * \param os the reference to the output stream
- * \param header the Frag1 Header
- * \returns the reference to the output stream
+ * \param [in] os The reference to the output stream.
+ * \param [in] header The Frag1 Header.
+ * \returns The reference to the output stream.
*/
std::ostream & operator<< (std::ostream & os, SixLowPanIpv6 const & header);
/**
* \ingroup sixlowpan
-* \brief LOWPAN_IPHC base Encoding - see RFC 6282
+* \brief LOWPAN_IPHC base Encoding - see \RFC{6282}.
\verbatim
0 1
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
@@ -610,7 +610,7 @@
{
public:
/**
- * \brief TF: Traffic Class, Flow Label
+ * \brief TF: Traffic Class, Flow Label.
*
* 00: ECN + DSCP + 4-bit Pad + Flow Label (4 bytes)
* 01: ECN + 2-bit Pad + Flow Label (3 bytes), DSCP is elided.
@@ -627,7 +627,7 @@
};
/**
- * \brief HLIM: Hop Limit
+ * \brief HLIM: Hop Limit.
*
* 00: The Hop Limit field is carried in-line.
* 01: The Hop Limit field is compressed and the hop limit is 1.
@@ -643,7 +643,7 @@
};
/**
- * \brief Source or Destination Address Mode
+ * \brief Source or Destination Address Mode.
*
* 00: 128 bits.
* 01: 64 bits (or 48 bits if multicast).
@@ -660,20 +660,20 @@
SixLowPanIphc (void);
/**
- * \brief Constructor
- * \param dispatch dispatch value
+ * \brief Constructor.
+ * \param [in] dispatch Dispatch value.
*/
SixLowPanIphc (uint8_t dispatch);
/**
* \brief Get the type ID.
- * \return the object TypeId
+ * \return The object TypeId.
*/
static TypeId GetTypeId (void);
/**
* \brief Return the instance type identifier.
- * \return instance type ID
+ * \return Instance type ID.
*/
virtual TypeId GetInstanceTypeId (void) const;
@@ -681,258 +681,258 @@
/**
* \brief Get the serialized size of the packet.
- * \return size
+ * \return Size.
*/
virtual uint32_t GetSerializedSize (void) const;
/**
* \brief Serialize the packet.
- * \param start Buffer iterator
+ * \param [in] start Buffer iterator.
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
- * \param start Buffer iterator
- * \return size of the packet
+ * \param [in] start Buffer iterator.
+ * \return Size of the packet.
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
* \brief Set the TF (Traffic Class, Flow Label) compression.
- * \param tfField ECN, DSCP, Flow Label compression type
+ * \param [in] tfField ECN, DSCP, Flow Label compression type.
*/
void SetTf (TrafficClassFlowLabel_e tfField);
/**
* \brief Get the TF (Traffic Class, Flow Label) compression.
- * \return the ECN, DSCP, Flow Label compression type
+ * \return The ECN, DSCP, Flow Label compression type.
*/
TrafficClassFlowLabel_e GetTf (void) const;
/**
* \brief Set the NH (Next Header) compression.
- * \param nhField false (Next Header carried in-line), true (compressed NH)
+ * \param [in] nhField False (Next Header carried in-line), true (compressed NH).
*/
void SetNh (bool nhField);
/**
* \brief Get the NH (Next Header) compression.
- * \return false (Next Header carried in-line), true (compressed NH)
+ * \return False (Next Header carried in-line), true (compressed NH).
*/
bool GetNh (void) const;
/**
* \brief Set the HLIM (Hop Limit) compression.
- * \param hlimField Hop Limit compression type
+ * \param [in] hlimField Hop Limit compression type
*/
void SetHlim (Hlim_e hlimField);
/**
* \brief Get the HLIM (Hop Limit) compression.
- * \return Hop Limit compression type
+ * \return Hop Limit compression type.
*/
Hlim_e GetHlim (void) const;
/**
* \brief Set the CID (Context Identifier Extension) compression.
- * \param cidField false (no CID present), true (CID follows)
+ * \param [in] cidField False (no CID present), true (CID follows).
*/
void SetCid (bool cidField);
/**
* \brief Get the CID (Context Identifier Extension) compression.
- * \return false (no CID present), true (CID follows)
+ * \return False (no CID present), true (CID follows).
*/
bool GetCid (void) const;
/**
* \brief Set the SAC (Source Address Compression) compression.
- * \param sacField false (stateless), true (stateful)
+ * \param [in] sacField False (stateless), true (stateful).
*/
void SetSac (bool sacField);
/**
* \brief Get the SAC (Source Address Compression) compression.
- * \return false (stateless), true (stateful)
+ * \return False (stateless), true (stateful).
*/
bool GetSac (void) const;
/**
* \brief Set the SAM (Source Address Mode) compression.
- * \param samField - depends on the SAC
+ * \param [in] samField Depends on the SAC.
*/
void SetSam (HeaderCompression_e samField);
/**
* \brief Get the SAM (Source Address Mode) compression.
- * \return depends on the SAC field
+ * \return Depends on the SAC field.
*/
HeaderCompression_e GetSam (void) const;
/**
* \brief Set the M (Multicast) compression.
- * \param mField true if destination is multicast
+ * \param [in] mField True if destination is multicast.
*/
void SetM (bool mField);
/**
* \brief Get the M (Multicast) compression.
- * \return true if destination is multicast
+ * \return True if destination is multicast.
*/
bool GetM (void) const;
/**
* \brief Set the DAC (Destination Address Compression) compression.
- * \param dacField false (stateless), true (stateful)
+ * \param [in] dacField False (stateless), true (stateful).
*/
void SetDac (bool dacField);
/**
* \brief Get the DAC (Destination Address Compression) compression.
- * \return false (stateless), true (stateful)
+ * \return False (stateless), true (stateful).
*/
bool GetDac (void) const;
/**
* \brief Set the DAM (Destination Address Mode) compression.
- * \param damField - depends on the DAC and M fields
+ * \param [in] damField Depends on the DAC and M fields.
*/
void SetDam (HeaderCompression_e damField);
/**
* \brief Get the DAM (Destination Address Mode) compression.
- * \return depends on the DAC and M fields
+ * \return Depends on the DAC and M fields.
*/
HeaderCompression_e GetDam (void) const;
/**
* \brief Set the SrcContextId.
- * \param srcContextId - valid values are [0:15]
+ * \param [in] srcContextId Valid values are [0:15].
*/
void SetSrcContextId (uint8_t srcContextId);
/**
* \brief Get the SrcContextId.
- * \return the SrcContextId
+ * \return The SrcContextId.
*/
uint8_t GetSrcContextId (void) const;
/**
* \brief Set the DstContextId.
- * \param dstContextId - valid values are [0:15]
+ * \param [in] dstContextId Valid values are [0:15].
*/
void SetDstContextId (uint8_t dstContextId);
/**
* \brief Get the DstContextId.
- * \return the DstContextId
+ * \return The DstContextId.
*/
uint8_t GetDstContextId (void) const;
/**
* \brief Set the ECN (2bits).
- * \param ecn - valid values are [0:3]
+ * \param [in] ecn Valid values are [0:3].
*/
void SetEcn (uint8_t ecn);
/**
* \brief Get the ECN.
- * \return the ECN
+ * \return The ECN.
*/
uint8_t GetEcn (void) const;
/**
* \brief Set the DSCP (6bits).
- * \param dscp - valid values are [0:63]
+ * \param [in] dscp Valid values are [0:63].
*/
void SetDscp (uint8_t dscp);
/**
* \brief Get the DSCP.
- * \return the DSCP
+ * \return The DSCP.
*/
uint8_t GetDscp (void) const;
/**
* \brief Set the Flow Label (20bits).
- * \param flowLabel - valid values are 20 bits long.
+ * \param [in] flowLabel Valid values are 20 bits long.
*/
void SetFlowLabel (uint32_t flowLabel);
/**
* \brief Get the Flow Label.
- * \return the Flow Label
+ * \return The Flow Label.
*/
uint32_t GetFlowLabel (void) const;
/**
* \brief Set the Next Header field.
- * \param nextHeader Next Header field.
+ * \param [in] nextHeader Next Header field.
*/
void SetNextHeader (uint8_t nextHeader);
/**
* \brief Get the Next Header field.
- * \return the Next Header field.
+ * \return The Next Header field.
*/
uint8_t GetNextHeader (void) const;
/**
* \brief Set the Hop Limit field.
- * \param hopLimit Hop Limit field.
+ * \param [in] hopLimit Hop Limit field.
*/
void SetHopLimit (uint8_t hopLimit);
/**
* \brief Get the Hop Limit field.
- * \return the Hop Limit field.
+ * \return The Hop Limit field.
*/
uint8_t GetHopLimit (void) const;
/**
* \brief Set the Source Address.
- * \param srcAddress the Source Address.
+ * \param [in] srcAddress The Source Address.
*/
void SetSrcAddress (Ipv6Address srcAddress);
/**
* \brief Get the Source Address.
- * \return the Source Address.
+ * \return The Source Address.
*/
Ipv6Address GetSrcAddress () const;
/**
* \brief Set the Destination Address.
- * \param dstAddress the Destination Address.
+ * \param [in] dstAddress The Destination Address.
*/
void SetDstAddress (Ipv6Address dstAddress);
/**
* \brief Get the Destination Address.
- * \return the Destination Address.
+ * \return The Destination Address.
*/
Ipv6Address GetDstAddress () const;
private:
- uint16_t m_baseFormat; //!< Dispatch + encoding fields
- uint8_t m_srcdstContextId; //!< Src and Dst Context ID
- uint8_t m_ecn : 2; //!< ECN bits
- uint8_t m_dscp : 6; //!< DSCP bits
- uint32_t m_flowLabel : 20; //!< Flow Label bits
- uint8_t m_nextHeader; //!< Next header
- uint8_t m_hopLimit; //!< Hop Limit
- Ipv6Address m_srcAddress; //!< Src address
- Ipv6Address m_dstAddress; //!< Dst address
+ uint16_t m_baseFormat; //!< Dispatch + encoding fields.
+ uint8_t m_srcdstContextId; //!< Src and Dst Context ID.
+ uint8_t m_ecn : 2; //!< ECN bits.
+ uint8_t m_dscp : 6; //!< DSCP bits.
+ uint32_t m_flowLabel : 20; //!< Flow Label bits.
+ uint8_t m_nextHeader; //!< Next header.
+ uint8_t m_hopLimit; //!< Hop Limit.
+ Ipv6Address m_srcAddress; //!< Src address.
+ Ipv6Address m_dstAddress; //!< Dst address.
/**
* \brief Post-process the Source address stateful compression
- * \note currently unsupported
+ * \note Currently unsupported.
*/
void PostProcessSac ();
/**
- * \brief Post-process the Destination address stateful compression
- * \note currently unsupported
+ * \brief Post-process the Destination address stateful compression.
+ * \note Currently unsupported.
*/
void PostProcessDac ();
@@ -941,15 +941,15 @@
/**
* \brief Stream insertion operator.
*
- * \param os the reference to the output stream
- * \param header the IPHC Header
- * \returns the reference to the output stream
+ * \param [in] os The reference to the output stream.
+ * \param [in] header The IPHC Header.
+ * \returns The reference to the output stream.
*/
std::ostream & operator<< (std::ostream & os, SixLowPanIphc const &header);
/**
* \ingroup sixlowpan
-* \brief LOWPAN_NHC Extension Header Encoding - see RFC 6282
+* \brief LOWPAN_NHC Extension Header Encoding - see \RFC{6282}.
\verbatim
0 1 2 3 4 5 6 7
+---+---+---+---+---+---+---+---+
@@ -961,14 +961,14 @@
{
public:
/**
- * \brief EID: IPv6 Extension Header ID
+ * \brief EID: IPv6 Extension Header ID.
*
* EID: IPv6 Extension Header ID:
- * 0: IPv6 Hop-by-Hop Options Header [RFC2460]
- * 1: IPv6 Routing Header [RFC2460]
- * 2: IPv6 Fragment Header [RFC2460]
- * 3: IPv6 Destination Options Header [RFC2460]
- * 4: IPv6 Mobility Header [RFC6275]
+ * 0: IPv6 Hop-by-Hop Options Header [\RFC{2460}]
+ * 1: IPv6 Routing Header [\RFC{2460}]
+ * 2: IPv6 Fragment Header [\RFC{2460}]
+ * 3: IPv6 Destination Options Header [\RFC{2460}]
+ * 4: IPv6 Mobility Header [\RFC{6275}]
* 5: Reserved
* 6: Reserved
* 7: IPv6 Header
@@ -987,13 +987,13 @@
/**
* \brief Get the type ID.
- * \return the object TypeId
+ * \return The object TypeId.
*/
static TypeId GetTypeId (void);
/**
* \brief Return the instance type identifier.
- * \return instance type ID
+ * \return Instance type ID.
*/
virtual TypeId GetInstanceTypeId (void) const;
@@ -1001,100 +1001,100 @@
/**
* \brief Get the serialized size of the packet.
- * \return size
+ * \return Size.
*/
virtual uint32_t GetSerializedSize (void) const;
/**
* \brief Serialize the packet.
- * \param start Buffer iterator
+ * \param [in] start Buffer iterator.
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
- * \param start Buffer iterator
- * \return size of the packet
+ * \param [in] start Buffer iterator.
+ * \return Size of the packet.
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
* \brief Get the NhcDispatch type.
- * \return the NhcDispatch type
+ * \return The NhcDispatch type.
*/
virtual SixLowPanDispatch::NhcDispatch_e GetNhcDispatchType (void) const;
/**
* \brief Set the Extension Header Type.
- * \param extensionHeaderType the Extension Header Type
+ * \param [in] extensionHeaderType The Extension Header Type.
*/
void SetEid (Eid_e extensionHeaderType);
/**
* \brief Get the Extension Header Type.
- * \return the Extension Header Type
+ * \return The Extension Header Type.
*/
Eid_e GetEid (void) const;
/**
* \brief Set the Next Header field values.
- * \param nextHeader the Next Header field value
+ * \param [in] nextHeader The Next Header field value.
*/
void SetNextHeader (uint8_t nextHeader);
/**
* \brief Get the Next Header field value.
- * \return the Next Header field value
+ * \return The Next Header field value.
*/
uint8_t GetNextHeader (void) const;
/**
* \brief Set the NH field values.
- * \param nhField the NH field value
+ * \param [in] nhField The NH field value.
*/
void SetNh (bool nhField);
/**
* \brief Get the Next Header field value.
- * \return the NH field value
+ * \return The NH field value.
*/
bool GetNh (void) const;
/**
* \brief Set the option header data blob.
- * \param blob a buffer holding the blob data
- * \param size the data blob size
+ * \param [in] blob A buffer holding the blob data.
+ * \param [in] size The data blob size.
*/
void SetBlob (const uint8_t* blob, uint32_t size);
/**
* \brief Get the option header data blob.
- * \param blob a buffer to copy the blob data into
- * \param size the size of the buffer
- * \return the length of the copied data
+ * \param [in] blob A buffer to copy the blob data into.
+ * \param [in] size The size of the buffer.
+ * \return The length of the copied data.
*/
uint32_t CopyBlob (uint8_t* blob, uint32_t size) const;
private:
- uint8_t m_nhcExtensionHeader; //!< NHC extension header type
- uint8_t m_nhcNextHeader; //!< Next header
- uint8_t m_nhcBlobLength; //!< Length of the NHC compressed header
- uint8_t m_nhcBlob[256]; //!< NHC compressed header
+ uint8_t m_nhcExtensionHeader; //!< NHC extension header type.
+ uint8_t m_nhcNextHeader; //!< Next header.
+ uint8_t m_nhcBlobLength; //!< Length of the NHC compressed header.
+ uint8_t m_nhcBlob[256]; //!< NHC compressed header.
};
/**
* \brief Stream insertion operator.
*
- * \param os the reference to the output stream
- * \param header the NHC Extension Header
- * \returns the reference to the output stream
+ * \param [in] os The reference to the output stream.
+ * \param [in] header The NHC Extension Header.
+ * \returns The reference to the output stream.
*/
std::ostream & operator<< (std::ostream & os, SixLowPanNhcExtension const &header);
/**
* \ingroup sixlowpan
-* \brief UDP LOWPAN_NHC Extension Header Encoding - see RFC 6282
+* \brief UDP LOWPAN_NHC Extension Header Encoding - see \RFC{6282}.
\verbatim
0 1 2 3 4 5 6 7
+---+---+---+---+---+---+---+---+
@@ -1124,14 +1124,14 @@
SixLowPanUdpNhcExtension (void);
/**
- * \brief Return the instance type identifier.
- * \return instance type ID
+ * \brief Get the type ID.
+ * \return The object TypeId.
*/
static TypeId GetTypeId (void);
/**
* \brief Return the instance type identifier.
- * \return instance type ID
+ * \return Instance type ID.
*/
virtual TypeId GetInstanceTypeId (void) const;
@@ -1139,102 +1139,102 @@
/**
* \brief Get the serialized size of the packet.
- * \return size
+ * \return Size.
*/
virtual uint32_t GetSerializedSize (void) const;
/**
* \brief Serialize the packet.
- * \param start Buffer iterator
+ * \param [in] start Buffer iterator.
*/
virtual void Serialize (Buffer::Iterator start) const;
/**
* \brief Deserialize the packet.
- * \param start Buffer iterator
- * \return size of the packet
+ * \param [in] start Buffer iterator.
+ * \return Size of the packet.
*/
virtual uint32_t Deserialize (Buffer::Iterator start);
/**
* \brief Get the NhcDispatch type.
- * \return the NhcDispatch type
+ * \return The NhcDispatch type.
*/
virtual SixLowPanDispatch::NhcDispatch_e GetNhcDispatchType (void) const;
/**
* \brief Set the compressed Src and Dst Ports.
- * \param port Src and Dst the Ports
+ * \param [in] port Src and Dst Ports.
*/
void SetPorts (Ports_e port);
/**
* \brief Get the compressed Src and Dst Ports.
- * \return the Src and Dst Ports
+ * \return The Src and Dst Ports.
*/
Ports_e GetPorts (void) const;
/**
- * \brief Set the Destination Port.
- * \param port the Destination Port.
+ * \brief Set the Source Port.
+ * \param [in] port The Source Port.
*/
void SetSrcPort (uint16_t port);
/**
- * \brief Get the Destination Port.
- * \return the Destination Port.
+ * \brief Get the Source Port.
+ * \return The Source Port.
*/
uint16_t GetSrcPort () const;
/**
* \brief Set the Destination Port.
- * \param port the Destination Port.
+ * \param [in] port The Destination Port.
*/
void SetDstPort (uint16_t port);
/**
* \brief Get the Destination Port.
- * \return the Destination Port.
+ * \return The Destination Port.
*/
uint16_t GetDstPort () const;
/**
* \brief Set the C (Checksum).
- * \param cField false (All checksum carried in-line), true (Checksum elided)
+ * \param [in] cField False (All checksum carried in-line), true (Checksum elided).
*/
void SetC (bool cField);
/**
* \brief Get the C (Checksum).
- * \return false (All checksum carried in-line), true (Checksum elided)
+ * \return False (All checksum carried in-line), true (Checksum elided).
*/
bool GetC (void) const;
/**
* \brief Set the Checksum field values.
- * \param checksum the Checksum field value
+ * \param [in] checksum The Checksum field value.
*/
void SetChecksum (uint16_t checksum);
/**
* \brief Get the Checksum field value.
- * \return the Checksum field value
+ * \return The Checksum field value.
*/
uint16_t GetChecksum (void) const;
private:
- uint8_t m_baseFormat; //!< Dispatch + encoding fields
- uint16_t m_checksum; //!< Checksum
- uint16_t m_srcPort; //!< Source port
- uint16_t m_dstPort; //!< Destination port
+ uint8_t m_baseFormat; //!< Dispatch + encoding fields.
+ uint16_t m_checksum; //!< Checksum.
+ uint16_t m_srcPort; //!< Source port.
+ uint16_t m_dstPort; //!< Destination port.
};
/**
* \brief Stream insertion operator.
*
- * \param os the reference to the output stream
- * \param header the UDP NHC Extension Header
- * \returns the reference to the output stream
+ * \param [in] os The reference to the output stream.
+ * \param [in] header The UDP NHC Extension Header.
+ * \returns The reference to the output stream.
*/
std::ostream & operator<< (std::ostream & os, SixLowPanUdpNhcExtension const &header);
--- a/src/sixlowpan/model/sixlowpan-net-device.h Sat Jul 25 20:17:45 2015 +0200
+++ b/src/sixlowpan/model/sixlowpan-net-device.h Sat Jul 25 23:55:40 2015 +0200
@@ -39,11 +39,11 @@
/**
* \defgroup sixlowpan 6LoWPAN
- * \brief Performs 6LoWPAN compression of IPv6 packets as specified by RFC 4944 and RFC 6282
+ * \brief Performs 6LoWPAN compression of IPv6 packets as specified by \RFC{4944} and \RFC{6282}
*
* This module acts as a shim between IPv6 and a generic NetDevice.
*
- * The module implements RFCs 4944 and 6282, with the following exceptions:
+ * The module implements \RFC{4944} and \RFC{6282}, with the following exceptions:
* <ul>
* <li> MESH and LOWPAN_BC0 dispatch types are not supported </li>
* <li> HC2 encoding is not supported </li>
@@ -76,7 +76,7 @@
/**
* \brief Get the type ID.
- * \return the object TypeId
+ * \return The object TypeId.
*/
static TypeId GetTypeId (void);
@@ -95,10 +95,10 @@
/**
* \brief Returns the link-layer MTU for this interface.
- * If the link-layer MTU is smaller than IPv6's minimum MTU (RFC 4944),
+ * If the link-layer MTU is smaller than IPv6's minimum MTU (\RFC{4944}),
* 1280 will be returned.
*
- * \return the link-level MTU in bytes for this interface.
+ * \return The link-level MTU in bytes for this interface.
*/
virtual uint16_t GetMtu (void) const;
virtual bool IsLinkUp (void) const;
@@ -122,7 +122,7 @@
/**
* \brief Returns a smart pointer to the underlying NetDevice.
*
- * \return a smart pointer to the underlying NetDevice.
+ * \return A smart pointer to the underlying NetDevice.
*/
Ptr<NetDevice> GetNetDevice () const;
@@ -131,7 +131,7 @@
* All the packets incoming and outgoing from the NetDevice will be
* processed by SixLowPanNetDevice.
*
- * \param device a smart pointer to the NetDevice to be proxied.
+ * \param [in] device A smart pointer to the NetDevice to be proxied.
*/
void SetNetDevice (Ptr<NetDevice> device);
@@ -140,8 +140,8 @@
* used by this model. Return the number of streams (possibly zero) that
* have been assigned.
*
- * \param stream first stream index to use
- * \return the number of stream indices assigned by this model
+ * \param [in] stream First stream index to use.
+ * \return the number of stream indices assigned by this model.
*/
int64_t AssignStreams (int64_t stream);
@@ -149,7 +149,7 @@
* TracedCallback signature for packet send/receive events.
*
* \param [in] packet The packet.
- * \param [in] sixNetDevice The SixLowPanNetDevice
+ * \param [in] sixNetDevice The SixLowPanNetDevice.
* \param [in] ifindex The ifindex of the device.
*/
typedef void (* RxTxTracedCallback)
@@ -162,7 +162,7 @@
*
* \param [in] reason The reason for the drop.
* \param [in] packet The packet.
- * \param [in] sixNetDevice The SixLowPanNetDevice
+ * \param [in] sixNetDevice The SixLowPanNetDevice.
* \param [in] ifindex The ifindex of the device.
*/
typedef void (* DropTracedCallback)
@@ -177,43 +177,43 @@
/**
* \brief Copy constructor
*
- * Defined and unimplemented to avoid misuse
+ * Defined and unimplemented to avoid misuse.
*/
SixLowPanNetDevice (SixLowPanNetDevice const &);
/**
* \brief Copy constructor
*
- * Defined and unimplemented to avoid misuse
+ * Defined and unimplemented to avoid misuse.
* \returns
*/
SixLowPanNetDevice& operator= (SixLowPanNetDevice const &);
/**
- * \brief receives all the packets from a NetDevice for further processing.
- * \param device the NetDevice the packet ws received from
- * \param packet the received packet
- * \param protocol the protocol (if known)
- * \param source the source address
- * \param destination the destination address
- * \param packetType the packet kind (e.g., HOST, BROADCAST, etc.)
- * \return the IPv6 link-local address
+ * \brief Receives all the packets from a NetDevice for further processing.
+ * \param [in] device The NetDevice the packet ws received from.
+ * \param [in] packet The received packet.
+ * \param [in] protocol The protocol (if known).
+ * \param [in] source The source address.
+ * \param [in] destination The destination address.
+ * \param [in] packetType The packet kind (e.g., HOST, BROADCAST, etc.).
+ * \return The IPv6 link-local address.
*/
void ReceiveFromDevice (Ptr<NetDevice> device, Ptr<const Packet> packet, uint16_t protocol,
Address const &source, Address const &destination, PacketType packetType);
/**
- * \param packet packet sent from above down to Network Device
- * \param source source mac address (so called "MAC spoofing")
- * \param dest mac address of the destination (already resolved)
- * \param protocolNumber identifies the type of payload contained in
+ * \param [in] packet Packet sent from above down to Network Device.
+ * \param [in] source Source mac address (only used if doSendFrom is true, i.e., "MAC spoofing").
+ * \param [in] dest Mac address of the destination (already resolved).
+ * \param [in] protocolNumber Identifies the type of payload contained in
* this packet. Used to call the right L3Protocol when the packet
* is received.
- * \param doSendFrom perform a SendFrom instead of a Send
+ * \param [in] doSendFrom Perform a SendFrom instead of a Send.
*
* Called from higher layer to send packet into Network Device
* with the specified source and destination Addresses.
*
- * \return whether the Send operation succeeded
+ * \return Whether the Send operation succeeded.
*/
bool DoSend (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber, bool doSendFrom);
@@ -259,106 +259,106 @@
TracedCallback<DropReason, Ptr<const Packet>, Ptr<SixLowPanNetDevice>, uint32_t> m_dropTrace;
/**
- * \brief make a link-local address from a MAC address.
- * \param addr the MAC address
- * \return the IPv6 link-local address
+ * \brief Make a link-local address from a MAC address.
+ * \param [in] addr The MAC address.
+ * \return The IPv6 link-local address.
*/
Ipv6Address MakeLinkLocalAddressFromMac (Address const &addr);
/**
- * \brief make a global address from a MAC address.
- * \param addr the MAC address
- * \param prefix the address prefix
- * \return the IPv6 address
+ * \brief Make a global address from a MAC address.
+ * \param [in] addr the MAC address.
+ * \param [in] prefix The address prefix.
+ * \return The IPv6 address.
*/
Ipv6Address MakeGlobalAddressFromMac (Address const &addr, Ipv6Address prefix);
/**
* \brief Compress the headers according to HC1 compression.
- * \param packet the packet to be compressed
- * \param src the MAC source address
- * \param dst the MAC destination address
- * \return the size of the removed headers
+ * \param [in] packet The packet to be compressed.
+ * \param [in] src The MAC source address.
+ * \param [in] dst The MAC destination address.
+ * \return The size of the removed headers.
*/
uint32_t CompressLowPanHc1 (Ptr<Packet> packet, Address const &src, Address const &dst);
/**
* \brief Decompress the headers according to HC1 compression.
- * \param packet the packet to be compressed
- * \param src the MAC source address
- * \param dst the MAC destination address
+ * \param [in] packet the packet to be compressed.
+ * \param [in] src the MAC source address.
+ * \param [in] dst the MAC destination address.
*/
void DecompressLowPanHc1 (Ptr<Packet> packet, Address const &src, Address const &dst);
/**
* \brief Compress the headers according to IPHC compression.
- * \param packet the packet to be compressed
- * \param src the MAC source address
- * \param dst the MAC destination address
- * \return the size of the removed headers
+ * \param [in] packet The packet to be compressed.
+ * \param [in] src The MAC source address.
+ * \param [in] dst The MAC destination address.
+ * \return The size of the removed headers.
*/
uint32_t CompressLowPanIphc (Ptr<Packet> packet, Address const &src, Address const &dst);
/**
* \brief Checks if the next header can be compressed using NHC.
- * \param headerType the header kind to be compressed
- * \return true if the header can be compressed
+ * \param [in] headerType The header kind to be compressed.
+ * \return True if the header can be compressed.
*/
bool CanCompressLowPanNhc (uint8_t headerType);
/**
* \brief Decompress the headers according to IPHC compression.
- * \param packet the packet to be compressed
- * \param src the MAC source address
- * \param dst the MAC destination address
+ * \param [in] packet The packet to be compressed.
+ * \param [in] src The MAC source address.
+ * \param [in] dst The MAC destination address.
*/
void DecompressLowPanIphc (Ptr<Packet> packet, Address const &src, Address const &dst);
/**
* \brief Compress the headers according to NHC compression.
- * \param packet the packet to be compressed
- * \param headerType the header type
- * \param src the MAC source address
- * \param dst the MAC destination address
- * \return the size of the removed headers
+ * \param [in] packet The packet to be compressed.
+ * \param [in] headerType The header type.
+ * \param [in] src The MAC source address.
+ * \param [in] dst The MAC destination address.
+ * \return The size of the removed headers.
*/
uint32_t CompressLowPanNhc (Ptr<Packet> packet, uint8_t headerType, Address const &src, Address const &dst);
/**
* \brief Decompress the headers according to NHC compression.
- * \param packet the packet to be compressed
- * \param src the MAC source address
- * \param dst the MAC destination address
- * \param srcAddress the IPv6 source address
- * \param dstAddress the IPv6 destination address
- * \return the decompressed header type
+ * \param [in] packet The packet to be compressed.
+ * \param [in] src The MAC source address.
+ * \param [in] dst The MAC destination address.
+ * \param [in] srcAddress The IPv6 source address.
+ * \param [in] dstAddress The IPv6 destination address.
+ * \return The decompressed header type.
*/
uint8_t DecompressLowPanNhc (Ptr<Packet> packet, Address const &src, Address const &dst, Ipv6Address srcAddress, Ipv6Address dstAddress);
/**
* \brief Compress the headers according to NHC compression.
- * \param packet the packet to be compressed
- * \param omitChecksum omit UDP checksum (if true)
- * \return the size of the removed headers
+ * \param [in] packet The packet to be compressed.
+ * \param [in] omitChecksum Omit UDP checksum (if true).
+ * \return The size of the removed headers.
*/
uint32_t CompressLowPanUdpNhc (Ptr<Packet> packet, bool omitChecksum);
/**
* \brief Decompress the headers according to NHC compression.
- * \param packet the packet to be compressed
- * \param saddr the IPv6 source address
- * \param daddr the IPv6 destination address
+ * \param [in] packet The packet to be compressed.
+ * \param [in] saddr The IPv6 source address.
+ * \param [in] daddr The IPv6 destination address.
*/
void DecompressLowPanUdpNhc (Ptr<Packet> packet, Ipv6Address saddr, Ipv6Address daddr);
/**
- * Fragment identifier type: src/dst address src/dst port
+ * Fragment identifier type: src/dst address src/dst port.
*/
typedef std::pair< std::pair<Address, Address>, std::pair<uint16_t, uint16_t> > FragmentKey;
/**
* \class Fragments
- * \brief A Set of Fragment
+ * \brief A Set of Fragment.
*/
class Fragments : public SimpleRefCount<Fragments>
{
@@ -375,33 +375,33 @@
/**
* \brief Add a fragment to the pool.
- * \param fragment the fragment
- * \param fragmentOffset the offset of the fragment
+ * \param [in] fragment the fragment.
+ * \param [in] fragmentOffset the offset of the fragment.
*/
void AddFragment (Ptr<Packet> fragment, uint16_t fragmentOffset);
/**
* \brief Add the first packet fragment. The first fragment is needed to
* allow the post-defragmentation decompression.
- * \param fragment the fragment
+ * \param [in] fragment The fragment.
*/
void AddFirstFragment (Ptr<Packet> fragment);
/**
* \brief If all fragments have been added.
- * \returns true if the packet is entire
+ * \returns True if the packet is entire.
*/
bool IsEntire () const;
/**
* \brief Get the entire packet.
- * \return the entire packet
+ * \return The entire packet.
*/
Ptr<Packet> GetPacket () const;
/**
* \brief Set the packet-to-be-defragmented size.
- * \param packetSize the packet size (bytes)
+ * \param [in] packetSize The packet size (bytes).
*/
void SetPacketSize (uint32_t packetSize);
@@ -422,64 +422,64 @@
std::list<std::pair<Ptr<Packet>, uint16_t> > m_fragments;
/**
- * \brief The very first fragment
+ * \brief The very first fragment.
*/
Ptr<Packet> m_firstFragment;
};
/**
- * \brief Return the instance type identifier.
- * \param packet the packet to be fragmented (with headers already compressed with 6LoWPAN)
- * \param origPacketSize the size of the IP packet before the 6LoWPAN header compression, including the IP/L4 headers
- * \param origHdrSize the size of the IP header before the 6LoWPAN header compression
- * \param listFragments a reference to the list of the resulting packets, all with the proper headers in place
+ * \brief Performs a packet fragmentation.
+ * \param [in] packet the packet to be fragmented (with headers already compressed with 6LoWPAN).
+ * \param [in] origPacketSize the size of the IP packet before the 6LoWPAN header compression, including the IP/L4 headers.
+ * \param [in] origHdrSize the size of the IP header before the 6LoWPAN header compression.
+ * \param [out] listFragments A reference to the list of the resulting packets, all with the proper headers in place.
*/
void DoFragmentation (Ptr<Packet> packet, uint32_t origPacketSize, uint32_t origHdrSize,
std::list<Ptr<Packet> >& listFragments);
/**
- * \brief Process a packet fragment
- * \param packet the packet
- * \param src the source MAC address
- * \param dst the destination MAC address
- * \param isFirst true if it is the first fragment, false otherwise
- * \return true is the fragment completed the packet
+ * \brief Process a packet fragment.
+ * \param [in] packet The packet.
+ * \param [in] src The source MAC address.
+ * \param [in] dst The destination MAC address.
+ * \param [in] isFirst True if it is the first fragment, false otherwise.
+ * \return True is the fragment completed the packet.
*/
bool ProcessFragment (Ptr<Packet>& packet, Address const &src, Address const &dst, bool isFirst);
/**
- * \brief Process the timeout for packet fragments
- * \param key representing the packet fragments
- * \param iif Input Interface
+ * \brief Process the timeout for packet fragments.
+ * \param [in] key A key representing the packet fragments.
+ * \param [in] iif Input Interface.
*/
void HandleFragmentsTimeout ( FragmentKey key, uint32_t iif);
/**
- * \brief Drops the oldest fragment set
+ * \brief Drops the oldest fragment set.
*/
void DropOldestFragmentSet ();
/**
- * Container for fragment key -> fragments
+ * Container for fragment key -> fragments.
*/
typedef std::map< FragmentKey, Ptr<Fragments> > MapFragments_t;
/**
- * Container Iterator for fragment key -> fragments
+ * Container Iterator for fragment key -> fragments.
*/
typedef std::map< FragmentKey, Ptr<Fragments> >::iterator MapFragmentsI_t;
/**
- * Container for fragment key -> exiration event
+ * Container for fragment key -> expiration event.
*/
typedef std::map< FragmentKey, EventId > MapFragmentsTimers_t;
/**
- * Container Iterator for fragment key -> exiration event
+ * Container Iterator for fragment key -> expiration event.
*/
typedef std::map< FragmentKey, EventId >::iterator MapFragmentsTimersI_t;
- MapFragments_t m_fragments; /**< Fragments hold to be rebuilt */
- MapFragmentsTimers_t m_fragmentsTimers; /**< Timers related to fragment rebuilding */
- Time m_fragmentExpirationTimeout; /**< Time limit for fragment rebuilding */
+ MapFragments_t m_fragments; //!< Fragments hold to be rebuilt.
+ MapFragmentsTimers_t m_fragmentsTimers; //!< Timers related to fragment rebuilding.
+ Time m_fragmentExpirationTimeout; //!< Time limit for fragment rebuilding.
/**
* \brief How many packets can be rebuilt at the same time.
@@ -487,22 +487,22 @@
*/
uint16_t m_fragmentReassemblyListSize;
- bool m_useIphc; /**< Use IPHC or HC1 */
+ bool m_useIphc; //!< Use IPHC or HC1.
- Ptr<Node> m_node; /**< Smart pointer to the Node */
- Ptr<NetDevice> m_netDevice; /**< Smart pointer to the underlying NetDevice */
- uint32_t m_ifIndex; /**< Interface index */
+ Ptr<Node> m_node; //!< Smart pointer to the Node.
+ Ptr<NetDevice> m_netDevice; //!< Smart pointer to the underlying NetDevice.
+ uint32_t m_ifIndex; //!< Interface index.
/**
* \brief Force the EtherType number.
- * Also implying that the underlying NetDevice is using 48-bit Addresses, e.g., Ethernet, WiFi, etc.
+ * Also implying that the underlying NetDevice is using 48-bit Addresses, e.g., Ethernet, Wi-Fi, etc.
*/
bool m_forceEtherType;
- uint16_t m_etherType; /**< EtherType number (used only if m_forceEtherType is true) */
- bool m_omitUdpChecksum; /**< Omit UDP checksum in NC1 encoding */
+ uint16_t m_etherType; //!< EtherType number (used only if m_forceEtherType is true).
+ bool m_omitUdpChecksum; //!< Omit UDP checksum in NC1 encoding.
- uint32_t m_compressionThreshold; /**< Minimum L2 payload size */
+ uint32_t m_compressionThreshold; //!< Minimum L2 payload size.
Ptr<UniformRandomVariable> m_rng; //!< Rng for the fragments tag.
};
--- a/src/wifi/model/yans-wifi-channel.cc Sat Jul 25 20:17:45 2015 +0200
+++ b/src/wifi/model/yans-wifi-channel.cc Sat Jul 25 23:55:40 2015 +0200
@@ -88,6 +88,7 @@
{
if (sender != (*i))
{
+ std::cout << "Checking for snd and dst equality " << sender << " == " << (*i) << std::endl;
//For now don't account for inter channel interference
if ((*i)->GetChannelNumber () != sender->GetChannelNumber ())
{