This class specialises the generic socket server address class TSockAddr for the TCP/IP protocol family. More...

#include <in_sock.h>

Inheritance diagram for TInetAddr:

Public Member Functions
IMPORT_C	TInetAddr ()
	Constructs a basic TInetAddr object.

IMPORT_C	TInetAddr (const TSockAddr &aAddr)
	Constructs a TInetAddr from a TSockAddr.

IMPORT_C	TInetAddr (TUint aPort)
	Constructs a TInetAddr and initialises the port to the specified value, and the IP address is unspecified.

IMPORT_C	TInetAddr (const TIp6Addr &aAddr, TUint aPort)
	Constructs a TInetAddr and initialises the port to the specified value, and the IPv6 address to aAddr.

IMPORT_C	TInetAddr (TUint32 aAddr, TUint aPort)
	Constructs a TInetAddr and initialise the specified port value to aPort and the IP address to aAddr.

IMPORT_C void	SetAddress (TUint32 aAddr)
	Sets the IPv4 address value.

IMPORT_C void	SetAddress (const TIp6Addr &aAddr)
	Sets the IPv6 address value.

IMPORT_C void	SetV4CompatAddress (TUint32 aAddr)
	Creates an IPv4-compatible IPv6 address.

IMPORT_C void	SetV4MappedAddress (TUint32 aAddr)
	Creates an IPv4-mapped IPv6 address.

IMPORT_C void	SetFlowLabel (TInt aLabel)
	Sets the Flow Label.

IMPORT_C TInt	FlowLabel () const
	Gets the Flow Label.

IMPORT_C const TIp6Addr &	Ip6Address () const
	Gets the IPv6 address.

IMPORT_C void	ConvertToV4Compat ()
	Converts an IPv4 address to an IPv4-compatible IPv6 address.

IMPORT_C void	ConvertToV4Mapped ()
	Converts an IPv4 address to an IPv4-mapped IPv6 address.

IMPORT_C void	ConvertToV4 ()
	Converts an IPv4-mapped or IPv4-comptatible address to IPv4.

IMPORT_C TBool	CmpAddr (const TInetAddr &aAddr) const
	Compares IP address and port values with those in another TInetAddr.

IMPORT_C TBool	Match (const TInetAddr &aHost) const
	Tests the IP address value with that in another TInetAddr.

IMPORT_C TBool	Match (const TInetAddr &aNet, const TInetAddr &aMask) const
	Tests if another TInetAddr is in the same subnet.

IMPORT_C TBool	Match (const TInetAddr &aNet, TInt aPrefixLen) const
	Tests if the specified number of left-most bits on addresses are same.

IMPORT_C void	PrefixMask (TInt aPrefixLen)
	Creates an IPv6 address with the specified number of left-most bits set to 1, and the rest set to 0.

IMPORT_C void	Prefix (const TInetAddr &aAddr, TInt aPrefixLen)
	Creates an IPv6 address with the specified number of left-most bits copied from another address, and remaining bits set to 0.

IMPORT_C void	Output (TDes &aBuf) const
	Writes the IP address into a string.

IMPORT_C TInt	Input (const TDesC &aBuf)
	Sets the IP address from a string containing a representation of an IP address, such as might be entered in a dialog.

IMPORT_C TBool	IsUnicast () const
	Tests if address is unicast address.

IMPORT_C TBool	IsMulticast () const
	Tests if the IP address is a multicast address.

IMPORT_C TBool	IsLoopback () const
	Tests if the IP address is a loopback address.

IMPORT_C TBool	IsUnspecified () const
	Tests if the IP address is unspecified.

IMPORT_C TBool	IsLinkLocal () const
	Tests if IP address is link-local address.

IMPORT_C TBool	IsSiteLocal () const
	Tests if IP address is site-local address.

IMPORT_C TBool	IsV4Compat () const
	Tests if this address is an IPv4-compatible address.

IMPORT_C TBool	IsV4Mapped () const
	Tests if this address is an IPv4-mapped address.

IMPORT_C TUint32	Address () const
	Gets the IPv4 address value.

IMPORT_C void	NetMask (const TInetAddr &aAddr)
	Sets the IP address to a mask suitable for extracting the network number part of the IP address (deprecated).

IMPORT_C void	Net (const TInetAddr &aAddr)
	Obtains a network mask corresponding to the class of the IP address, using the NetMask() function, and then applies this mask to the current IP address (deprecated).

