epoc32/include/networking/vj.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2003-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
//
williamr@2
    15
williamr@2
    16
#if !defined(__VJ_INL_)
williamr@2
    17
#define __VJ_INL_
williamr@2
    18
williamr@2
    19
/**
williamr@2
    20
Sets a flag indicating that the stored object contains a valid TCP/IP header.
williamr@2
    21
williamr@2
    22
@see IsValid()
williamr@2
    23
*/
williamr@2
    24
inline void TVJCompHdr::MarkValid()
williamr@2
    25
	{
williamr@2
    26
	iConnectionId |= KVJValidFlag;
williamr@2
    27
	}
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
Determines if the stored TCP/IP header contains valid data.
williamr@2
    31
williamr@2
    32
@see MarkValid()
williamr@2
    33
williamr@2
    34
@return ETrue if the object contains valid headers
williamr@2
    35
*/
williamr@2
    36
inline TBool TVJCompHdr::IsValid() const
williamr@2
    37
	{
williamr@2
    38
	return !!(iConnectionId & KVJValidFlag);
williamr@2
    39
	}
williamr@2
    40
williamr@2
    41
/**
williamr@2
    42
Sets the pointer to the next object in the linked list.
williamr@2
    43
williamr@2
    44
@param aNextPtr Another TVJCompHdr object
williamr@2
    45
*/
williamr@2
    46
inline void TVJCompHdr::SetNextPtr(TVJCompHdr* aNextPtr)
williamr@2
    47
	{
williamr@2
    48
	iNextPtr = aNextPtr;
williamr@2
    49
	}
williamr@2
    50
williamr@2
    51
/**
williamr@2
    52
Returns the next object in the linked list.
williamr@2
    53
williamr@2
    54
@return The next TVJCompHdr object
williamr@2
    55
*/
williamr@2
    56
TVJCompHdr* TVJCompHdr::NextPtr() const
williamr@2
    57
	{
williamr@2
    58
	return iNextPtr;
williamr@2
    59
	}
williamr@2
    60
williamr@2
    61
/**
williamr@2
    62
Sets the VJ connection number.
williamr@2
    63
Also clears the valid flag as a side effect.
williamr@2
    64
williamr@2
    65
@param aConnection VJ connection number (0..255)
williamr@2
    66
*/
williamr@2
    67
inline void TVJCompHdr::SetConnectionNumber(TUint aConnection)
williamr@2
    68
	{
williamr@2
    69
	iConnectionId = aConnection;
williamr@2
    70
	}
williamr@2
    71
williamr@2
    72
/**
williamr@2
    73
Returns the VJ connection number.
williamr@2
    74
williamr@2
    75
@return VJ connection number
williamr@2
    76
*/
williamr@2
    77
inline TUint TVJCompHdr::ConnectionNumber() const
williamr@2
    78
	{
williamr@2
    79
	return iConnectionId & 0xff;	// Strip KVJValidFlag
williamr@2
    80
	}
williamr@2
    81
williamr@2
    82
williamr@2
    83
#endif // __VJ_INL_