epoc32/include/icmp6_hdr.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// icmp6_hdr.h - ICMPv6 header structure
williamr@2
    15
// This module defines the basic classes for accessing the header
williamr@2
    16
// structures within ICMPv6 packets.
williamr@2
    17
//
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
/**
williamr@2
    22
 @file icmp6_hdr.h
williamr@2
    23
 @ingroup ip_packet_formats
williamr@2
    24
 @publishedAll
williamr@2
    25
 @released
williamr@2
    26
*/
williamr@2
    27
williamr@2
    28
#ifndef __ICMP6_HDR_H__
williamr@2
    29
#define __ICMP6_HDR_H__
williamr@2
    30
williamr@2
    31
#include <e32def.h>
williamr@2
    32
#include "in_hdr.h"
williamr@2
    33
#include <in_sock.h> // IPv6 enhanced in_sock.h
williamr@2
    34
williamr@2
    35
/**
williamr@2
    36
* @addtogroup ip_packet_formats
williamr@2
    37
*/
williamr@2
    38
//@{
williamr@2
    39
williamr@2
    40
// TInet6HeaderICMP
williamr@2
    41
class TInet6HeaderICMP
williamr@2
    42
/**
williamr@2
    43
* ICMPv6 header common part layout.
williamr@2
    44
*
williamr@2
    45
* The basic ICMP header format only covers the common part (4 bytes)
williamr@2
    46
* and 4 bytes of the Message Body (can be accesses as "Parameter")
williamr@2
    47
@verbatim
williamr@2
    48
Extract from RFC-2462: General format of ICMP message
williamr@2
    49
williamr@2
    50
 0                   1                   2                   3
williamr@2
    51
 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
williamr@2
    52
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
    53
|     Type      |     Code      |          Checksum             |
williamr@2
    54
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
    55
|                                                               |
williamr@2
    56
+                         Message Body                          +
williamr@2
    57
|                                                               |
williamr@2
    58
@endverbatim
williamr@2
    59
* @publishedAll
williamr@2
    60
* @released
williamr@2
    61
*/
williamr@2
    62
	{
williamr@2
    63
public:
williamr@2
    64
	inline TInt HeaderLength() const
williamr@2
    65
		/**
williamr@2
    66
		* Gets the header length.	
williamr@2
    67
		* 
williamr@2
    68
		* @note
williamr@2
    69
		*	This length is not the true length of the
williamr@2
    70
		*	ICMP header. This only covers the fixed part.
williamr@2
    71
		* 
williamr@2
    72
		* @return	Header length.
williamr@2
    73
		*/
williamr@2
    74
		{return 4;}
williamr@2
    75
	inline static TInt MinHeaderLength()
williamr@2
    76
		/**
williamr@2
    77
		* Gets the minimum header length.
williamr@2
    78
		* 
williamr@2
    79
		* @return	Minimum header length
williamr@2
    80
		*/
williamr@2
    81
		{return 4; }
williamr@2
    82
	inline static TInt MaxHeaderLength()
williamr@2
    83
		/**
williamr@2
    84
		* Gets the maximum header length.
williamr@2
    85
		* 
williamr@2
    86
		* @note
williamr@2
    87
		*	This length is not the true length of the
williamr@2
    88
		*	ICMP header. This only covers the fixed part.
williamr@2
    89
		* 
williamr@2
    90
		* @return	Maximum header length
williamr@2
    91
		*/
williamr@2
    92
		{return 4; }
williamr@2
    93
	inline TUint8 *EndPtr() const
williamr@2
    94
		/**
williamr@2
    95
		* Gets a pointer to the byte following the header.
williamr@2
    96
		* 
williamr@2
    97
		* @return
williamr@2
    98
		*	Pointer to the byte following the minimum
williamr@2
    99
		*	fixed header
williamr@2
   100
		*/
williamr@2
   101
		{return (TUint8 *)i + HeaderLength();}
williamr@2
   102
	//
williamr@2
   103
	// Access, get ICMP header field values from the packet
williamr@2
   104
	//
williamr@2
   105
	inline TUint8 Type() const
williamr@2
   106
		/**
williamr@2
   107
		* Gets the ICMPv6 type from the header.
williamr@2
   108
		* @return ICMPv6 type [0..255]
williamr@2
   109
		*/
williamr@2
   110
		{
williamr@2
   111
		return i[0];
williamr@2
   112
		}
williamr@2
   113
	inline TUint8 Code() const
williamr@2
   114
		/**
williamr@2
   115
		* Gets the ICMPv6 code from the header.
williamr@2
   116
		* @return ICMPv6 code [0..255]
williamr@2
   117
		*/
williamr@2
   118
		{
williamr@2
   119
		return i[1];
williamr@2
   120
		}
williamr@2
   121
	inline TInt Checksum() const
williamr@2
   122
		/**
williamr@2
   123
		* Gets the Checksum from the header.
williamr@2
   124
		* @return Header Checksum (TUint16 in NETWORK byte order)
williamr@2
   125
		*/
williamr@2
   126
		{
williamr@2
   127
		// Checksum is used in network byte order
williamr@2
   128
		return *((TUint16 *)&i[2]);
williamr@2
   129
		}
williamr@2
   130
	inline TUint32 Parameter() const
williamr@2
   131
		/**
williamr@2
   132
		* Gets the ICMPv6 Parameter.
williamr@2
   133
		*
williamr@2
   134
		* Accesses the first 4 bytes of ICMP message body, and assumes
williamr@2
   135
		* they form a 32 bit integer in network byte order. Returns
williamr@2
   136
		* this integer in host order.
williamr@2
   137
		*
williamr@2
   138
		* @return ICMPv6 Parameter (as an integer)
williamr@2
   139
		*/
williamr@2
   140
		{
williamr@2
   141
		return (i[4] << 24) | (i[5] << 16) | (i[6] << 8) | i[7];
williamr@2
   142
		}
williamr@2
   143
	//
williamr@2
   144
	// Build, set IP header field values into the packet
williamr@2
   145
	//
williamr@2
   146
	inline void SetType(TUint8 aType)
williamr@2
   147
		/**
williamr@2
   148
		* Sets the ICMPv6 type.
williamr@2
   149
		* @param aType ICMPv6 type [0..255]
williamr@2
   150
		*/
williamr@2
   151
		{
williamr@2
   152
		i[0] = aType;
williamr@2
   153
		}
williamr@2
   154
	inline void SetCode(TUint8 aCode)
williamr@2
   155
		/**
williamr@2
   156
		* Sets the ICMPv6 code.
williamr@2
   157
		* @param aCode ICMPv6 code [0..255]
williamr@2
   158
		*/
williamr@2
   159
		{
williamr@2
   160
		i[1] = aCode;
williamr@2
   161
		}
williamr@2
   162
	inline void SetChecksum(TInt aSum)
williamr@2
   163
		/**
williamr@2
   164
		* Sets the Checksum.
williamr@2
   165
		*
williamr@2
   166
		* @param aSum
williamr@2
   167
		*	The Checksum [0..65535] (16 least significant bits
williamr@2
   168
		*	stored as is (assumed to be in NETWORK byte order).					
williamr@2
   169
		*/
williamr@2
   170
		{
williamr@2
   171
		*((TUint16 *)&i[2]) = (TUint16)aSum;
williamr@2
   172
		}
williamr@2
   173
	inline void SetParameter(TUint32 aValue)
williamr@2
   174
		/**
williamr@2
   175
		* Sets the ICMPv6 Parameter.
williamr@2
   176
		*
williamr@2
   177
		* The value is converted into network byte order and
williamr@2
   178
		* stored as the first 4 bytes of the ICMP message body.
williamr@2
   179
		*
williamr@2
   180
		* @param aValue
williamr@2
   181
		*	The parameter.
williamr@2
   182
		*/
williamr@2
   183
		{
williamr@2
   184
		i[7] = (TUint8)aValue;
williamr@2
   185
		i[6] = (TUint8)(aValue >> 8);
williamr@2
   186
		i[5] = (TUint8)(aValue >> 16);
williamr@2
   187
		i[4] = (TUint8)(aValue >> 24);
williamr@2
   188
		}
williamr@2
   189
williamr@2
   190
protected:
williamr@2
   191
	union
williamr@2
   192
		{
williamr@2
   193
		TUint8 i[8];
williamr@2
   194
		TUint32 iAlign;	// A dummy member to force the 4 byte alignment
williamr@2
   195
		};
williamr@2
   196
	};