IMPORT_C void	NetBroadcast (const TInetAddr &aAddr)
	Sets the IP address to be suitable for a network-directed broadcast address (deprecated).

IMPORT_C void	SubNet (const TInetAddr &aAddr, const TInetAddr &aMask)
	Sets the IP address to the network number and subnet parts of the IP address (that is, the original IP address with the host number part cleared).

IMPORT_C void	SubNetBroadcast (const TInetAddr &aAddr, const TInetAddr &aMask)
	Sets the IP address to be suitable for a subnet-directed broadcast address.

IMPORT_C void	SetScope (TUint32 aScope)
	Sets the scope id value.

IMPORT_C TUint32	Scope () const
	Gets the scope id value.

IMPORT_C void	Init (TUint aFamily)
	Initialises the object properly according to the address family passed in.

IMPORT_C void	OutputWithScope (TDes &aBuf) const
	Writes the IP address into a string and appends the scope id.

Public Member Functions inherited from TSockAddr
IMPORT_C	TSockAddr ()
	Default constructor initialises the address to be zero-filled.

IMPORT_C	TSockAddr (TUint aFamily)
	Constructs the address with the family member data specified.

IMPORT_C TUint	Family () const
	Gets the address family and thereby the type of address.

IMPORT_C void	SetFamily (TUint aFamily)
	Sets the address family of an address.

IMPORT_C TUint	Port () const
	Gets the port value.

IMPORT_C void	SetPort (TUint aPort)
	Sets the address port of an address.

IMPORT_C TBool	CmpPort (const TSockAddr &anAddr) const
	Compare two ports.

IMPORT_C TInt	GetUserLen ()
	Gets the number of bytes a derived class has set beyond the SSockAddr part of the address.

IPv6 address constants..
Since 7.0
TBool	IsClassA () const
	Tests if the IP address is Class A.

TBool	IsClassB () const
	Tests if the IP address is Class B.

TBool	IsClassC () const
	Tests if the IP address is Class C.

TBool	IsBroadcast () const
	Tests if the IP address is a limited broadcast address (255.255.255.255).

TBool	IsWildAddr () const
	Tests if the IP address is unspecified.

TBool	IsWildPort () const
	Tests if the port is zero.

static TInetAddr &	Cast (const TSockAddr &aAddr)
	Casts a TSockAddr to a TInetAddr reference.

static TInetAddr &	Cast (const TSockAddr *aAddr)
	Casts a TSockAddr to a TInetAddr reference.

SInetAddr *	Addr4Ptr () const
	Returns a pointer to KAfInet content format

SInet6Addr *	AddrPtr () const
	Returns a pointer to KAfInet6 content format.

static TInt	AddrLen ()
	Returns the size of the KAfInet6 content format.

Additional Inherited Members
Protected Member Functions inherited from TSockAddr
IMPORT_C void	SetUserLen (TInt aLen)
	Sets the length of data it appends after the base class' data.

TUint8 *	UserPtr () const
	Gets an offset to place data after the base class data.

Detailed Description

This class specialises the generic socket server address class TSockAddr for the TCP/IP protocol family.

It represents an IP address and stores either an IPv4 or an IPv6 address in its buffer after the generic data defined by TSockAddr. The protocol family field provided by the TSockAddr base class can be set to KAfInet, KAfInet6 or KAFUnspec.

The address family defines the format of the stored address:

KAfInet is for plain 32 bits IPv4 address presented as SInetAddr structure.
KAfInet6 is for both IPv4 and IPv6 addresses (IPv4 addresses are in IPv4 mapped format). The content is presented as SInet6Addr structure, which includes the scope id and flow label, in addition to the 128 address bits.
KAFUnspec does not contain any addresses and works in most contexts as unspecified address, This is better than placing explicit IPv4 "0.0.0.0" or IPv6 "::", which in certain situations may limit the connections to either IPv4 or IPv6, but not both.

The flow label and scope id fields exist only in KAfInet6 format. However, the access functions TInetAddr::FlowLabel and TInetAddr::Scope will also work for other address formats by always returning 0.

Any function which sets or changes the address bits, will always reset the scope id and flow label to 0 (the TInetAddr::Init is always called internally). These are reasonable defaults, and normal application user does not normally need to worry about flow label or scope id.

When address is returned from the stack, it will often be in KAfInet6 format, and may contain non-zero values for flow label and scope id fields. When copying addresses, the full TInetAddr (or at least SInet6Addr) should be copied to preserve these fields.

