in_sock.h

Go to the documentation of this file.

// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
// IPv6/IPv4 socket library public header 
// 
//
 
#ifndef __IN_SOCK_H__
#define __IN_SOCK_H__
 
#ifndef __ES_SOCK_H__
#include <es_sock.h>
#endif
 
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
#include <in_sock_internal.h>
#endif
 
const TUint KAfInet             = 0x0800;
const TUint KAfInet6            = 0x0806;
 
const TUint KProtocolInetIcmp   = 1;
 
const TUint KProtocolInetTcp    = 6;
 
const TUint KProtocolInetUdp    = 17;
 
const TUint KProtocolInet6Ipip  = 41;
 
const TUint KProtocolInet6Icmp  = 58;
 
const TUint KProtocolInetIp     = 0x100;
 
const TUint KProtocolInet6Ip    = 0xF00;
 
const TUint KProtocolUnknown = 0xdead;
 
 
const TUint KSolInetIcmp        = 0x101;
const TUint KSolInetTcp         = 0x106;
const TUint KSolInetUdp         = 0x111;
const TUint KSolInetIp          = 0x100;
const TUint KSolInetIfCtrl      = 0x201;
const TUint KSolInetRtCtrl      = 0x202;
const TUint KSolInetDnsCtrl     = 0x204;
const TUint KSolInetIfQuery     = 0x206;
#ifdef SYMBIAN_DNS_PUNYCODE
const TUint KSolInetDns         = 0x208;
#endif //SYMBIAN_DNS_PUNYCODE
 
const TInt KInetAddrMaxBits         = 32;
const TInt KInet6AddrMaxBits        = 128;
 
const TUint KInetPortAny            = 0x0000; 
const TUint KInetPortNone           = 0x0000;
const TUint KInetMinAutoPort        = 32768;
const TUint KInetMaxAutoPort        = 60999;
 
 
#define INET_ADDR(a,b,c,d) (TUint32)((((TUint32)(a))<<24)|((b)<<16)|((c)<<8)|(d))
 
const TUint32 KInetAddrAny              = INET_ADDR(0,0,0,0);
const TUint32 KInetAddrNone             = INET_ADDR(0,0,0,0);
const TUint32 KInetAddrAll              = INET_ADDR(255,255,255,255);
const TUint32 KInetAddrBroadcast        = INET_ADDR(255,255,255,255);
const TUint32 KInetAddrLoop             = INET_ADDR(127,0,0,1);
 
const TUint32 KInetAddrGroupUnspec      = INET_ADDR(224,0,0,0);
const TUint32 KInetAddrGroupAllHosts    = INET_ADDR(224,0,0,1);
const TUint32 KInetAddrLinkLocalNet     = INET_ADDR(169,254,0,0);
const TUint32 KInetAddrLinkLocalNetMask = INET_ADDR(255,255,0,0);
 
const TUint32 KInetAddrMaskAll          = INET_ADDR(0,0,0,0);
const TUint32 KInetAddrMaskHost         = INET_ADDR(255,255,255,255);
 
const TUint32 KInetAddrNetMaskA         = INET_ADDR(255,0,0,0);
const TUint32 KInetAddrHostMaskA        = ~KInetAddrNetMaskA;
const TInt KInetAddrShiftA              = 24;
const TUint32 KInetAddrNetMaskB         = INET_ADDR(255,255,0,0);
const TUint32 KInetAddrHostMaskB        = ~KInetAddrNetMaskB;
const TInt KInetAddrShiftB              = 16;
const TUint32 KInetAddrNetMaskC         = INET_ADDR(255,255,255,0);
const TUint32 KInetAddrHostMaskC        = ~KInetAddrNetMaskC;
const TInt KInetAddrShiftC              = 8;
 