williamr@2
   197
williamr@2
   198
williamr@2
   199
//
williamr@2
   200
// TInet6HeaderICMP_Echo
williamr@2
   201
//
williamr@2
   202
class TInet6HeaderICMP_Echo : public TInet6HeaderICMP
williamr@2
   203
/**
williamr@2
   204
* ICMPv6 Echo Request and Echo Reply layout.
williamr@2
   205
*
williamr@2
   206
* Describes the ICMP Echo Request and Replay layout. The space for
williamr@2
   207
* Identifier and Sequence is already covered by the base class.
williamr@2
   208
*
williamr@2
   209
@verbatim
williamr@2
   210
RFC-2463:
williamr@2
   211
williamr@2
   212
 0                   1                   2                   3
williamr@2
   213
 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
williamr@2
   214
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   215
|     Type      |     Code      |          Checksum             |
williamr@2
   216
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   217
|           Identifier          |        Sequence Number        |
williamr@2
   218
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   219
|     Data ...
williamr@2
   220
+-+-+-+-+-
williamr@2
   221
@endverbatim
williamr@2
   222
@publishedAll
williamr@2
   223
@released
williamr@2
   224
*/
williamr@2
   225
	{
williamr@2
   226
public:
williamr@2
   227
	//
williamr@2
   228
	// General
williamr@2
   229
	//
williamr@2
   230
	inline TInt HeaderLength() const
williamr@2
   231
		/**
williamr@2
   232
		* Gets the header length.
williamr@2
   233
		* @return The length
williamr@2
   234
		*/
williamr@2
   235
		{return 8;}
williamr@2
   236
	inline static TInt MinHeaderLength()
williamr@2
   237
		/**
williamr@2
   238
		* Gets the minimum header length.	
williamr@2
   239
		* @return The length
williamr@2
   240
		*/
williamr@2
   241
		{return 8; }
williamr@2
   242
	inline static TInt MaxHeaderLength()
williamr@2
   243
		/**
williamr@2
   244
		* Gets the maximum header length.	
williamr@2
   245
		* @return The length
williamr@2
   246
		*/
williamr@2
   247
		{return 8; }
williamr@2
   248
williamr@2
   249
	//
williamr@2
   250
	// Access, get ICMP header field values from the packet
williamr@2
   251
	//
williamr@2
   252
	inline TInt Identifier() const
williamr@2
   253
		/**
williamr@2
   254
		* Gets the Idenfifier
williamr@2
   255
		* @return The Identifier
williamr@2
   256
		*/
williamr@2
   257
		{
williamr@2
   258
		return (i[4] << 8) + i[5];
williamr@2
   259
		}
williamr@2
   260
	inline TInt Sequence() const
williamr@2
   261
		/**
williamr@2
   262
		* Gets the Sequence Number
williamr@2
   263
		* @return The number
williamr@2
   264
		*/
williamr@2
   265
		{
williamr@2
   266
		return (i[6] << 8) + i[7];
williamr@2
   267
		}
williamr@2
   268
	//
williamr@2
   269
	// Build, set IP header field values into the packet
williamr@2
   270
	//
williamr@2
   271
	inline void SetIdentifier(TUint16 aIdentifier)
williamr@2
   272
		/**
williamr@2
   273
		* Sets the Idenfifier
williamr@2
   274
		* @param aIdentifier The Identifier
williamr@2
   275
		*/
williamr@2
   276
		{
williamr@2
   277
		i[4] = (TUint8)(aIdentifier >> 8);
williamr@2
   278
		i[5] = (TUint8)aIdentifier;
williamr@2
   279
		}
williamr@2
   280
	inline void SetSequence(TUint16 aSequence)
williamr@2
   281
		/**
williamr@2
   282
		* Sets the Sequence Number
williamr@2
   283
		* @param aSequence The number
williamr@2
   284
		*/
williamr@2
   285
		{
williamr@2
   286
		i[6] = (TUint8)(aSequence >> 8);
williamr@2
   287
		i[7] = (TUint8)aSequence;
williamr@2
   288
		}
williamr@2
   289
private:
williamr@2
   290
	};
williamr@2
   291
williamr@2
   292
williamr@2
   293
class TInet6HeaderICMP_RouterSol: public TInet6HeaderICMP
williamr@2
   294
/**
williamr@2
   295
* ICMPv6 Router Solicitation layout.
williamr@2
   296
*
williamr@2
   297
@verbatim
williamr@2
   298
Router Solicitation Message Format (from RFC-2461)
williamr@2
   299
williamr@2
   300
 0                   1                   2                   3
williamr@2
   301
 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
williamr@2
   302
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   303
|     Type      |     Code      |          Checksum             |
williamr@2
   304
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   305
|                            Reserved                           |
williamr@2
   306
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   307
|   Options ...
williamr@2
   308
+-+-+-+-+-+-+-+-+-+-+-+-
williamr@2
   309
@endverbatim
williamr@2
   310
* Aside from the fields provided by the base class, there is nothing
williamr@2
   311
* else here.
williamr@2
   312
*
williamr@2
   313
* Valid options:
williamr@2
   314
*
williamr@2
   315
* - #KInet6OptionICMP_SourceLink
williamr@2
   316
*
williamr@2
   317
* @publishedAll
williamr@2
   318
* @released
williamr@2
   319
*/
williamr@2
   320
	{
williamr@2
   321
public:
williamr@2
   322
	inline static TInt MinHeaderLength() {return 8; }
williamr@2
   323
	inline static TInt MaxHeaderLength() {return 8; }
williamr@2
   324
	inline TInt HeaderLength() const {return 8;}
williamr@2
   325
	};
williamr@2
   326
williamr@2
   327
// Router Advertisement Message Format from RFC-2461
williamr@2
   328
class TInet6HeaderICMP_RouterAdv : public TInet6HeaderICMP
williamr@2
   329
