TLinkAddr Class Reference

#include <in_sock.h>

Inheritance diagram for TLinkAddr:

Public Member Functions
IMPORT_C	TLinkAddr ()
	Default constructor initialises the address to be zero-filled.
IMPORT_C void	SetAddress (const TDesC8 &aAddr)
	Assigns a string of octets as the address.
IMPORT_C TPtrC8	Address () const
	Returns the current stored address as a pointer to string of octets.
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.

Static Public Member Functions
IMPORT_C static const TLinkAddr &	Cast (const TSockAddr &aAddr)
	This function will cast the address to a TLinkAddr.
static IMPORT_C TLinkAddr &	Cast (TSockAddr &aAddr)
	This function will cast the address to a TLinkAddr.
IMPORT_C static const TLinkAddr *	Cast (const TSockAddr *aAddr)
	This function will cast the address to a TLinkAddr.
static IMPORT_C TLinkAddr *	Cast (TSockAddr *aAddr)
	This function will cast the address to a TLinkAddr.

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

  TLinkAddr

  Link layer address utility.

  Lightweight helper class for handling link layer addresses.

  This class is mainly used to obtain direct access to the raw address
  bytes which are inacessible from the TSockAddr interface.

  A link layer address is a binary string of octets.

  The address family of the TLinkAddr is determined by the interface. If
  the interface uses link layer addresses, it must support the
  #KSoIfHardwareAddr control option, and the returned address family of the
  harware address is supposed to represent the family of all link layer addresses
  of peers on the interface.

  Link layer addresses can be obtained from e.g. TSoInetRouteInfo structures
  using the TSoInetRouteInfo::GetLinkAddr function.  Note: this may fail if the
  link layer address of the peer corresponding to the route is not known.

API status

Published to all clients. Released API.

Definition at line 1393 of file in_sock.h.

Constructor & Destructor Documentation

TLinkAddr()

IMPORT_C TLinkAddr::TLinkAddr

(

)

Default constructor initialises the address to be zero-filled.

(generated from Symbian Developer Library)

Member Function Documentation

Address()

IMPORT_C TPtrC8 TLinkAddr::Address

(

)

const

Returns the current stored address as a pointer to string of octets.

(generated from Symbian Developer Library)

Cast() [1/4]

IMPORT_C static const TLinkAddr & TLinkAddr::Cast ( const TSockAddr &  aAddr )

static

This function will cast the address to a TLinkAddr.

This function has no way of verifying that the source address is actually a link layer address and should not be passed an IP address.

(generated from Symbian Developer Library)

Cast() [2/4]

IMPORT_C static const TLinkAddr * TLinkAddr::Cast ( const TSockAddr *  aAddr )

static

This function will cast the address to a TLinkAddr.

This function has no way of verifying that the source address is actually a link layer address and should . * not be passed an IP address.

(generated from Symbian Developer Library)

Cast() [3/4]

static IMPORT_C TLinkAddr & TLinkAddr::Cast ( TSockAddr &  aAddr )

static

This function will cast the address to a TLinkAddr.

This function has no way of verifying that the source address is actually a link layer address and should not be passed an IP address.

(generated from Symbian Developer Library)

Cast() [4/4]

static IMPORT_C TLinkAddr * TLinkAddr::Cast ( TSockAddr *  aAddr )

static

This function will cast the address to a TLinkAddr.

This function has no way of verifying that the source address is actually a link layer address and should . * not be passed an IP address.

(generated from Symbian Developer Library)

SetAddress()

IMPORT_C void TLinkAddr::SetAddress

(

const TDesC8 &

aAddr

)

Assigns a string of octets as the address.

Parameters

aAddr

The link layer address.

(generated from Symbian Developer Library)

---

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

• in_sock.h
• in_sock.h.dox