const TUint32 KInetAddrIdMaskA          = 0x80000000;
const TUint32 KInetAddrIdValA           = 0x00000000;
const TUint32 KInetAddrIdMaskB          = 0xc0000000;
const TUint32 KInetAddrIdValB           = 0x80000000;
const TUint32 KInetAddrIdMaskC          = 0xe0000000;
const TUint32 KInetAddrIdValC           = 0xc0000000;
const TUint32 KInetAddrIdMaskD          = 0xf0000000;
const TUint32 KInetAddrIdValD           = 0xe0000000;
const TUint32 KInetAddrIdMaskE          = 0xf8000000;
const TUint32 KInetAddrIdValE           = 0xf0000000;
 
enum TInetAddrClass
    {
    EInetClassUnknown = 0,
    EInetClassA,
    EInetClassB,
    EInetClassC,
    EInetClassD,
    EInetClassE,
    EInetMulticast = EInetClassD,
    EInetExperimental = EInetClassE
    };
 
struct SInetAddr
    {
    TUint32 iAddr;
    };
 
 
class TIp6Addr
    {
public:
    IMPORT_C TBool IsUnicast() const;
    IMPORT_C TBool IsMulticast() const;
    IMPORT_C TBool IsLoopback() const;
    IMPORT_C TBool IsUnspecified() const;
    IMPORT_C TBool IsLinkLocal() const;
    IMPORT_C TBool IsSiteLocal() const;
    IMPORT_C TBool IsV4Compat() const;
    IMPORT_C TBool IsV4Mapped() const;
    IMPORT_C TBool IsEqual(const TIp6Addr &aAddr) const;
    IMPORT_C TInt Match(const TIp6Addr &aAddr) const;
    IMPORT_C TInt Scope() const;
    union
        {
        TUint8  iAddr8[16];
        TUint16 iAddr16[8];
        TUint32 iAddr32[4];
        } u;
    };
 
struct SInet6Addr
    {
    TIp6Addr iAddr;
    TUint32 iFlow;
    TUint32 iScope;
    };
 
const TInt KIp6AddrScopeNodeLocal = 0x01;
const TInt KIp6AddrScopeLinkLocal = 0x02;
const TInt KIp6AddrScopeSiteLocal = 0x05;
const TInt KIp6AddrScopeOrganization = 0x08;
const TInt KIp6AddrScopeGlobal = 0x0E;
const TInt KIp6AddrScopeNetwork = 0x10;
 
const TIp6Addr KInet6AddrNone = {{{0}}};
const TIp6Addr KInet6AddrLoop = {{{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1}}};
const TIp6Addr KInet6AddrLinkLocal = {{{0xfe, 0x80, }}};
 