/**
williamr@2
   330
* ICMPv6 Router Advertisement layout.
williamr@2
   331
*
williamr@2
   332
* (Neighbour Discovery for IP version 6)
williamr@2
   333
* (+ Home Agent flag from draft-ietf-mobileip-ipv6-08)
williamr@2
   334
@verbatim
williamr@2
   335
Type=134, Code=0
williamr@2
   336
williamr@2
   337
 0                   1                   2                   3
williamr@2
   338
 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
williamr@2
   339
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   340
|     Type      |     Code      |          Checksum             |
williamr@2
   341
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   342
| Cur Hop Limit |M|O|H|Prf|Rsrvd|       Router Lifetime         |
williamr@2
   343
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   344
|                         Reachable Time                        |
williamr@2
   345
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   346
|                          Retrans Timer                        |
williamr@2
   347
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   348
|   Options ...
williamr@2
   349
+-+-+-+-+-+-+-+-+-+-+-+-
williamr@2
   350
@endverbatim
williamr@2
   351
*
williamr@2
   352
* @note
williamr@2
   353
*	Above is longer thant what is declared in the base class
williamr@2
   354
*	i-member. The user must verify the sufficient length of
williamr@2
   355
*	the packet, when using this.
williamr@2
   356
*
williamr@2
   357
* Valid options:
williamr@2
   358
*
williamr@2
   359
* - #KInet6OptionICMP_SourceLink
williamr@2
   360
* - #KInet6OptionICMP_Mtu
williamr@2
   361
* - #KInet6OptionICMP_Prefix
williamr@2
   362
* - #KInet6OptionICMP_RouteInformation (draft)
williamr@2
   363
*
williamr@2
   364
* @publishedAll
williamr@2
   365
* @released
williamr@2
   366
*/
williamr@2
   367
	{
williamr@2
   368
public:
williamr@2
   369
	//
williamr@2
   370
	// General
williamr@2
   371
	//
williamr@2
   372
	inline static TInt MinHeaderLength() {return 16; }
williamr@2
   373
	inline static TInt MaxHeaderLength() {return 16; }
williamr@2
   374
	inline TInt HeaderLength() const {return 16;}
williamr@2
   375
	//
williamr@2
   376
	// Access, get ICMP header field values from the packet
williamr@2
   377
	//
williamr@2
   378
	inline TInt CurHopLimit() const
williamr@2
   379
		/**
williamr@2
   380
		* Gets Cur Hop Limit.
williamr@2
   381
		* @return Hop Limit
williamr@2
   382
		*/
williamr@2
   383
		{
williamr@2
   384
		return i[4];
williamr@2
   385
		}
williamr@2
   386
	inline TInt Flags() const
williamr@2
   387
		/**
williamr@2
   388
		* Gets flags byte
williamr@2
   389
		* @return Flags (M, O, H, Prf and Rsrvd)
williamr@2
   390
		*/
williamr@2
   391
		{
williamr@2
   392
		return i[5];		// M + O + Reserved as one unit
williamr@2
   393
		}
williamr@2
   394
	inline TInt M() const
williamr@2
   395
		/** Gets Managed Address Configuration (M) flag */
williamr@2
   396
		{
williamr@2
   397
		return i[5] & 0x80;
williamr@2
   398
		}
williamr@2
   399
	inline TInt O() const
williamr@2
   400
		/** Gets Other Address Configuartion (O) flag */
williamr@2
   401
		{
williamr@2
   402
		return i[5] & 0x40;
williamr@2
   403
		}
williamr@2
   404
	inline TInt H() const
williamr@2
   405
		/** Gets Home Agent Configuration (H) flag */
williamr@2
   406
		{
williamr@2
   407
		return i[5] & 0x20;
williamr@2
   408
		}
williamr@2
   409
#if 1
williamr@2
   410
	inline TInt Prf() const
williamr@2
   411
		/**
williamr@2
   412
		* Gets default route preference.
williamr@2
   413
		*
williamr@2
   414
		* Experimental: draft-draves-ipngwg-router-selection-01.txt
williamr@2
   415
		* Default Router Preferences and More-Specific Routes
williamr@2
   416
		*/
williamr@2
   417
		{
williamr@2
   418
		return (i[5] >> 3) & 0x3;	// should be treated as 2bit signed int
williamr@2
   419
		}
williamr@2
   420
#endif
williamr@2
   421
	inline TInt RouterLifetime() const
williamr@2
   422
		/**
williamr@2
   423
		* Gets the lifetime of the defaul route.
williamr@2
   424
		*
williamr@2
   425
		* If non-zero, specifies how long (in seconds) this
williamr@2
   426
		* router is willing to act as a default router.
williamr@2
   427
		*
williamr@2
   428
		* @return The life time of the default route.
williamr@2
   429
		*
williamr@2
   430
		* @note
williamr@2
   431
		*	This is badly named. The parameter controls
williamr@2
   432
		*	only the default route processing. The value
williamr@2
   433
		*	ZERO does not mean that the sender is not a
williamr@2
   434
		*	router.
williamr@2
   435
		*/
williamr@2
   436
		{
williamr@2
   437
		return (i[6] << 8) + i[7];
williamr@2
   438
		}
williamr@2
   439
	inline TUint32 ReachableTime() const
williamr@2
   440
		/**
williamr@2
   441
		* Gets the value of reachable timer.
williamr@2
   442
		*/
williamr@2
   443
		{
williamr@2
   444
		return (i[8] << 24) | (i[9] << 16) | (i[10] << 8) | i[11];
williamr@2
   445
		}
williamr@2
   446
	inline TUint32 RetransTimer() const
williamr@2
   447
		/**
williamr@2
   448
		* Gets the value of retransmit timer.
williamr@2
   449
		*/
williamr@2
   450
		{
williamr@2
   451
		return (i[12] << 24) | (i[13] << 16) | (i[14] << 8) | i[15];
williamr@2
   452
		}
williamr@2
   453
	//
williamr@2
   454
	// Build, set IP header field values into the packet
williamr@2
   455
	//
williamr@2
   456
	inline void SetCurHopLimit(TInt aLimit)
williamr@2
   457
		/**
williamr@2
   458
		* Sets the Cur Hoplimit.
williamr@2
   459
		* @param	aLimit	The Hoplimit [0..255]
williamr@2
   460
		*/
williamr@2
   461
		{
williamr@2
   462
		i[4] = (TUint8)aLimit;
williamr@2
   463
		}
williamr@2
   464
	inline void SetFlags(TInt aFlags)
williamr@2
   465
		/**
williamr@2
   466
		* Sets the flags.
williamr@2
   467
		* @param	aFlags	The flags bits [0..255].
williamr@2
   468
		*/
williamr@2
   469
		{
williamr@2
   470
		i[5] = (TUint8)aFlags;
williamr@2
   471
		}
williamr@2
   472
	inline void SetRouterLifetime(TInt aTime)
williamr@2
   473
		/**
williamr@2
   474
		* Sets the lifetime of the default route.
williamr@2
   475
		* @param aTime The lifetime.
williamr@2
   476
		*/
williamr@2
   477
		{
williamr@2
   478
		i[7] = (TUint8)aTime;
williamr@2
   479
		i[6] = (TUint8)(aTime >> 8);
williamr@2
   480
		}
williamr@2
   481
	inline void SetReachableTime(TUint32 aTime)
williamr@2
   482
		/**
williamr@2
   483
		* Sets the value of reachable timer
williamr@2
   484
		* @param aTime The timer value
williamr@2
   485
		*/
williamr@2
   486
		{
williamr@2
   487
		i[11] = (TUint8)aTime;
williamr@2
   488
		i[10] = (TUint8)(aTime >> 8);
williamr@2
   489
		i[9] = (TUint8)(aTime >> 16);
williamr@2
   490
		i[8] = (TUint8)(aTime >> 24);
williamr@2
   491
		}
williamr@2
   492
	inline void SetRetransTimer(TUint32 aTimer)
williamr@2
   493
		/**
williamr@2
   494
		* Sets the value of the retransmit timer
williamr@2
   495
		* @param aTimer The timer value
williamr@2
   496
		*/
williamr@2
   497
		{
williamr@2
   498
		i[15] = (TUint8)aTimer;
williamr@2
   499
		i[14] = (TUint8)(aTimer >> 8);
williamr@2
   500
		i[13] = (TUint8)(aTimer >> 16);
williamr@2
   501
		i[12] = (TUint8)(aTimer >> 24);
williamr@2
   502
		}
williamr@2
   503
williamr@2
   504
private:
williamr@2
   505
	};