Since: 7.0 The IPv4 only portion is backward compatible with older versions. In 7.0s some functions have additional features.

API status: Published to all clients. Released API.

Definition at line 395 of file in_sock.h.

Constructor & Destructor Documentation

◆ TInetAddr() [1/5]

IMPORT_C TInetAddr::TInetAddr ( )

Constructs a basic TInetAddr object.

The port is initialised to 0, and the IP address is unspecified. The resulting address family is KAFUnspec.

(generated from Original Symbian implementation)

◆ TInetAddr() [2/5]

IMPORT_C TInetAddr::TInetAddr ( const TSockAddr & aAddr )

Constructs a TInetAddr from a TSockAddr.

The port and IP address values are copied from aAddr. The resulting address family is same as that of aAddr.

The function does a raw copy operation of the TSockAddr. No checks are made at this point.

Parameters

aAddr TSockAddr to be used as initial content.

(generated from Original Symbian implementation)

◆ TInetAddr() [3/5]

IMPORT_C TInetAddr::TInetAddr ( TUint aPort )

Constructs a TInetAddr and initialises the port to the specified value, and the IP address is unspecified.

The resulting address family is KAFUnspec.

Parameters

aPort Value to which to set the port.

(generated from Original Symbian implementation)

◆ TInetAddr() [4/5]

IMPORT_C TInetAddr::TInetAddr	(	const TIp6Addr &	aAddr,
		TUint	aPort
	)

Constructs a TInetAddr and initialises the port to the specified value, and the IPv6 address to aAddr.

The resulting address family is KAfInet6.

Parameters

aAddr	Value to which to set the IPv6 address.
aPort	Value to which to set the port.

Since: 7.0

(generated from Original Symbian implementation)

◆ TInetAddr() [5/5]

IMPORT_C TInetAddr::TInetAddr	(	TUint32	aAddr,
		TUint	aPort
	)

Constructs a TInetAddr and initialise the specified port value to aPort and the IP address to aAddr.

The resulting address family is KAfInet

Parameters

aAddr	Value to which to set the IP address.
aPort	Value to which to set the port.

(generated from Original Symbian implementation)

Member Function Documentation

◆ Addr4Ptr()

SInetAddr * TInetAddr::Addr4Ptr ( ) const

inlineprotected

Returns a pointer to KAfInet content format

Definition at line 542 of file in_sock.h.

◆ Address()

IMPORT_C TUint32 TInetAddr::Address ( ) const

Gets the IPv4 address value.

If the stored address is not an IPv4 address, the returned value is ZERO.

This works also for IPv4 addresses which are stored in IPv4-mapped or IPv4-compatible format. (since 7.0).

Returns: The IP address value.

(generated from Original Symbian implementation)

◆ AddrLen()

TInt TInetAddr::AddrLen ( )

inlinestaticprotected

Returns the size of the KAfInet6 content format.

Definition at line 516 of file in_sock.h.

◆ AddrPtr()

SInet6Addr * TInetAddr::AddrPtr ( ) const

inlineprotected

Returns a pointer to KAfInet6 content format.

Definition at line 512 of file in_sock.h.

◆ Cast() [1/2]

TInetAddr & TInetAddr::Cast ( const TSockAddr & aAddr )

inlinestatic

Casts a TSockAddr to a TInetAddr reference.

The cast is only safe if the object being referenced is actually aTInetAddr.

Parameters

aAddr TSockAddr to cast

Returns: Casted reference to a TInetAddr.

Definition at line 520 of file in_sock.h.

◆ Cast() [2/2]

TInetAddr & TInetAddr::Cast ( const TSockAddr * aAddr )

inlinestatic

Casts a TSockAddr to a TInetAddr reference.

The cast is only safe if the object being referenced is actually aTInetAddr.

Parameters

aAddr TSockAddr to cast

Returns: Casted pointer to a TInetAddr.

Definition at line 531 of file in_sock.h.

◆ CmpAddr()

IMPORT_C TBool TInetAddr::CmpAddr ( const TInetAddr & aAddr ) const

Compares IP address and port values with those in another TInetAddr.

Parameters

aAddr TInetAddr with which to compare

Returns: ETrue if IP address and port values are the same; EFalse, otherwise.

(generated from Original Symbian implementation)

◆ ConvertToV4()

IMPORT_C void TInetAddr::ConvertToV4 ( )

Converts an IPv4-mapped or IPv4-comptatible address to IPv4.

