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