williamr@2
   506
williamr@2
   507
class TInet6HeaderICMP_NeighborSol : public TInet6HeaderICMP
williamr@2
   508
/**
williamr@2
   509
* ICMPv6 Neighbour Solicitation layout.
williamr@2
   510
@verbatim
williamr@2
   511
Neigbour Solicitation Message Format from RFC-2461
williamr@2
   512
williamr@2
   513
 0                   1                   2                   3
williamr@2
   514
 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
williamr@2
   515
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   516
|     Type      |     Code      |          Checksum             |
williamr@2
   517
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   518
|                           Reserved                            |
williamr@2
   519
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   520
|                                                               |
williamr@2
   521
+                                                               +
williamr@2
   522
|                                                               |
williamr@2
   523
+                       Target Address                          +
williamr@2
   524
|                                                               |
williamr@2
   525
+                                                               +
williamr@2
   526
|                                                               |
williamr@2
   527
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   528
|   Options ...
williamr@2
   529
+-+-+-+-+-+-+-+-+-+-+-+-
williamr@2
   530
@endverbatim
williamr@2
   531
*
williamr@2
   532
* @note
williamr@2
   533
*	Above is longer thant what is declared in the base class
williamr@2
   534
*	i-member. The user must verify the sufficient length of
williamr@2
   535
*	the packet, when using this.
williamr@2
   536
*
williamr@2
   537
* Valid options:
williamr@2
   538
*
williamr@2
   539
* - #KInet6OptionICMP_SourceLink
williamr@2
   540
*
williamr@2
   541
* @publishedAll
williamr@2
   542
* @released
williamr@2
   543
*/
williamr@2
   544
	{
williamr@2
   545
public:
williamr@2
   546
	//
williamr@2
   547
	// General
williamr@2
   548
	//
williamr@2
   549
	inline static TInt MinHeaderLength() {return 24; }
williamr@2
   550
	inline static TInt MaxHeaderLength() {return 24; }
williamr@2
   551
	inline TInt HeaderLength() const {return 24;}
williamr@2
   552
	inline TIp6Addr &Target() const
williamr@2
   553
		/**
williamr@2
   554
		* Gets the Target Address.
williamr@2
   555
		*
williamr@2
   556
		* @return The target address (reference).
williamr@2
   557
		*/
williamr@2
   558
		{
williamr@2
   559
		return (TIp6Addr &)i[8];
williamr@2
   560
		}
williamr@2
   561
private:
williamr@2
   562
	};
williamr@2
   563
williamr@2
   564
williamr@2
   565
class TInet6HeaderICMP_NeighborAdv : public TInet6HeaderICMP
williamr@2
   566
/**
williamr@2
   567
* ICMPv6 Neighbour Advertisement layout.
williamr@2
   568
@verbatim
williamr@2
   569
Neighbor Advertisement Message Format (from RFC-2461)
williamr@2
   570
williamr@2
   571
 0                   1                   2                   3
williamr@2
   572
 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
williamr@2
   573
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   574
|     Type      |     Code      |          Checksum             |
williamr@2
   575
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   576
|R|S|O|                     Reserved                            |
williamr@2
   577
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   578
|                                                               |
williamr@2
   579
+                                                               +
williamr@2
   580
|                                                               |
williamr@2
   581
+                       Target Address                          +
williamr@2
   582
|                                                               |
williamr@2
   583
+                                                               +
williamr@2
   584
|                                                               |
williamr@2
   585
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   586
|   Options ...
williamr@2
   587
+-+-+-+-+-+-+-+-+-+-+-+-
williamr@2
   588
@endverbatim
williamr@2
   589
* @note
williamr@2
   590
*	Above is longer thant what is declared in the base class
williamr@2
   591
*	i-member. The user must verify the sufficient length of
williamr@2
   592
*	the packet, when using this.
williamr@2
   593
*
williamr@2
   594
* Valid options:
williamr@2
   595
*
williamr@2
   596
* - #KInet6OptionICMP_TargetLink
williamr@2
   597
*
williamr@2
   598
* @publishedAll
williamr@2
   599
* @released
williamr@2
   600
*/
williamr@2
   601
	{
williamr@2
   602
public:
williamr@2
   603
	//
williamr@2
   604
	// General
williamr@2
   605
	//
williamr@2
   606
	inline static TInt MinHeaderLength() {return 24; }
williamr@2
   607
	inline static TInt MaxHeaderLength() {return 24; }
williamr@2
   608
	inline TInt HeaderLength() const {return 24;}
williamr@2
   609
williamr@2
   610
	//
williamr@2
   611
	// Set and Access the Target Address
williamr@2
   612
	//
williamr@2
   613
	inline TIp6Addr &Target() const
williamr@2
   614
		/**
williamr@2
   615
		* Gets the Target Address.
williamr@2
   616
		*
williamr@2
   617
		* @return The target address (reference).
williamr@2
   618
		*/
williamr@2
   619
		{
williamr@2
   620
		return (TIp6Addr &)i[8];
williamr@2
   621
		}
williamr@2
   622
williamr@2
   623
	inline TInt R()
williamr@2
   624
		{
williamr@2
   625
		return 0x80 & i[4];
williamr@2
   626
		}
williamr@2
   627
	inline TInt S()
williamr@2
   628
		{
williamr@2
   629
		return 0x40 & i[4];
williamr@2
   630
		}
williamr@2
   631
	inline TInt O()
williamr@2
   632
		{
williamr@2
   633
		return 0x20 & i[4];
williamr@2
   634
		}
williamr@2
   635
	inline void SetR(TInt aValue)
williamr@2
   636
		{
williamr@2
   637
		if (aValue) i[4] |= 0x80; else i[4] &= ~0x80;
williamr@2
   638
		}
williamr@2
   639
	inline void SetS(TInt aValue)
williamr@2
   640
		{
williamr@2
   641
		if (aValue) i[4] |= 0x40; else i[4] &= ~0x40;
williamr@2
   642
		}
williamr@2
   643
	inline void SetO(TInt aValue)
williamr@2
   644
		{
williamr@2
   645
		if (aValue) i[4] |= 0x20; else i[4] &= ~0x20;
williamr@2
   646
		}
williamr@2
   647
williamr@2
   648
	};
