epoc32/include/es_sock.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     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
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 inline TSockIOBufC::TSockIOBufC()	: TPckgC<TSockIO>(iArgs)
    17 
    18 	{}
    19 
    20 inline TSockOpenBufC::TSockOpenBufC()	: TPckgC<TSockOpen>(iArgs)
    21 
    22 	{}
    23 
    24 inline SSockAddr *TSockAddr::BasePtr() const
    25 /**
    26 This function returns the end point to a connection.
    27 
    28 @return socket address
    29 */
    30 	{ return (SSockAddr*)iBuf; }
    31 
    32 
    33 inline TUint8 *TSockAddr::UserPtr() const
    34 /** Gets an offset to place data after the base class data. This function is mainly 
    35 intended for use in derived classes.
    36 @return Pointer to derived class intended data area */
    37 	{ return (TUint8*)(BasePtr()+1); }
    38 
    39 inline TUint16 ByteOrder::Swap16(TUint aVal)
    40 /** 
    41 Reverses the order of the bytes in a 16-bit value.
    42 	
    43 @param aVal The value to reverse. 
    44 @return The reversed value. 
    45 */
    46 	{ return ByteOrder::Swap16((TUint16)aVal); }
    47 
    48 inline TNameRecord::TNameRecord()
    49 	:iName(),iAddr(),iFlags(0)	
    50 /** 
    51 Trivial C++ constructor. This sets the fields in the 
    52 class to suitable default values. 
    53 */
    54 	{}
    55 
    56 inline TNifProgress::TNifProgress()	:iStage(0), iError(KErrNone) 
    57 /**
    58 It sets the iStage data member to 0 and the iError data member to KErrNone.
    59 */
    60 	{}
    61 
    62 inline RSubConnection::TEventFilter::TEventFilter(TInt32 aEventGroupId, TUint32 aEventMask)
    63 	: iEventGroupUid(aEventGroupId), iEventMask(aEventMask)
    64 	{
    65 	}
    66 
    67 inline TUint32 CSubConParameterFamily::Id()
    68 /**
    69 Fetch the identity of the sub-connection parameter family
    70 */
    71 	{
    72 	return iFamilyId;
    73 	}
    74 
    75 inline TAccessPointInfo::TAccessPointInfo(TUint aApId)
    76 /** Initialises the object using the specified 32-bit long integer ID of the access point.
    77 
    78 @param aApId The 32-bit long integer ID of the access point to initialise the object with. */
    79 	{
    80 	iAccessPointId = aApId;
    81 	}
    82 
    83 inline TUint TAccessPointInfo::AccessPoint() const
    84 /** Returns the 32-bit long integer ID of the access point.
    85 
    86 @return The 32-bit long integer ID of the access point. */
    87 	{
    88 	return iAccessPointId;
    89 	}
    90 
    91 inline void TAccessPointInfo::SetAccessPoint(TUint aAccessPoint)
    92 /** Sets the 32-bit long integer ID of the access point.
    93 
    94 @param aAccessPoint The 32-bit long integer ID of the access point. */
    95 	{
    96 	iAccessPointId = aAccessPoint;
    97 	}
    98 	
    99 inline TBool TAccessPointInfo::operator== (const TAccessPointInfo& aRhs) const
   100 /** Compares the 32-bit long integer ID of the specified object with our own.
   101 
   102 @param aRhs The TAccessPointInfo to compare.
   103 @return A boolean value of ETrue if the TAccessPointInfo object has the same ID or false otherwise. */
   104 	{
   105 	return iAccessPointId == aRhs.iAccessPointId;
   106 	}