epoc32/include/udp_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
// udp_hdr.h - UDP header structure
williamr@2
    15
// Defines the basic classes for accessing the header
williamr@2
    16
// structures within UDP packets.
williamr@2
    17
//
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
/**
williamr@2
    22
 @file udp_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 __UDP_HDR_H__
williamr@2
    29
#define __UDP_HDR_H__
williamr@2
    30
williamr@2
    31
#include <e32def.h>
williamr@2
    32
#include "in_hdr.h"
williamr@2
    33
williamr@2
    34
/**
williamr@2
    35
* @addtogroup ip_packet_formats
williamr@2
    36
* @{
williamr@2
    37
*/
williamr@2
    38
williamr@2
    39
// TInet6HeaderUPD
williamr@2
    40
williamr@2
    41
class TInet6HeaderUDP
williamr@2
    42
	/** UDP Header format.
williamr@2
    43
    * User Datagram Header Format
williamr@2
    44
	* @verbatim
williamr@2
    45
Extract from RFC-768
williamr@2
    46
                                    
williamr@2
    47
     0      7 8     15 16    23 24    31  
williamr@2
    48
    +--------+--------+--------+--------+ 
williamr@2
    49
    |     Source      |   Destination   | 
williamr@2
    50
    |      Port       |      Port       | 
williamr@2
    51
    +--------+--------+--------+--------+ 
williamr@2
    52
    |                 |                 | 
williamr@2
    53
    |     Length      |    Checksum     | 
williamr@2
    54
    +--------+--------+--------+--------+ 
williamr@2
    55
    |                                     
williamr@2
    56
    |          data octets ...            
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 {return 8;}
williamr@2
    65
	inline static TInt MinHeaderLength() {return 8; }
williamr@2
    66
	inline static TInt MaxHeaderLength() {return 8; }
williamr@2
    67
	inline TUint8 *EndPtr() {return i + HeaderLength();}
williamr@2
    68
	//
williamr@2
    69
	// Access, Get UDP field values from the packet
williamr@2
    70
	//
williamr@2
    71
	inline TUint SrcPort() const
williamr@2
    72
		{
williamr@2
    73
		return (i[0] << 8) + i[1];
williamr@2
    74
		}
williamr@2
    75
	inline TUint DstPort() const
williamr@2
    76
		{
williamr@2
    77
		return (i[2] << 8) + i[3];
williamr@2
    78
		}
williamr@2
    79
	inline TInt Length() const
williamr@2
    80
		{
williamr@2
    81
		return (i[4] << 8) + i[5];
williamr@2
    82
		}
williamr@2
    83
	inline TInt Checksum() const
williamr@2
    84
		{
williamr@2
    85
		// Checksum is used in network byte order
williamr@2
    86
		return *((TUint16 *)&i[6]);
williamr@2
    87
		}
williamr@2
    88
	//
williamr@2
    89
	// Build, Set UDP field value to the packet
williamr@2
    90
	//
williamr@2
    91
	inline void SetSrcPort(TUint aPort)
williamr@2
    92
		{
williamr@2
    93
		i[0] = (TUint8)(aPort >> 8);
williamr@2
    94
		i[1] = (TUint8)aPort;
williamr@2
    95
		}
williamr@2
    96
	inline void SetDstPort(TUint aPort)
williamr@2
    97
		{
williamr@2
    98
		i[2] = (TUint8)(aPort >> 8);
williamr@2
    99
		i[3] = (TUint8)aPort;
williamr@2
   100
		}
williamr@2
   101
	inline void SetLength(TInt aLength)
williamr@2
   102
		{
williamr@2
   103
		i[4] = (TUint8)(aLength / 256);
williamr@2
   104
		i[5] = (TUint8) aLength;
williamr@2
   105
		}
williamr@2
   106
	inline void SetChecksum(TInt aSum)
williamr@2
   107
		{
williamr@2
   108
		// Checksum is used in network byte order
williamr@2
   109
		*((TUint16 *)&i[6]) = (TUint16)aSum;
williamr@2
   110
		}
williamr@2
   111
private:
williamr@2
   112
	TUint8 i[8];
williamr@2
   113
	};
williamr@2
   114
/** @} */
williamr@2
   115
#endif