williamr@2
   649
williamr@2
   650
williamr@2
   651
class TInet6HeaderICMP_Redirect : public TInet6HeaderICMP
williamr@2
   652
/**
williamr@2
   653
* ICMPv6 Redirect layout.
williamr@2
   654
@verbatim
williamr@2
   655
Redirect Message Format (RFC-2461)
williamr@2
   656
williamr@2
   657
 0                   1                   2                   3
williamr@2
   658
 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
williamr@2
   659
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   660
|     Type      |     Code      |          Checksum             |
williamr@2
   661
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   662
|                           Reserved                            |
williamr@2
   663
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   664
|                                                               |
williamr@2
   665
+                                                               +
williamr@2
   666
|                                                               |
williamr@2
   667
+                       Target Address                          +
williamr@2
   668
|                                                               |
williamr@2
   669
+                                                               +
williamr@2
   670
|                                                               |
williamr@2
   671
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   672
|                                                               |
williamr@2
   673
+                                                               +
williamr@2
   674
|                                                               |
williamr@2
   675
+                     Destination Address                       +
williamr@2
   676
|                                                               |
williamr@2
   677
+                                                               +
williamr@2
   678
|                                                               |
williamr@2
   679
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   680
|   Options ...
williamr@2
   681
+-+-+-+-+-+-+-+-+-+-+-+-
williamr@2
   682
williamr@2
   683
@endverbatim
williamr@2
   684
* @note
williamr@2
   685
*	Above is longer thant what is declared in the base class
williamr@2
   686
*	i-member. The user must verify the sufficient length of
williamr@2
   687
*	the packet, when using this.
williamr@2
   688
*
williamr@2
   689
* Valid options:
williamr@2
   690
*
williamr@2
   691
* - #KInet6OptionICMP_TargetLink
williamr@2
   692
* - #KInet6OptionICMP_Redirect
williamr@2
   693
*
williamr@2
   694
* @publishedAll
williamr@2
   695
* @released
williamr@2
   696
*/
williamr@2
   697
	{
williamr@2
   698
public:
williamr@2
   699
	//
williamr@2
   700
	// General
williamr@2
   701
	//
williamr@2
   702
	inline static TInt MinHeaderLength() {return 40; }
williamr@2
   703
	inline static TInt MaxHeaderLength() {return 40; }
williamr@2
   704
	inline TInt HeaderLength() const {return 40;}
williamr@2
   705
williamr@2
   706
	inline TIp6Addr &Target() const
williamr@2
   707
		/**
williamr@2
   708
		* Gets the Target Address.
williamr@2
   709
		*
williamr@2
   710
		* @return The target address (reference).
williamr@2
   711
		*/
williamr@2
   712
		{
williamr@2
   713
		return (TIp6Addr &)i[8];
williamr@2
   714
		}
williamr@2
   715
	inline TIp6Addr &Destination() const
williamr@2
   716
		/**
williamr@2
   717
		* Gets the Destination Address.
williamr@2
   718
		*
williamr@2
   719
		* @return The destination address (reference).
williamr@2
   720
		*/
williamr@2
   721
		{
williamr@2
   722
		return (TIp6Addr &)i[24];
williamr@2
   723
		}
williamr@2
   724
	};
williamr@2
   725
williamr@2
   726
williamr@2
   727
class TInet6OptionICMP_LinkLayer
williamr@2
   728
/**
williamr@2
   729
* ICMPv6 Link-layer Address layout.
williamr@2
   730
@verbatim
williamr@2
   731
Source/Target Link-layer Address Option (RFC-2461)
williamr@2
   732
williamr@2
   733
 0                   1                   2                   3
williamr@2
   734
 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
williamr@2
   735
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   736
|     Type      |    Length     |    Link-Layer Address ...
williamr@2
   737
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   738
@endverbatim
williamr@2
   739
* @publishedAll
williamr@2
   740
* @released
williamr@2
   741
*/
williamr@2
   742
	{
williamr@2
   743
public:
williamr@2
   744
	inline static TInt MinHeaderLength() {return 8; }
williamr@2
   745
	inline static TInt MaxHeaderLength() {return 8; }	// Not very useful
williamr@2
   746
	inline TInt HeaderLength() const {return Length() * 8; }
williamr@2
   747
	//
williamr@2
   748
	// Access
williamr@2
   749
	//
williamr@2
   750
	inline TInt Type() const
williamr@2
   751
		{
williamr@2
   752
		return i[0];
williamr@2
   753
		}
williamr@2
   754
	inline TInt Length() const
williamr@2
   755
		{
williamr@2
   756
		return i[1];
williamr@2
   757
		}
williamr@2
   758
	//
williamr@2
   759
	// Access and Set
williamr@2
   760
	//
williamr@2
   761
	inline TPtr8 Address() const
williamr@2
   762
		{
williamr@2
   763
		return TPtr8((TUint8 *)&i[2], i[1] * 8 - 2, i[1] * 8 - 2);
williamr@2
   764
		}
williamr@2
   765
	//
williamr@2
   766
	// Construct methods
williamr@2
   767
	//
williamr@2
   768
	inline void SetType(TInt aType)
williamr@2
   769
		{
williamr@2
   770
		i[0] = (TUint8)aType;
williamr@2
   771
		}
williamr@2
   772
	inline void SetLength(TInt aLength)
williamr@2
   773
		{
williamr@2
   774
		i[1] = (TUint8)aLength;
williamr@2
   775
		}
williamr@2
   776
private:
williamr@2
   777
	union
williamr@2
   778
		{
williamr@2
   779
		TUint8 i[8];
williamr@2
   780
		TUint32 iAlign;	// A dummy member to force the 4 byte alignment
williamr@2
   781
		};
williamr@2
   782
	};
williamr@2
   783
williamr@2
   784
williamr@2
   785
class TInet6OptionICMP_Prefix
williamr@2
   786