class TInetAddr : public TSockAddr
    {
public:
    IMPORT_C TInetAddr();
    IMPORT_C TInetAddr(const TSockAddr& aAddr);
    IMPORT_C TInetAddr(TUint aPort);
    IMPORT_C TInetAddr(const TIp6Addr &aAddr, TUint aPort);
    IMPORT_C TInetAddr(TUint32 aAddr, TUint aPort);
    IMPORT_C void SetAddress(TUint32 aAddr);
    IMPORT_C void SetAddress(const TIp6Addr &aAddr);
    IMPORT_C void SetV4CompatAddress(TUint32 aAddr);
    IMPORT_C void SetV4MappedAddress(TUint32 aAddr);
    IMPORT_C void SetFlowLabel(TInt aLabel);
    IMPORT_C TInt FlowLabel() const;
    IMPORT_C const TIp6Addr &Ip6Address() const;
    IMPORT_C void ConvertToV4Compat();
    IMPORT_C void ConvertToV4Mapped();
    IMPORT_C void ConvertToV4();
    IMPORT_C TBool CmpAddr(const TInetAddr& aAddr) const;
    IMPORT_C TBool Match(const TInetAddr& aHost) const;
    IMPORT_C TBool Match(const TInetAddr& aNet, const TInetAddr& aMask) const;
    IMPORT_C TBool Match(const TInetAddr& aNet, TInt aPrefixLen) const;
    IMPORT_C void PrefixMask(TInt aPrefixLen);
    IMPORT_C void Prefix(const TInetAddr& aAddr, TInt aPrefixLen);
    IMPORT_C void Output(TDes &aBuf) const;
    IMPORT_C TInt Input(const TDesC &aBuf);
    inline static TInetAddr& Cast(const TSockAddr& aAddr);
    inline static TInetAddr& Cast(const TSockAddr* aAddr);
    
    IMPORT_C TBool IsUnicast() const;
    IMPORT_C TBool IsMulticast() const;
    IMPORT_C TBool IsLoopback() const;
    IMPORT_C TBool IsUnspecified() const;
    IMPORT_C TBool IsLinkLocal() const;
    IMPORT_C TBool IsSiteLocal() const;
    IMPORT_C TBool IsV4Compat() const;
    IMPORT_C TBool IsV4Mapped() const;
 
    IMPORT_C TUint32 Address() const;
    IMPORT_C void NetMask(const TInetAddr& aAddr);
    IMPORT_C void Net(const TInetAddr& aAddr);
    IMPORT_C void NetBroadcast(const TInetAddr& aAddr);
    IMPORT_C void SubNet(const TInetAddr& aAddr, const TInetAddr& aMask);
    IMPORT_C void SubNetBroadcast(const TInetAddr& aAddr, const TInetAddr& aMask);
 
    inline TBool IsClassA() const;
    inline TBool IsClassB() const;
    inline TBool IsClassC() const;
    inline TBool IsBroadcast() const;
    inline TBool IsWildAddr() const;
    inline TBool IsWildPort() const;
 
    IMPORT_C void SetScope(TUint32 aScope);
    IMPORT_C TUint32 Scope() const;
 
    IMPORT_C void Init(TUint aFamily);
    IMPORT_C void OutputWithScope(TDes &aBuf) const;
protected:
    inline SInetAddr *Addr4Ptr() const;
    inline SInet6Addr *AddrPtr() const;
    inline static TInt AddrLen();
private:
    TInt Ipv4Input(const TDesC& aDes);
    TInt Ipv6Input(const TDesC& aDes);
    };
 
inline SInet6Addr* TInetAddr::AddrPtr() const
    { return (SInet6Addr*)UserPtr(); }
 
inline TInt TInetAddr::AddrLen()
    { return sizeof(SInet6Addr); }
 
inline TInetAddr& TInetAddr::Cast(const TSockAddr& aAddr)
    { return *((TInetAddr*)&aAddr); }
 
inline TInetAddr& TInetAddr::Cast(const TSockAddr* aAddr)
    { return *((TInetAddr*)aAddr); }
 
inline SInetAddr* TInetAddr::Addr4Ptr() const
    { return (SInetAddr*)UserPtr(); }
 
inline TBool TInetAddr::IsBroadcast() const
    { return Address() == KInetAddrBroadcast; }
 
inline TBool TInetAddr::IsWildPort() const
    { return Port() == KInetPortNone; }
 
inline TBool TInetAddr::IsWildAddr() const
    { return IsUnspecified(); }
 
inline TBool TInetAddr::IsClassA() const
    {
        return (Family() == KAfInet || IsV4Mapped() || IsV4Compat()) && (Address() & KInetAddrIdMaskA) == KInetAddrIdValA;
    }
 
inline TBool TInetAddr::IsClassB() const
    { return (Address() & KInetAddrIdMaskB) == KInetAddrIdValB; }
 
inline TBool TInetAddr::IsClassC() const
    { return (Address() & KInetAddrIdMaskC) == KInetAddrIdValC; }
 
const TUint KIpDontFragment     = 0x010000;
const TUint KIpHeaderIncluded   = 0x020000;
const TUint KIpDontRoute        = 0x040000;
 
 
const TInt KSoInetEnumInterfaces = 0x211;
const TInt KSoInetNextInterface = 0x212;
 
