TInet6HeaderICMP_RouterAdv Class Reference

#include <icmp6_hdr.h>

class TInet6HeaderICMP_RouterAdv : public TInet6HeaderICMP

Inherits from

TInet6HeaderICMP_RouterAdv
- TInet6HeaderICMP

Public Member Functions
TInt	CurHopLimit()
TInt	Flags()
TInt	H()
TInt	HeaderLength()
TInt	M()
TInt	MaxHeaderLength()
TInt	MinHeaderLength()
TInt	O()
TInt	Prf()
TUint32	ReachableTime()
TUint32	RetransTimer()
TInt	RouterLifetime()
void	SetCurHopLimit(TInt)
void	SetFlags(TInt)
void	SetReachableTime(TUint32)
void	SetRetransTimer(TUint32)
void	SetRouterLifetime(TInt)

Inherited Attributes
	TInet6HeaderICMP::@51
	TInet6HeaderICMP::i
	TInet6HeaderICMP::iAlign

Inherited Functions
	TInet6HeaderICMP::Checksum()const
	TInet6HeaderICMP::Code()const
	TInet6HeaderICMP::EndPtr()const
	TInet6HeaderICMP::Parameter()const
	TInet6HeaderICMP::SetChecksum(TInt)
	TInet6HeaderICMP::SetCode(TUint8)
	TInet6HeaderICMP::SetParameter(TUint32)
	TInet6HeaderICMP::SetType(TUint8)
	TInet6HeaderICMP::Type()const

Detailed Description

ICMPv6 Router Advertisement layout.

(Neighbour Discovery for IP version 6) (+ Home Agent flag from draft-ietf-mobileip-ipv6-08)

Type=134, Code=0

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|     Type      |     Code      |          Checksum             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Cur Hop Limit |M|O|H|Prf|Rsrvd|       Router Lifetime         |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                         Reachable Time                        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                          Retrans Timer                        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|   Options ...
+-+-+-+-+-+-+-+-+-+-+-+-

Note:

Above is longer thant what is declared in the base class i-member. The user must verify the sufficient length of the packet, when using this.

Valid options:

Member Function Documentation

CurHopLimit ( )

TInt

CurHopLimit

(

)

const [inline]

Gets Cur Hop Limit.

Returns: Hop Limit

Flags ( )

TInt

Flags

(

)

const [inline]

Gets flags byte

Returns: Flags (M, O, H, Prf and Rsrvd)

H ( )

TInt

(

)

const [inline]

Gets Home Agent Configuration (H) flag

HeaderLength ( )

TInt

HeaderLength

(

)

const [inline]

Reimplemented from TInet6HeaderICMP::HeaderLength()const

Gets the header length.

Note:

This length is not the true length of the ICMP header. This only covers the fixed part.

Returns: Header length.

M ( )

TInt

(

)

const [inline]

Gets Managed Address Configuration (M) flag

MaxHeaderLength ( )

TInt

MaxHeaderLength

(

)

[static, inline]

Reimplemented from TInet6HeaderICMP::MaxHeaderLength()

Gets the maximum header length.

Note:

This length is not the true length of the ICMP header. This only covers the fixed part.

Returns: Maximum header length

MinHeaderLength ( )

TInt

MinHeaderLength

(

)

[static, inline]

Reimplemented from TInet6HeaderICMP::MinHeaderLength()

Gets the minimum header length.

Returns: Minimum header length

O ( )

TInt

(

)

const [inline]

Gets Other Address Configuartion (O) flag

Prf ( )

TInt

Prf

(

)

const [inline]

Gets default route preference.

Experimental: draft-draves-ipngwg-router-selection-01.txt Default Router Preferences and More-Specific Routes

ReachableTime ( )

TUint32

ReachableTime

(

)

const [inline]

Gets the value of reachable timer.

RetransTimer ( )

TUint32

RetransTimer

(

)

const [inline]

Gets the value of retransmit timer.

RouterLifetime ( )

TInt

RouterLifetime

(

)

const [inline]

Gets the lifetime of the defaul route.

If non-zero, specifies how long (in seconds) this router is willing to act as a default router.

Note:

This is badly named. The parameter controls only the default route processing. The value ZERO does not mean that the sender is not a router.

Returns: The life time of the default route.

SetCurHopLimit ( TInt )

void

SetCurHopLimit

(

TInt

aLimit

)

[inline]

Sets the Cur Hoplimit.

Parameter	Description
aLimit	The Hoplimit [0..255]

SetFlags ( TInt )

void

SetFlags

(

TInt

aFlags

)

[inline]

Sets the flags.

Parameter	Description
aFlags	The flags bits [0..255].

SetReachableTime ( TUint32 )

void

SetReachableTime

(

TUint32

aTime

)

[inline]

Sets the value of reachable timer

Parameter	Description
aTime	The timer value

SetRetransTimer ( TUint32 )

void

SetRetransTimer

(

TUint32

aTimer

)

[inline]

Sets the value of the retransmit timer

Parameter	Description
aTimer	The timer value

SetRouterLifetime ( TInt )

void

SetRouterLifetime

(

TInt

aTime

)

[inline]

Sets the lifetime of the default route.

Parameter	Description
aTime	The lifetime.