/**
williamr@2
   787
* ICMPv6 Prefix Infotmation Option.
williamr@2
   788
@verbatim
williamr@2
   789
Prefix Information Option (RFC-2461)
williamr@2
   790
(+ Router Address flag from draft-ietf-mobileip-ipv6-08)
williamr@2
   791
 0                   1                   2                   3
williamr@2
   792
 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
williamr@2
   793
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   794
|     Type      |    Length     | Prefix Length |L|A|R| Rsrvd1  |
williamr@2
   795
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   796
|                         Valid Lifetime                        |
williamr@2
   797
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   798
|                       Preferred Lifetime                      |
williamr@2
   799
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   800
|                           Reserved2                           |
williamr@2
   801
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   802
|                                                               |
williamr@2
   803
+                                                               +
williamr@2
   804
|                                                               |
williamr@2
   805
+                            Prefix                             +
williamr@2
   806
|                                                               |
williamr@2
   807
+                                                               +
williamr@2
   808
|                                                               |
williamr@2
   809
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   810
williamr@2
   811
@endverbatim
williamr@2
   812
* @publishedAll
williamr@2
   813
* @released
williamr@2
   814
*/
williamr@2
   815
	{
williamr@2
   816
public:
williamr@2
   817
	inline static TInt MinHeaderLength() {return 4*8; }
williamr@2
   818
	inline static TInt MaxHeaderLength() {return 4*8; }	// Not very useful
williamr@2
   819
	inline TInt HeaderLength() const {return 4*8; }
williamr@2
   820
williamr@2
   821
	inline TInt Type() const
williamr@2
   822
		{
williamr@2
   823
		return i[0];
williamr@2
   824
		}
williamr@2
   825
	inline TInt Length() const
williamr@2
   826
		{
williamr@2
   827
		return i[1];
williamr@2
   828
		}
williamr@2
   829
	inline TInt PrefixLength() const
williamr@2
   830
		{
williamr@2
   831
		return i[2];	// 0..128
williamr@2
   832
		}
williamr@2
   833
	inline TInt LFlag() const
williamr@2
   834
		{
williamr@2
   835
		return i[3] & 0x80;
williamr@2
   836
		}
williamr@2
   837
	inline TInt AFlag() const
williamr@2
   838
		{
williamr@2
   839
		return i[3] & 0x40;
williamr@2
   840
		}
williamr@2
   841
	inline TInt RFlag() const
williamr@2
   842
		{
williamr@2
   843
		return i[3] & 0x20;
williamr@2
   844
		}
williamr@2
   845
	inline TUint32 ValidLifetime() const
williamr@2
   846
		{
williamr@2
   847
		return (i[4] << 24) | (i[5] << 16) | (i[6] << 8) | i[7];
williamr@2
   848
		}
williamr@2
   849
	inline TUint32 PreferredLifetime() const
williamr@2
   850
		{
williamr@2
   851
		return (i[8] << 24) | (i[9] << 16) | (i[10] << 8) | i[11];
williamr@2
   852
		}
williamr@2
   853
	//
williamr@2
   854
	//
williamr@2
   855
	inline TIp6Addr &Prefix() const
williamr@2
   856
		{
williamr@2
   857
		return (TIp6Addr &)i[16];
williamr@2
   858
		}
williamr@2
   859
	//
williamr@2
   860
	// Construct methods
williamr@2
   861
	//
williamr@2
   862
	inline void SetType(TInt aType)
williamr@2
   863
		{
williamr@2
   864
		i[0] = (TUint8)aType;
williamr@2
   865
		}
williamr@2
   866
	inline void SetLength(TInt aLength)
williamr@2
   867
		{
williamr@2
   868
		i[1] = (TUint8)aLength;
williamr@2
   869
		}
williamr@2
   870
	inline void SetPrefixLength(TInt aLength)
williamr@2
   871
		{
williamr@2
   872
		i[2] = (TUint8)aLength;
williamr@2
   873
		}
williamr@2
   874
	inline void SetFlags(TInt aFlags)
williamr@2
   875
		{
williamr@2
   876
		i[3] = (TUint8)aFlags;
williamr@2
   877
		}
williamr@2
   878
	inline void SetValidLifetime(TUint32 aTime)
williamr@2
   879
		{
williamr@2
   880
		i[7] = (TUint8)aTime;
williamr@2
   881
		i[6] = (TUint8)(aTime >> 8);
williamr@2
   882
		i[5] = (TUint8)(aTime >> 16);
williamr@2
   883
		i[4] = (TUint8)(aTime >> 24);
williamr@2
   884
		}
williamr@2
   885
	inline void SetPreferredLifetime(TUint32 aTime)
williamr@2
   886
		{
williamr@2
   887
		i[11] = (TUint8)aTime;
williamr@2
   888
		i[10] = (TUint8)(aTime >> 8);
williamr@2
   889
		i[9] = (TUint8)(aTime >> 16);
williamr@2
   890
		i[8] = (TUint8)(aTime >> 24);
williamr@2
   891
		}
williamr@2
   892
	inline void SetReserved2(TUint32 aFiller)
williamr@2
   893
		{
williamr@2
   894
		i[15] = (TUint8)aFiller;
williamr@2
   895
		i[14] = (TUint8)(aFiller >> 8);
williamr@2
   896
		i[13] = (TUint8)(aFiller >> 16);
williamr@2
   897
		i[12] = (TUint8)(aFiller >> 24);
williamr@2
   898
		}
williamr@2
   899
williamr@2
   900
williamr@2
   901
private:
williamr@2
   902
	union
williamr@2
   903
		{
williamr@2
   904
		TUint8 i[4*8];
williamr@2
   905
		TUint32 iAlign;	// A dummy member to force the 4 byte alignment
williamr@2
   906
		};
williamr@2
   907
	};
williamr@2
   908
williamr@2
   909
williamr@2
   910
class TInet6OptionICMP_Mtu
williamr@2
   911
/**
williamr@2
   912
* ICMPv6 MTU Option.
williamr@2
   913
@verbatim
williamr@2
   914
MTU Option (RFC-2461)
williamr@2
   915
williamr@2
   916
 0                   1                   2                   3
williamr@2
   917
 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
williamr@2
   918
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   919
|     Type      |    Length     |           Reserved            |
williamr@2
   920
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   921
|                              MTU                              |
williamr@2
   922
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
   923
@endverbatim
williamr@2
   924
* @publishedAll
williamr@2
   925
* @released
williamr@2
   926
*/
williamr@2
   927
	{
williamr@2
   928
public:
williamr@2
   929
	inline static TInt MinHeaderLength() {return 8; }
williamr@2
   930
	inline static TInt MaxHeaderLength() {return 8; }	// Not very useful
williamr@2
   931
	inline TInt HeaderLength() const {return 8; }
williamr@2
   932
williamr@2
   933
	inline TInt Type() const
williamr@2
   934
		{
williamr@2
   935
		return i[0];
williamr@2
   936
		}
williamr@2
   937
	inline TInt Length() const
williamr@2
   938
		{
williamr@2
   939
		return i[1];
williamr@2
   940
		}
williamr@2
   941
	inline TInt Mtu() const
williamr@2
   942
		{
williamr@2
   943
		return (i[4] << 24) | (i[5] << 16) | (i[6] << 8) | i[7];
williamr@2
   944
		}
williamr@2
   945
	//
williamr@2
   946
	// Construct methods
williamr@2
   947
	//
williamr@2
   948
	inline void SetType(TInt aType)
williamr@2
   949
		{
williamr@2
   950
		i[0] = (TUint8)aType;
williamr@2
   951
		}
williamr@2
   952
	inline void SetLength(TInt aLength)
williamr@2
   953
		{
williamr@2
   954
		i[1] = (TUint8)aLength;
williamr@2
   955
		// Silently ZERO the reserved bits... not too nice --- msa
williamr@2
   956
		i[2] = 0;
williamr@2
   957
		i[3] = 0;
williamr@2
   958
		}
williamr@2
   959
	inline void SetMtu(TUint32 aMtu)
williamr@2
   960
		{
williamr@2
   961
		i[7] = (TUint8)aMtu;
williamr@2
   962
		i[6] = (TUint8)(aMtu >> 8);
williamr@2
   963
		i[5] = (TUint8)(aMtu >> 16);
williamr@2
   964
		i[4] = (TUint8)(aMtu >> 24);
williamr@2
   965
		}
williamr@2
   966
private:
williamr@2
   967
	TUint8 i[8];
williamr@2
   968
	};