The function assumes that the previous content is IPv4 address and accesses this using TInetAddr::Address() function. If the previous content was not IPv4 address (in any format), function acts as if the old content was 0.0.0.0.

The address family is set to KAfInet.

Since: 7.0

(generated from Original Symbian implementation)

◆ ConvertToV4Compat()

IMPORT_C void TInetAddr::ConvertToV4Compat ( )

Converts an IPv4 address to an IPv4-compatible IPv6 address.

The function assumes that the previous content is IPv4 address and accesses this using TInetAddr::Address() function. If the previous content was not IPv4 address (in any format), function acts as if the old content was 0.0.0.0.

The IPv4-compatible format is ::x.x.x.x.

The resulting address family is KAfInet6. The scope id and flow label are zeroed.

Deprecated:: This address format is deprecated and should not be used.

Since: 7.0

(generated from Original Symbian implementation)

◆ ConvertToV4Mapped()

IMPORT_C void TInetAddr::ConvertToV4Mapped ( )

Converts an IPv4 address to an IPv4-mapped IPv6 address.

The function assumes that the previous content is IPv4 address and accesses this using TInetAddr::Address() function. If the previous content was not IPv4 address (in any format), function acts as if the old content was "0.0.0.0".

The IPv4-mapped format is ::ffff:x.x.x.x. Internally, all IPv4 addresses are stored in this format.

The resulting address family is KAfInet6. The scope id and flow label are zeroed.

Since: 7.0

(generated from Original Symbian implementation)

◆ FlowLabel()

IMPORT_C TInt TInetAddr::FlowLabel ( ) const

Gets the Flow Label.

Only for KAfInet6, return zero for KAfInet.

Returns: The flow label

Since: 7.0

(generated from Original Symbian implementation)

◆ Init()

IMPORT_C void TInetAddr::Init ( TUint aFamily )

Initialises the object properly according to the address family passed in.

Parameters

aFamily

The address family. Valid values are

KAfInet, plain IPv4 address format
KAfInet6, combined IPv4 and IPv6 format, including fields for the scope id and flow label.
anything else, initialized to KAFUnspec, with empty content.

Postcondition: In all above cases, IsUnspecified() returns ETrue after this function.

Since: 7.0

(generated from Original Symbian implementation)

◆ Input()

IMPORT_C TInt TInetAddr::Input ( const TDesC & aBuf )

Sets the IP address from a string containing a representation of an IP address, such as might be entered in a dialog.

The string must contain an ASCII representation of the address. The format may be one of the following examples:

Four 8-bit decimal numbers separated by '.' (eg. 192.168.40.4)
Two 8-bit decimal numbers and a 16 bit decimal (eg. 192.168.10244)
One 8-bit decimal number and a 24-bit decimal (eg. 192.11020292)
One 32 decimal number (eg. 3232245764)
Eight 16-bit hex numbers separated by ':' (eg.2001:618:400:6a:0:0:0:abc)

Use at most one '::' to denote consecutive zeroes (eg. 2001:618:400:6a::abc), IPv4-compatible address (eg. ::192.168.40.4), and IPv4-mapped address (eg. ::ffff:192.168.40.4)

Any of the address notations above can be followed by "%scope-id" and the scope id of the TInetAddress is also set accordingly. If a dotted IPv4 address is associated with scope id, the address is stored as IPv4-mapped. If scope is not specified, the value defaults to zero. The flow label is set to zero.

The hexadecimal numbers may be either upper or lower case.

Parameters

aBuf	Descriptor containing a string representation of an IP address

Returns: KErrNone, if address syntax was correct and input succeeded; otherwise, one of the system-wide error codes.

Since: 7.0 (IPv6 support)

(generated from Original Symbian implementation)

◆ Ip6Address()

IMPORT_C const TIp6Addr & TInetAddr::Ip6Address ( ) const

Gets the IPv6 address.

Only for KAfInet6, undefined for KAfInet.

This function returns a reference to a location where IPv6 address would be stored. No check on family is made, and using this function for any other address family except KAfInet6 does not cause an error, but returned reference does not point to valid IPv6 address (unless content is converted to KAfInet6).

Returns: The IPv6 address

Since: 7.0

(generated from Original Symbian implementation)

◆ IsBroadcast()

TBool TInetAddr::IsBroadcast ( ) const

inline

Tests if the IP address is a limited broadcast address (255.255.255.255).

Returns: ETrue if the IPv4 address value is a limited broadcast address; otherwise, EFalse