const TInt KSoInetConfigInterface = 0x213;
const TUint KSoInetDeleteInterface = 0x214;
const TUint KSoInetChangeInterface = 0x215;
const TUint KSoInetResetInterface = 0x216;
const TUint KSoInetStartInterface = 0x217;
 
const TUint KSoInetCreateIPv4LLOnInterface = 0x226;
 
enum TIfStatus
    {
    EIfPending,
    EIfUp,
    EIfBusy,
    EIfDown
#ifdef SYMBIAN_TCPIPDHCP_UPDATE
    ,
    EIfNotConfigured
#endif //SYMBIAN_TCPIPDHCP_UPDATE
    };
 
class TSoInetInterfaceInfo
    {
public:
    TName iTag;
    TName iName;
    TIfStatus iState;
    TInt iMtu;
    TInt iSpeedMetric;
    TUint iFeatures;
    TSockAddr iHwAddr;
    TInetAddr iAddress;
    TInetAddr iNetMask;
    TInetAddr iBrdAddr;
    TInetAddr iDefGate;
    TInetAddr iNameSer1;
    TInetAddr iNameSer2;
    };
 
class TSoInet6InterfaceInfo : public TSoInetInterfaceInfo
    {
public:
    TUint iDelete:1;
    TUint iAlias:1;
    TUint iDoPrefix:1;
    TUint iDoId:1;
    TUint iDoState:1;
    TUint iDoAnycast:1;
    TUint iDoProxy:1;
    };
 
typedef TUint32 TInetScopeIds[16];
 
class TSoInetIfQuery
    {
public:
    TInetAddr iDstAddr;
    TInetAddr iSrcAddr;
    TUint32 iIndex;
    TName iName;
    TUint iIsUp:1;
    TInetScopeIds iZone;
    };
const TUint KSoInetIfQueryByDstAddr = 0x1;
const TUint KSoInetIfQueryBySrcAddr = 0x2;
const TUint KSoInetIfQueryByIndex   = 0x3;
const TUint KSoInetIfQueryByName    = 0x4;
 
 
const TInt KSoInetEnumRoutes  = 0x221;
const TInt KSoInetNextRoute   = 0x222;
const TInt KSoInetAddRoute    = 0x223;
const TInt KSoInetDeleteRoute = 0x224;
const TInt KSoInetChangeRoute = 0x225;
 
enum TRouteState
    {
    ERtNone,
    ERtPending,
    ERtBusy,
    ERtReady,
    ERtDown
    };
 
enum TRouteType
    {
    ERtNormal,
    ERtUser,
    ERtIcmpAdd,
    ERtIcmpDel
    };
 
class TLinkAddr : public TSockAddr
    {
public:
    IMPORT_C TLinkAddr();
    IMPORT_C void SetAddress(const TDesC8 &aAddr);
 
    IMPORT_C TPtrC8 Address() const;
 
    IMPORT_C const static TLinkAddr& Cast(const TSockAddr& aAddr);
    IMPORT_C static TLinkAddr& Cast(TSockAddr& aAddr);
    IMPORT_C const static TLinkAddr* Cast(const TSockAddr* aAddr);
    IMPORT_C static TLinkAddr* Cast(TSockAddr* aAddr);
 
    };
 
class TSoInetRouteInfo
    {
public:
    IMPORT_C TInt GetLinkAddr( TLinkAddr &aInfo ) const;
 
    TRouteType iType;
    TRouteState iState;
    TInt iMetric;
    TInetAddr iIfAddr;
    TInetAddr iGateway;
    TInetAddr iDstAddr;
    TInetAddr iNetMask;
    };
 
class TSoInetCachedRouteInfo : public TSoInetRouteInfo
    {
public:
    TInt iPathMtu;
    TUint iPathRtt;
    };
 
const TInt KSoInetCachedRouteByDest = 0x225;
 
 
 