williamr@2
   969
williamr@2
   970
williamr@2
   971
#if 1
williamr@2
   972
class TInet6OptionICMP_RouteInformation
williamr@2
   973
// Route Information Option 
williamr@2
   974
// Experimental: draft-draves-ipngwg-router-selection-01.txt
williamr@2
   975
/**
williamr@2
   976
*  ICMPv6 Route Information Option.
williamr@2
   977
@verbatim
williamr@2
   978
Default Router Preferences and More-Specific Routes
williamr@2
   979
williamr@2
   980
 0                   1                   2                   3 
williamr@2
   981
 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 
williamr@2
   982
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 
williamr@2
   983
|     Type      |    Length     | Prefix Length |Resvd|Prf|Resvd| 
williamr@2
   984
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 
williamr@2
   985
|                        Route Lifetime                         | 
williamr@2
   986
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 
williamr@2
   987
|                                                               | 
williamr@2
   988
+                                                               + 
williamr@2
   989
|                                                               | 
williamr@2
   990
+                            Prefix                             + 
williamr@2
   991
|                                                               | 
williamr@2
   992
+                                                               + 
williamr@2
   993
|                                                               | 
williamr@2
   994
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 
williamr@2
   995
@endverbatim
williamr@2
   996
* @publishedAll
williamr@2
   997
* @released
williamr@2
   998
*/
williamr@2
   999
	{
williamr@2
  1000
public:
williamr@2
  1001
	inline static TInt MinHeaderLength() {return 8; }
williamr@2
  1002
	inline static TInt MaxHeaderLength() {return 3*8; }
williamr@2
  1003
	inline TInt HeaderLength() const {return Length()*8; }
williamr@2
  1004
williamr@2
  1005
	inline TInt Type() const
williamr@2
  1006
		{
williamr@2
  1007
		return i[0];
williamr@2
  1008
		}
williamr@2
  1009
	inline TInt Length() const
williamr@2
  1010
		{
williamr@2
  1011
		return i[1];
williamr@2
  1012
		}
williamr@2
  1013
	inline TInt PrefixLength() const
williamr@2
  1014
		{
williamr@2
  1015
		return i[2];	// 0..128
williamr@2
  1016
		}
williamr@2
  1017
	inline TInt Prf() const
williamr@2
  1018
		{
williamr@2
  1019
		return (i[3] >> 3) & 0x3;	// should be treated as 2bit signed int
williamr@2
  1020
		}
williamr@2
  1021
	inline TUint32 RouteLifetime() const
williamr@2
  1022
		{
williamr@2
  1023
		return (i[4] << 24) | (i[5] << 16) | (i[6] << 8) | i[7];
williamr@2
  1024
		}
williamr@2
  1025
	//
williamr@2
  1026
	// *WARNING* The "Prefix" returns a raw reference to the beginning
williamr@2
  1027
	// of the prefix field in the option structure. HOWEVER, the option
williamr@2
  1028
	// field can be shorter than 128 bits! If used to allocate space,
williamr@2
  1029
	// the maximum is allocated and the method is safe, but that is not
williamr@2
  1030
	// true if header is mapped directly to the received packet! -- msa
williamr@2
  1031
	inline TIp6Addr &Prefix() const
williamr@2
  1032
		{
williamr@2
  1033
		return (TIp6Addr &)i[8];
williamr@2
  1034
		}
williamr@2
  1035
	//
williamr@2
  1036
	// Construct methods
williamr@2
  1037
	//
williamr@2
  1038
	inline void SetType(TInt aType)
williamr@2
  1039
		{
williamr@2
  1040
		i[0] = (TUint8)aType;
williamr@2
  1041
		}
williamr@2
  1042
	inline void SetLength(TInt aLength)
williamr@2
  1043
		{
williamr@2
  1044
		i[1] = (TUint8)aLength;
williamr@2
  1045
		}
williamr@2
  1046
	inline void SetPrefixLength(TInt aLength)
williamr@2
  1047
		{
williamr@2
  1048
		i[2] = (TUint8)aLength;
williamr@2
  1049
		}
williamr@2
  1050
	inline void SetPrefixLifetime(TUint32 aTime)
williamr@2
  1051
		{
williamr@2
  1052
		i[7] = (TUint8)aTime;
williamr@2
  1053
		i[6] = (TUint8)(aTime >> 8);
williamr@2
  1054
		i[5] = (TUint8)(aTime >> 16);
williamr@2
  1055
		i[4] = (TUint8)(aTime >> 24);
williamr@2
  1056
		}
williamr@2
  1057
williamr@2
  1058
private:
williamr@2
  1059
	union
williamr@2
  1060
		{
williamr@2
  1061
		TUint8 i[3*8];	// The space allocated for MAX LENGTH
williamr@2
  1062
		TUint32 iAlign;	// A dummy member to force the 4 byte alignment
williamr@2
  1063
		};
williamr@2
  1064
	};
williamr@2
  1065
williamr@2
  1066
class TInet6OptionICMP_DnsInformation
williamr@2
  1067