Definition at line 546 of file in_sock.h.

◆ IsClassA()

TBool TInetAddr::IsClassA ( ) const

inline

Tests if the IP address is Class A.

Returns: ETrue if the IPv4 address value is Class A; otherwise, EFalse

Deprecated:: Works only for IPv4. It assumes the old IPv4 address classes (A, B, C). Applications using this function may not work properly in the current internet environment.

Definition at line 572 of file in_sock.h.

◆ IsClassB()

TBool TInetAddr::IsClassB ( ) const

inline

Tests if the IP address is Class B.

Returns: ETrue if the IPv4 address value is Class B; otherwise. EFalse

Deprecated:: Works only for IPv4. It assumes the old IPv4 address classes (A, B, C). Applications using this function may not work properly in the current internet environment.

Definition at line 586 of file in_sock.h.

◆ IsClassC()

TBool TInetAddr::IsClassC ( ) const

inline

Tests if the IP address is Class C.

Returns: ETrue if the IPv4 address value is Class C; otherwise, EFalse

Deprecated:: Works only for IPv4. It assumes the old IPv4 address classes (A, B, C). Applications using this function may not work properly in the current internet environment.

Definition at line 598 of file in_sock.h.

◆ IsLinkLocal()

IMPORT_C TBool TInetAddr::IsLinkLocal ( ) const

Tests if IP address is link-local address.

For IPv4 this returns true, if the address belongs to the link-local net (169.254.x.x).

For IPv6 this returns true, if the address is IPv6 link-local address (fe80:..).

Note: Does not return true for multicast addresses which are in the link-local scope.

Returns: ETrue, if this address is a link-local address; EFalse, otherwise

Since: 7.0

(generated from Original Symbian implementation)

◆ IsLoopback()

IMPORT_C TBool TInetAddr::IsLoopback ( ) const

Tests if the IP address is a loopback address.

For IPv4 addresses this returns true, if address belongs to the loopback net (127.x.x.x). IPv4 address can be in KAfInet or in IPv4-mapped/compatible formats.

For IPv6 address this returns true for IPv6 loopback address (= ::1).

Returns: ETrue, if the address is loopback; EFalse, otherwise

Since: 7.0

(generated from Original Symbian implementation)

◆ IsMulticast()

IMPORT_C TBool TInetAddr::IsMulticast ( ) const

Tests if the IP address is a multicast address.

For IPv4 addresses this returns true, if address is Class D (multicast). IPv4 address can be in KAfInet or KAfInet6 (IPv4-mapped or IPv4-compatible) formats.

For IPv6 addresses this returns true, if address is IPv6 multicast address (start with 0xff byte).

Returns: ETrue if the IP address value is multicast; EFalse, otherwise

Since: 7.0

(generated from Original Symbian implementation)

◆ IsSiteLocal()

IMPORT_C TBool TInetAddr::IsSiteLocal ( ) const

Tests if IP address is site-local address.

Always false for IPv4 addressess.

For IPv6 this returns true, if the address is IPv6 site-local address (fec0:...)

Note: Does not return true for multicast addresses which are in the site-local scope.

Returns: ETrue, if this is a site-local address; EFalse, otherwise

Since: 7.0

(generated from Original Symbian implementation)

◆ IsUnicast()

IMPORT_C TBool TInetAddr::IsUnicast ( ) const

Tests if address is unicast address.

This is just a "shorthand" notation for a test that none of the following is true

For exact semantics of IsUnicast, see the descriptions of the above functions.

Caution: the test is based purely on the address, and it should be kept in mind that this test has no way of detecting IPv4 net broadcast addresses (because the netmask is not known).

Returns: ETrue if the address is unicast: EFalse, otherwise

Since: 7.0

(generated from Original Symbian implementation)

◆ IsUnspecified()

IMPORT_C TBool TInetAddr::IsUnspecified ( ) const

Tests if the IP address is unspecified.

The address is unspecified if the

family is KAFUnspec
family is KAfInet6 and address is ::
family is KAfInet6 and address is IPv4-mapped 0.0.0.0
family is KAfInet and address is 0.0.0.0

Returns: ETrue if the IP address is unspecified; EFalse, otherwise

Since: 7.0

(generated from Original Symbian implementation)

◆ IsV4Compat()

IMPORT_C TBool TInetAddr::IsV4Compat ( ) const

Tests if this address is an IPv4-compatible address.

This is always false, if address is in KAfInet format.