enum TNameRecordFlags
    {
    EDnsAlias=0x00000001,
    EDnsAuthoritive=0x00000002,
    EDnsHostsFile=0x00000004,
    EDnsServer=0x00000008,
    EDnsHostName=0x00000010,
    EDnsCache=0x00000020,
    EDnsNoRoute=0x00000040
    };
 
const TUint KSoDnsCacheEnable = 0x600;
const TUint KSoDnsCacheFlush = 0x601;
#ifdef SYMBIAN_DNS_PUNYCODE
const TUint KSoDnsEnableIdn = 0x602;
#endif //SYMBIAN_DNS_PUNYCODE
 
const TUint KIoctlTcpNotifyDataSent = 0x300;
 
const TUint KSoTcpSendWinSize = 0x301;
const TUint KSoTcpRecvWinSize = 0x302;
const TUint KSoTcpMaxSegSize = 0x303;
const TUint KSoTcpNoDelay = 0x304;
const TUint KSoTcpKeepAlive = 0x305;
const TUint KSoTcpAsync2MslWait = 0x306;
const TUint KSoTcpSendBytesPending = 0x307;
const TUint KSoTcpReadBytesPending = 0x308;
const TUint KSoTcpListening = 0x309;
const TUint KSoTcpNumSockets = 0x310;
const TUint KSoTcpReadUrgentData = 0x311;
const TUint KSoTcpPeekUrgentData = 0x312;
const TUint KSoTcpRcvAtMark = 0x313;
const TUint KSoTcpNextSendUrgentData = 0x314;
const TUint KSoTcpOobInline = 0x315;
 
#ifdef SYMBIAN_ADAPTIVE_TCP_RECEIVE_WINDOW
const TUint KSoTcpMaxRecvWin = 0x316;
const TUint KSoTcpRecvWinAuto = 0x317;
 
#endif //SYMBIAN_ADAPTIVE_TCP_RECEIVE_WINDOW
 
 
const TUint KSOTcpDebugMode = 0x11110000;
 
const TUint KSoIpOptions = 0x401;
const TUint KSoRawMode = 0x402;
const TUint KSoHeaderIncluded = 0x403;
const TUint KSoIpTOS = 0x404;
const TUint KSoIpTTL = 0x405;
const TUint KSoReuseAddr = 0x406;
const TUint KSoNoInterfaceError = 0x407;
const TUint KSoUserSocket = 0x408;
const TUint KSoInterfaceIndex = 0x409;
const TUint KSoKeepInterfaceUp = 0x40a;
const TUint KSoNoSourceAddressSelect = 0x40b;
const TUint KSoInetLastError = 0x200;
const TUint KIoctlInetLastError = 0x200;
const TUint KSoIp6UnicastHops = 0x465;
const TUint KSoIp6MulticastIf = 0x46a;
const TUint KSoIp6MulticastHops = 0x46b;
const TUint KSoIp6MulticastLoop = 0x46c;
const TUint KSoIp6JoinGroup = 0x46d;
const TUint KSoIp6LeaveGroup = 0x46e;
const TUint KSoIp6InterfaceUnicastHops = 0x46f;
 
 
class TSoInetLastErr
    {
public:
    TInt iStatus;
    TInt iErrType;
    TInt iErrCode;
    TInetAddr iSrcAddr;
    TInetAddr iDstAddr;
    TInetAddr iErrAddr;
    };
 
class TIp6Mreq
    {
public:
    TIp6Addr iAddr;
    TUint iInterface;
    };
 
const TUint KSoUdpReceiveICMPError = 0x500;
 
const TUint KSoUdpAddressSet = 0x502;
 
const TUint KSoUdpSynchronousSend = 0x560;
 
const TUint KSoFlowClosing = 0x600 | KSocketInternalOptionBit;
 
const TInt KErrNetUnreach = -190;
const TInt KErrHostUnreach = -191;
const TInt KErrNoProtocolOpt = -192;
const TInt KErrUrgentData = -193;
 
#endif