/**
williamr@2
  1068
*  ICMPv6 Recursive DNS Server Option.
williamr@2
  1069
* IPv6 DNS Configuration based on Router Advertisement
williamr@2
  1070
*
williamr@2
  1071
* Experimental: draft-jeong-dnsop-ipv6-discovery-03.txt
williamr@2
  1072
@verbatim
williamr@2
  1073
Recursive DNS Server Option
williamr@2
  1074
williamr@2
  1075
 0                   1                   2                   3
williamr@2
  1076
 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
williamr@2
  1077
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
  1078
|     Type      |     Length    |  Pref |        Reserved       |
williamr@2
  1079
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
  1080
|                           Lifetime                            |
williamr@2
  1081
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
  1082
|                                                               |
williamr@2
  1083
:                     IPv6 Address of RDNSS                     :
williamr@2
  1084
|                                                               |
williamr@2
  1085
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
williamr@2
  1086
     
williamr@2
  1087
@endverbatim
williamr@2
  1088
* @publishedAll
williamr@2
  1089
* @released
williamr@2
  1090
*/
williamr@2
  1091
	{
williamr@2
  1092
public:
williamr@2
  1093
	inline static TInt MinHeaderLength() {return 24; }
williamr@2
  1094
	inline static TInt MaxHeaderLength() {return 24; }
williamr@2
  1095
	inline TInt HeaderLength() const {return Length()*8; }
williamr@2
  1096
williamr@2
  1097
	inline TInt Type() const
williamr@2
  1098
		{
williamr@2
  1099
		return i[0];
williamr@2
  1100
		}
williamr@2
  1101
	inline TInt Length() const
williamr@2
  1102
		{
williamr@2
  1103
		return i[1];
williamr@2
  1104
		}
williamr@2
  1105
	inline TInt Pref() const
williamr@2
  1106
		{
williamr@2
  1107
		return (i[3] >> 4) & 0xF;
williamr@2
  1108
		}
williamr@2
  1109
	inline TUint32 Lifetime() const
williamr@2
  1110
		{
williamr@2
  1111
		return (i[4] << 24) | (i[5] << 16) | (i[6] << 8) | i[7];
williamr@2
  1112
		}
williamr@2
  1113
	inline TIp6Addr &Address() const
williamr@2
  1114
		{
williamr@2
  1115
		return (TIp6Addr &)i[8];
williamr@2
  1116
		}
williamr@2
  1117
	//
williamr@2
  1118
	// Construct methods
williamr@2
  1119
	//
williamr@2
  1120
	inline void SetType(TInt aType)
williamr@2
  1121
		{
williamr@2
  1122
		i[0] = (TUint8)aType;
williamr@2
  1123
		}
williamr@2
  1124
	inline void SetLength(TInt aLength)
williamr@2
  1125
		{
williamr@2
  1126
		i[1] = (TUint8)aLength;
williamr@2
  1127
		}
williamr@2
  1128
	inline void SetPref(TInt aPref)
williamr@2
  1129
		{
williamr@2
  1130
		i[2] = (TUint8)(((aPref << 4) & 0xF0) | (i[2] & 0xF));
williamr@2
  1131
		}
williamr@2
  1132
	inline void SetLifetime(TUint32 aTime)
williamr@2
  1133
		{
williamr@2
  1134
		i[7] = (TUint8)aTime;
williamr@2
  1135
		i[6] = (TUint8)(aTime >> 8);
williamr@2
  1136
		i[5] = (TUint8)(aTime >> 16);
williamr@2
  1137
		i[4] = (TUint8)(aTime >> 24);
williamr@2
  1138
		}
williamr@2
  1139
williamr@2
  1140
private:
williamr@2
  1141
	union
williamr@2
  1142
		{
williamr@2
  1143
		TUint8 i[24];	// The space allocated for MAX LENGTH
williamr@2
  1144
		TUint32 iAlign;	// A dummy member to force the 4 byte alignment
williamr@2
  1145
		};
williamr@2
  1146
	};
williamr@2
  1147
williamr@2
  1148
#endif
williamr@2
  1149
williamr@2
  1150
/**
williamr@2
  1151
* @name ICMPv6 Error Message Types (0-127)
williamr@2
  1152
*/
williamr@2
  1153
//@{
williamr@2
  1154
const TUint8 KInet6ICMP_Unreachable		= 1;
williamr@2
  1155
const TUint8 KInet6ICMP_PacketTooBig	= 2;
williamr@2
  1156
const TUint8 KInet6ICMP_TimeExceeded	= 3;
williamr@2
  1157
const TUint8 KInet6ICMP_ParameterProblem= 4;
williamr@2
  1158
//@}
williamr@2
  1159
/**
williamr@2
  1160
* @name ICMPv6 Informational Message Types (128-255)
williamr@2
  1161
*/
williamr@2
  1162
//@{
williamr@2
  1163
/** Echo Request. See TInet6HeaderICMP_Echo. */
williamr@2
  1164
const TUint8 KInet6ICMP_EchoRequest		= 128;
williamr@2
  1165
/** Echo Reply. See TInet6HeaderICMP_Echo. */
williamr@2
  1166
const TUint8 KInet6ICMP_EchoReply		= 129;
williamr@2
  1167
/** Not implemented. */
williamr@2
  1168
const TUint8 KInet6ICMP_GroupQuery		= 130;
williamr@2
  1169
/** Not implemented. */
williamr@2
  1170
const TUint8 KInet6ICMP_GroupReport		= 131;
williamr@2
  1171
/** Not implemented. */
williamr@2
  1172
const TUint8 KInet6ICMP_GroupDone		= 132;
williamr@2
  1173
/** Router Solicitation. See TInet6HeaderICMP_RouterSol. */
williamr@2
  1174
const TUint8 KInet6ICMP_RouterSol		= 133;
williamr@2
  1175
/** Router Advertisement. See TInet6HeaderICMP_RouterAdv. */
williamr@2
  1176
const TUint8 KInet6ICMP_RouterAdv		= 134;
williamr@2
  1177
/** Neighbor Solicitation. See TInet6HeaderICMP_NeighborSol. */
williamr@2
  1178
const TUint8 KInet6ICMP_NeighborSol		= 135;
williamr@2
  1179
/** Neighbor Advertisement. See TInet6HeaderICMP_NeighborAdv. */
williamr@2
  1180
const TUint8 KInet6ICMP_NeighborAdv		= 136;
williamr@2
  1181
/** Redirect. See TInet6HeaderICMP_Redirect. */
williamr@2
  1182
const TUint8 KInet6ICMP_Redirect		= 137;
williamr@2
  1183
//@}
williamr@2
  1184
williamr@2
  1185
/**
williamr@2
  1186
* @name ICMPv6 Option types.
williamr@2
  1187
* The default derivation of the symbol
williamr@2
  1188
* is from the name of the header class by replacing 'T' with 'K' (or
williamr@2
  1189
* vice versa).
williamr@2
  1190
*
williamr@2
  1191
*/
williamr@2
  1192
//@{
williamr@2
  1193
/** Source Link-Layer Address. See TInet6OptionICMP_LinkLayer. */
williamr@2
  1194
const TInt KInet6OptionICMP_SourceLink	= 1;
williamr@2
  1195
/** Target Link-Layer Address. See TInet6OptionICMP_LinkLayer. */
williamr@2
  1196
const TInt KInet6OptionICMP_TargetLink	= 2;
williamr@2
  1197
/** Prefix Information. See TInet6OptionICMP_Prefix. */
williamr@2
  1198
const TInt KInet6OptionICMP_Prefix		= 3;
williamr@2
  1199
/** Redirect Header. (not implemented). */
williamr@2
  1200
const TInt KInet6OptionICMP_Redirect	= 4;
williamr@2
  1201
/** MTU.  See TInet6OptionICMP_Mtu. */
williamr@2
  1202
const TInt KInet6OptionICMP_Mtu			= 5;
williamr@2
  1203
williamr@2
  1204
#if 1
williamr@2
  1205
	// Experimental: draft-draves-ipngwg-router-selection-01.txt
williamr@2
  1206
	// Default Router Preferences and More-Specific Routes
williamr@2
  1207
	// *UNOFFICIAL NUMBER ASSIGNMENT (SAME AS MSR STACK)--REAL VALUE TBD*
williamr@2
  1208
/** Route Information. See TInet6OptionICMP_RouteInformation. */
williamr@2
  1209
const TInt KInet6OptionICMP_RouteInformation = 9;
williamr@2
  1210
#endif
williamr@2
  1211
//@}
williamr@2
  1212
williamr@2
  1213
//@}
williamr@2
  1214
#endif