Returns: ETrue, if this is a IPv4 compatible address; EFalse, otherwise.

Deprecated:: IPv4-compatible addresses should not be used.

Since: 7.0

(generated from Original Symbian implementation)

◆ IsV4Mapped()

IMPORT_C TBool TInetAddr::IsV4Mapped ( ) const

Tests if this address is an IPv4-mapped address.

This is always false, if address is in KAfInet format.

Returns: ETrue, if this address is an IPv4-mapped address; EFalse, otherwise.

Since: 7.0

(generated from Original Symbian implementation)

◆ IsWildAddr()

TBool TInetAddr::IsWildAddr ( ) const

inline

Tests if the IP address is unspecified.

This is same as IsUnspecified()

Returns: ETrue if the IP address value is unspecified; otherwise, EFalse.

Definition at line 562 of file in_sock.h.

◆ IsWildPort()

TBool TInetAddr::IsWildPort ( ) const

inline

Tests if the port is zero.

Returns: ETrue if the port is zero; otherwise, EFalse.

Definition at line 554 of file in_sock.h.

◆ Match() [1/3]

IMPORT_C TBool TInetAddr::Match ( const TInetAddr & aHost ) const

Tests the IP address value with that in another TInetAddr.

Note: The function matches IPv4 addresses even if they are stored in different formats (KAfInet or KAfInet6 using IPv4-mapped format) (since Symbian OS 7.0s).

Parameters

aHost TInetAddr with which to compare

Returns: ETrue if IP address value is the same as this, EFalse, otherwise.

(generated from Original Symbian implementation)

◆ Match() [2/3]

IMPORT_C TBool TInetAddr::Match	(	const TInetAddr &	aNet,
		const TInetAddr &	aMask
	)		const

Tests if another TInetAddr is in the same subnet.

The function applies the subnet mask passed through aMask to the IP address and to the IP address in aNet. If the resulting values are the same, this indicates that the addresses are part of the same subnet, and ETrue is returned.

Note: The function matches IPv4 addresses even if they are stored in different formats (KAfInet or KAfInet6 using IPv4-mapped format). (since Symbian OS 7.0s).

Parameters

aNet	TInetAddr with which to compare.
aMask	TInetAddr object with the IP address set to the relevant subnet mask.

Returns: ETrue if both IP address values are the members of the same subnet; EFalse, otherwise.

(generated from Original Symbian implementation)

◆ Match() [3/3]

IMPORT_C TBool TInetAddr::Match	(	const TInetAddr &	aNet,
		TInt	aPrefixLen
	)		const

Tests if the specified number of left-most bits on addresses are same.

Return ETrue if leftmost aPrefixLen bits on addresses are same (both families must be the same).

Parameters

aNet	TInetAddr with which to compare.
aPrefixLen	Number of left-most bits to compare.

Returns: ETrue, if the bits match; EFalse, otherwise.

Since: 7.0

(generated from Original Symbian implementation)

◆ Net()

IMPORT_C void TInetAddr::Net ( const TInetAddr & aAddr )

Obtains a network mask corresponding to the class of the IP address, using the NetMask() function, and then applies this mask to the current IP address (deprecated).

The resulting address family is KAfInet

Parameters

aAddr TInetAddr from which to obtain IP address for creating the network mask.

Deprecated:: Works only for IPv4. Prefix() should be used instead.

(generated from Original Symbian implementation)

◆ NetBroadcast()

IMPORT_C void TInetAddr::NetBroadcast ( const TInetAddr & aAddr )

Sets the IP address to be suitable for a network-directed broadcast address (deprecated).

The function obtains a network mask corresponding to the class of the IP address in aAddr, using the NetMask() function. It then applies this mask to the current IP address to separate the network number part of the address. The mask is then used again to set all host number bits to 1 (which signifies, broadcast to all hosts on the network).

The resulting address family is KAfInet

Parameters

aAddr TInetAddr from which to obtain IP address for creating the network mask.

Deprecated:

Works only for IPv4.

This function works only for IPv4. It assumes the old IPv4 address classes (A, B, C). Applications using this function may not work properly in the current internet environment.

(generated from Original Symbian implementation)

◆ NetMask()

IMPORT_C void TInetAddr::NetMask ( const TInetAddr & aAddr )

Sets the IP address to a mask suitable for extracting the network number part of the IP address (deprecated).

This function assumes the IPv4 address classes (A, B, C). Applications using this function may not work properly in the current internet environment.

The function tests whether the IP address in aAddr is a Class A, B, C, or other address. It then sets the IP address to suitable mask values as follows:

Class A addresses: mask 255.0.0.0
Class B addresses: mask 255.255.0.0
Class C addresses: mask 255.255.255.0
other addresses: mask 255.255.255.255

The resulting address family is KAfInet.

Parameters

aAddr TInetAddr from which to obtain IP address

Deprecated:: Works only for IPv4. The length of the network prefix needs to be aqcuired by other means. When prefix length is known, PrefixMask() function can be used.

(generated from Original Symbian implementation)

◆ Output()

IMPORT_C void TInetAddr::Output ( TDes & aBuf ) const

Writes the IP address into a string.

For an IPv4 address, the format is d.d.d.d, where "d" is an 8-bit decimal number. (An example IPv4 address: 127.0.0.1).

For an IPv6 address, the format is h:h:h:h:h:h:h:h, where "h" is a 16-bit hexadecimal number. (An example IPv6 address: 2001:618:40C:20:2C0:4FFF:FE24:AA79).

If address family is not KAfInet or KAfInet6, then empty string is returned (aBuf.Length() == 0).

If the family is KAfInet6, the output buffer must be at least 39 characters. If less, the buffer is filled with '*' characters.

Parameters

[out] aBuf contains a string representation of the IP address.

Since: 7.0 (IPv6 support)

(generated from Original Symbian implementation)

◆ OutputWithScope()

IMPORT_C void TInetAddr::OutputWithScope ( TDes & aBuf ) const

Writes the IP address into a string and appends the scope id.

The IP address is formatted with as with the standard Output.

If the scope id has non-zero value and if there is room in the output buffer, the scope id is appended to the address using the "%scope-id"-notation.

Parameters

[out] aBuf contains a string representation of the address.

Since: after 7.0s

(generated from Original Symbian implementation)

◆ Prefix()

IMPORT_C void TInetAddr::Prefix	(	const TInetAddr &	aAddr,
		TInt	aPrefixLen
	)

Creates an IPv6 address with the specified number of left-most bits copied from another address, and remaining bits set to 0.

The function does not check the family of the aAddr, and for anything else but KAfInet6 the resulting prefix value is undefined.

The resulting address family is KAfInet6. The scope id and flow label are zeroed.

Parameters

aAddr	The address to copy the prefix from.
aPrefixLen	Number of left-most bits to set to copy from aAddr.

Since: 7.0

(generated from Original Symbian implementation)

◆ PrefixMask()

IMPORT_C void TInetAddr::PrefixMask ( TInt aPrefixLen )

Creates an IPv6 address with the specified number of left-most bits set to 1, and the rest set to 0.

The previous content does not matter, and is overwritten.

Parameters

aPrefixLen Number of left-most bits to set to 1.

Since: 7.0

(generated from Original Symbian implementation)

◆ Scope()

IMPORT_C TUint32 TInetAddr::Scope ( ) const

Gets the scope id value.

Only for KAfInet6, return zero for KAfInet.

When an IPv4 address is stored in IPv4-mapped format (KAfInet6), then non-zero scopes are also possible for IPv4 (and needed for proper handling of overlapping private address ranges or for IPv4 link local addresses).

Returns: The scope id of the address.

Since: 7.0

(generated from Original Symbian implementation)

◆ SetAddress() [1/2]

IMPORT_C void TInetAddr::SetAddress ( const TIp6Addr & aAddr )

Sets the IPv6 address value.

The resulting address family is KAfInet6. The scope id and flow label are zeroed.

Parameters

aAddr Value to which to set the IPv6 address.

Since: 7.0

(generated from Original Symbian implementation)

◆ SetAddress() [2/2]

IMPORT_C void TInetAddr::SetAddress ( TUint32 aAddr )

Sets the IPv4 address value.

Note: An IP address in dotted-decimal form can be converted into a TUint32 by the INET_ADDR macro.

The resulting address family is KAfInet.

Parameters

aAddr Value to which to set the IPv4 address.

(generated from Original Symbian implementation)

◆ SetFlowLabel()

IMPORT_C void TInetAddr::SetFlowLabel ( TInt aLabel )

Sets the Flow Label.

Only for KAfInet6, undefined (ignored) for KAfInet.

Parameters

aLabel The flow label (only low 20 bits used)

Since: 7.0

(generated from Original Symbian implementation)

◆ SetScope()

IMPORT_C void TInetAddr::SetScope ( TUint32 aScope )

Sets the scope id value.

Only for KAfInet6, undefined (ignored) for KAfInet.

When an IPv4 address is stored in IPv4-mapped format (KAfInet6), then non-zero scopes are also possible for IPv4 (and needed for proper handling of overlapping private address ranges or for IPv4 link local addresses).

Parameters

aScope The scope id of the address.

Since: 7.0

(generated from Original Symbian implementation)

◆ SetV4CompatAddress()

IMPORT_C void TInetAddr::SetV4CompatAddress ( TUint32 aAddr )

Creates an IPv4-compatible IPv6 address.

The IPv4-compatible format is ::x.x.x.x.

The resulting address family is KAfInet6. The scope id and flow label are zeroed.

Parameters

aAddr IPv4 address from which the IPv6 address is generated.

Deprecated:: This address format is deprecated and should not be used.

Since: 7.0

(generated from Original Symbian implementation)

◆ SetV4MappedAddress()

IMPORT_C void TInetAddr::SetV4MappedAddress ( TUint32 aAddr )

Creates an IPv4-mapped IPv6 address.

The IPv4-mapped format is ::ffff:x.x.x.x. Internally, all IPv4 addresses are stored in this format.

The resulting address family is KAfInet6. The scope id and flow label are zeroed.

Parameters

aAddr IPv4 address from which the IPv6 address is generated.

Since: 7.0

(generated from Original Symbian implementation)

◆ SubNet()

IMPORT_C void TInetAddr::SubNet	(	const TInetAddr &	aAddr,
		const TInetAddr &	aMask
	)

Sets the IP address to the network number and subnet parts of the IP address (that is, the original IP address with the host number part cleared).

This is obtained by applying the mask value in aMask to the IP address in aAddr. The result is undefined if address and mask have different address family.

Parameters

aAddr	TInetAddr from which to obtain IP address
aMask	TInetAddr object with the IP address set to the relevant subnet mask.

(generated from Original Symbian implementation)

◆ SubNetBroadcast()

IMPORT_C void TInetAddr::SubNetBroadcast	(	const TInetAddr &	aAddr,
		const TInetAddr &	aMask
	)

Sets the IP address to be suitable for a subnet-directed broadcast address.

To achieve this, the subnet mask value in aMask is applied to the IP address in aAddr. The mask is then used again to set all host number bits to 1 (which signifies, broadcast to all hosts on the subnet).

Only for IPv4. The function does not have a sensible interpretation in IPv6. An application that uses this needs to code separate branches for IPv4 and IPv6 cases.

Parameters

aAddr	TInetAddr from which to obtain IP address
aMask	TInetAddr object with the IP address set to the relevant subnet mask.

Deprecated:: Works only for IPv4. IPv6 has all-nodes link local multicast address (ff02::1) for this purpose.

(generated from Original Symbian implementation)

The documentation for this class was generated from the following files:

Public Member Functions

IPv6 address constants..

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TInetAddr() [1/5]

◆ TInetAddr() [2/5]

◆ TInetAddr() [3/5]

◆ TInetAddr() [4/5]

◆ TInetAddr() [5/5]

Member Function Documentation

◆ Addr4Ptr()

◆ Address()

◆ AddrLen()

◆ AddrPtr()

◆ Cast() [1/2]

◆ Cast() [2/2]

◆ CmpAddr()

◆ ConvertToV4()

◆ ConvertToV4Compat()

◆ ConvertToV4Mapped()

◆ FlowLabel()

◆ Init()

◆ Input()

◆ Ip6Address()

◆ IsBroadcast()

◆ IsClassA()

◆ IsClassB()

◆ IsClassC()

◆ IsLinkLocal()

◆ IsLoopback()

◆ IsMulticast()

◆ IsSiteLocal()

◆ IsUnicast()

◆ IsUnspecified()

◆ IsV4Compat()

◆ IsV4Mapped()

◆ IsWildAddr()

◆ IsWildPort()

◆ Match() [1/3]

◆ Match() [2/3]

◆ Match() [3/3]

◆ Net()

◆ NetBroadcast()

◆ NetMask()

◆ Output()

◆ OutputWithScope()

◆ Prefix()

◆ PrefixMask()

◆ Scope()

◆ SetAddress() [1/2]

◆ SetAddress() [2/2]

◆ SetFlowLabel()

◆ SetScope()

◆ SetV4CompatAddress()

◆ SetV4MappedAddress()

◆ SubNet()

◆ SubNetBroadcast()