Collapse all Symbian^3 Application Developer Library

TIrdaSockAddr Class Reference

class TIrdaSockAddr : public TSockAddr

An IrDA socket address.

Inherits from

TIrdaSockAddr
- TSockAddr
  - TBuf8< KMaxSockAddrSize >
    - TBufBase8
      - TDes8
        
        TDesC8

Nested Classes and Structures

TIrdaSockAddr::SIrdaAddr

Public Member Functions
	TIrdaSockAddr ()
	TIrdaSockAddr (const TSockAddr &)
IMPORT_C TIrdaSockAddr &	Cast (const TSockAddr &)
IMPORT_C TIrdaSockAddr &	Cast (const TSockAddr *)
IMPORT_C TUint8	GetCharacterSet ()
IMPORT_C TUint8	GetFirstServiceHintByte ()
IMPORT_C TUint8	GetHomePort ()
IMPORT_C TUint	GetHostDevAddr ()
IMPORT_C TUint8	GetIrlapVersion ()
IMPORT_C TUint	GetRemoteDevAddr ()
IMPORT_C TUint8	GetRemotePort ()
IMPORT_C TUint8	GetSecondServiceHintByte ()
IMPORT_C TUint8	GetServiceHintByteCount ()
IMPORT_C TBool	GetSniffStatus ()
IMPORT_C TBool	GetSolicitedStatus ()
IMPORT_C void	SetCharacterSet (const TUint8 )
IMPORT_C void	SetFirstServiceHintByte (const TUint8 )
IMPORT_C void	SetHomePort (const TUint8 )
IMPORT_C void	SetHostDevAddr (const TUint )
IMPORT_C void	SetIrlapVersion (const TUint8 )
IMPORT_C void	SetRemoteDevAddr (const TUint )
IMPORT_C void	SetRemotePort (const TUint8 )
IMPORT_C void	SetSecondServiceHintByte (const TUint8 )
IMPORT_C void	SetServiceHintByteCount (const TUint8 )
IMPORT_C void	SetSniffStatus (const TBool )
IMPORT_C void	SetSolicitedStatus (const TBool )

Private Member Functions
SIrdaAddr *	addrPtr ()

Inherited Functions
	TBuf8< KMaxSockAddrSize >::TBuf8()
	TBuf8< KMaxSockAddrSize >::TBuf8(TInt)
	TBuf8< KMaxSockAddrSize >::TBuf8(const TDesC8 &)
	TBuf8< KMaxSockAddrSize >::TBuf8(const TUint8 *)
	TBuf8< KMaxSockAddrSize >::operator=(const TBuf8< S > &)
	TBuf8< KMaxSockAddrSize >::operator=(const TDesC8 &)
	TBuf8< KMaxSockAddrSize >::operator=(const TUint8 *)
	TBufBase8::TBufBase8(TInt)
	TBufBase8::TBufBase8(TInt,TInt)
	TBufBase8::TBufBase8(const TDesC8 &,TInt)
	TBufBase8::TBufBase8(const TUint8 *,TInt)
	TDes8::Append(TChar)
	TDes8::Append(const TDesC16 &)
	TDes8::Append(const TDesC8 &)
	TDes8::Append(const TUint8 *,TInt)
	TDes8::AppendFill(TChar,TInt)
	TDes8::AppendFormat(TRefByValue< const TDesC8 >,...)
	TDes8::AppendFormat(TRefByValue< const TDesC8 >,TDes8Overflow *,...)
	TDes8::AppendFormatList(const TDesC8 &,VA_LIST,TDes8Overflow *)
	TDes8::AppendJustify(const TDesC8 &,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TDesC8 &,TInt,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TUint8 *,TInt,TAlign,TChar)
	TDes8::AppendJustify(const TUint8 *,TInt,TInt,TAlign,TChar)
	TDes8::AppendNum(TInt64)
	TDes8::AppendNum(TReal,const TRealFormat &)
	TDes8::AppendNum(TUint64,TRadix)
	TDes8::AppendNumFixedWidth(TUint,TRadix,TInt)
	TDes8::AppendNumFixedWidthUC(TUint,TRadix,TInt)
	TDes8::AppendNumUC(TUint64,TRadix)
	TDes8::Capitalize()
	TDes8::Collapse()
	TDes8::Collate()
	TDes8::Copy(const TDesC16 &)
	TDes8::Copy(const TDesC8 &)
	TDes8::Copy(const TUint8 *)
	TDes8::Copy(const TUint8 *,TInt)
	TDes8::CopyC(const TDesC8 &)
	TDes8::CopyCP(const TDesC8 &)
	TDes8::CopyF(const TDesC8 &)
	TDes8::CopyLC(const TDesC8 &)
	TDes8::CopyUC(const TDesC8 &)
	TDes8::Delete(TInt,TInt)
	TDes8::DoAppendNum(TUint64,TRadix,TUint,TInt)
	TDes8::DoPadAppendNum(TInt,TInt,const TUint8 *)
	TDes8::Expand()
	TDes8::Fill(TChar)
	TDes8::Fill(TChar,TInt)
	TDes8::FillZ()
	TDes8::FillZ(TInt)
	TDes8::Fold()
	TDes8::Format(TRefByValue< const TDesC8 >,...)
	TDes8::FormatList(const TDesC8 &,VA_LIST)
	TDes8::Insert(TInt,const TDesC8 &)
	TDes8::Justify(const TDesC8 &,TInt,TAlign,TChar)
	TDes8::LeftTPtr(TInt)const
	TDes8::LowerCase()
	TDes8::MaxLength()const
	TDes8::MaxSize()const
	TDes8::MidTPtr(TInt)const
	TDes8::MidTPtr(TInt,TInt)const
	TDes8::Num(TInt64)
	TDes8::Num(TReal,const TRealFormat &)
	TDes8::Num(TUint64,TRadix)
	TDes8::NumFixedWidth(TUint,TRadix,TInt)
	TDes8::NumFixedWidthUC(TUint,TRadix,TInt)
	TDes8::NumUC(TUint64,TRadix)
	TDes8::PtrZ()
	TDes8::Repeat(const TDesC8 &)
	TDes8::Repeat(const TUint8 *,TInt)
	TDes8::Replace(TInt,TInt,const TDesC8 &)
	TDes8::RightTPtr(TInt)const
	TDes8::SetLength(TInt)
	TDes8::SetMax()
	TDes8::Swap(TDes8 &)
	TDes8::TDes8()
	TDes8::TDes8(TInt,TInt,TInt)
	TDes8::Trim()
	TDes8::TrimAll()
	TDes8::TrimLeft()
	TDes8::TrimRight()
	TDes8::UpperCase()
	TDes8::WPtr()const
	TDes8::Zero()
	TDes8::ZeroTerminate()
	TDes8::operator+=(const TDesC8 &)
	TDes8::operator=(const TDes8 &)
	TDes8::operator[](TInt)
	TDes8::operator[](TInt)const
	TDesC8::Alloc()const
	TDesC8::AllocL()const
	TDesC8::AllocLC()const
	TDesC8::AtC(TInt)const
	TDesC8::Compare(const TDesC8 &)const
	TDesC8::CompareC(const TDesC8 &)const
	TDesC8::CompareF(const TDesC8 &)const
	TDesC8::DoSetLength(TInt)
	TDesC8::Find(const TDesC8 &)const
	TDesC8::Find(const TUint8 *,TInt)const
	TDesC8::FindC(const TDesC8 &)const
	TDesC8::FindC(const TUint8 *,TInt)const
	TDesC8::FindF(const TDesC8 &)const
	TDesC8::FindF(const TUint8 *,TInt)const
	TDesC8::Left(TInt)const
	TDesC8::Length()const
	TDesC8::Locate(TChar)const
	TDesC8::LocateF(TChar)const
	TDesC8::LocateReverse(TChar)const
	TDesC8::LocateReverseF(TChar)const
	TDesC8::Match(const TDesC8 &)const
	TDesC8::MatchC(const TDesC8 &)const
	TDesC8::MatchF(const TDesC8 &)const
	TDesC8::Mid(TInt)const
	TDesC8::Mid(TInt,TInt)const
	TDesC8::Ptr()const
	TDesC8::Right(TInt)const
	TDesC8::Size()const
	TDesC8::TDesC8()
	TDesC8::TDesC8(TInt,TInt)
	TDesC8::Type()const
	TDesC8::operator!=(const TDesC8 &)const
	TDesC8::operator<(const TDesC8 &)const
	TDesC8::operator<=(const TDesC8 &)const
	TDesC8::operator==(const TDesC8 &)const
	TDesC8::operator>(const TDesC8 &)const
	TDesC8::operator>=(const TDesC8 &)const
	TSockAddr::CmpPort(const TSockAddr &)const
	TSockAddr::Family()const
	TSockAddr::GetUserLen()
	TSockAddr::Port()const
	TSockAddr::SetFamily(TUint)
	TSockAddr::SetPort(TUint)
	TSockAddr::SetUserLen(TInt)
	TSockAddr::TSockAddr()
	TSockAddr::TSockAddr(TUint)
	TSockAddr::UserPtr()const

Inherited Attributes
	TBuf8< KMaxSockAddrSize >::iBuf
	TDes8::__DECLARE_TEST
	TDes8::iMaxLength

Constructor & Destructor Documentation

TIrdaSockAddr()

IMPORT_C

TIrdaSockAddr

(

)

Default constructor. Sets the protocol family to the value of the constant KIrdaAddrFamily.

TIrdaSockAddr(const TSockAddr &)

IMPORT_C

TIrdaSockAddr

(

const TSockAddr &

aAddr

)

Copy constructor. Assumes that the source address is an IrDA socket address.

Parameters

const TSockAddr & aAddr

A socket address assumed to be valid IrDA socket address.

Member Functions Documentation

Cast(const TSockAddr &)

IMPORT_C TIrdaSockAddr &

Cast

(

const TSockAddr &

aAddr

)

[static]

Casts a reference to a general socket address into an IrDA socket address.

Parameters

const TSockAddr & aAddr

A pointer to a general socket address.

Cast(const TSockAddr *)

IMPORT_C TIrdaSockAddr &

Cast

(

const TSockAddr *

aAddr

)

[static]

Casts a reference to a general socket address into an IrDA socket address.

Parameters

const TSockAddr * aAddr

A pointer to a general socket address.

GetCharacterSet()

IMPORT_C TUint8

GetCharacterSet

(

)

const

Returns the character set supported by the remote device.

GetFirstServiceHintByte()

IMPORT_C TUint8

GetFirstServiceHintByte

(

)

const

Returns the remote device's first service hint byte. Service hint bytes indicate the level of IrLMP support provided by the device.

GetHomePort()

IMPORT_C TUint8

GetHomePort

(

)

const

GetHostDevAddr()

IMPORT_C TUint

GetHostDevAddr

(

)

const

Returns the host device address.

GetIrlapVersion()

IMPORT_C TUint8

GetIrlapVersion

(

)

const

Returns the remote device's IrLAP version number.

This should be 0x00 indicating that the device conforms to the IrDA IrLAP 1.00 specification.

GetRemoteDevAddr()

IMPORT_C TUint

GetRemoteDevAddr

(

)

const

Returns the remote device address.

GetRemotePort()

IMPORT_C TUint8

GetRemotePort

(

)

const

GetSecondServiceHintByte()

IMPORT_C TUint8

GetSecondServiceHintByte

(

)

const

Returns the remote device's first service hint byte. Service hint bytes indicate the level of IrLMP support provided by the device.

GetServiceHintByteCount()

IMPORT_C TUint8

GetServiceHintByteCount

(

)

const

Returns the number of service hint bytes for the remote device.

GetSniffStatus()

IMPORT_C TBool

GetSniffStatus

(

)

const

Returns the remote device's sniff status, i.e. whether the device is capable of sniffing for IrDA devices.

GetSolicitedStatus()

IMPORT_C TBool

GetSolicitedStatus

(

)

const

Returns the solicited status.

The solicited status indicates whether a discovery was initiated by the host device or a remote device.

SetCharacterSet(const TUint8)

IMPORT_C void

SetCharacterSet

(

const TUint8

aCharacterSet

)

Sets the character set supported by the remote device.

Parameters

const TUint8 aCharacterSet

One of the TIASCharSet enumerator values defining the character set supported by the device

SetFirstServiceHintByte(const TUint8)

IMPORT_C void

SetFirstServiceHintByte

(

const TUint8

aFirstServiceHintByte

)

Sets the first service hint byte for the remote device. The service hint bytes indicate the level of IrLMP support provided by the device.

Parameters

const TUint8 aFirstServiceHintByte

The first service hint byte. The individual bits have the following meaning: Bit 0 (0x01) - PnP Compatible Bit 1 (0x02) - PDA/Palmtop Bit 2 (0x04) - Computer Bit 3 (0x08) - Printer Bit 4 (0x10) - Modem Bit 5 (0x20) - Fax Bit 6 (0x40) - LAN Access Bit 7 (0x80) - Extension

SetHomePort(const TUint8)

IMPORT_C void

SetHomePort

(

const TUint8

aHomePort

)

Parameters

const TUint8 aHomePort

SetHostDevAddr(const TUint)

IMPORT_C void

SetHostDevAddr

(

const TUint

aHost

)

Sets the host device address.

Parameters

const TUint aHost

The host device address as a 32-bit value.

SetIrlapVersion(const TUint8)

IMPORT_C void

SetIrlapVersion

(

const TUint8

aIrlapVersion

)

Sets the IrLAP version number for the remote device.

This should be 0x00 indicating that the device conforms to the IrDA IrLAP 1.00 specification.

Parameters

const TUint8 aIrlapVersion

The device's IrLAP version number.

SetRemoteDevAddr(const TUint)

IMPORT_C void

SetRemoteDevAddr

(

const TUint

aRemote

)

Sets the remote device address.

Parameters

const TUint aRemote

The remote device address as a 32-bit value.

SetRemotePort(const TUint8)

IMPORT_C void

SetRemotePort

(

const TUint8

aRemotePort

)

Parameters

const TUint8 aRemotePort

SetSecondServiceHintByte(const TUint8)

IMPORT_C void

SetSecondServiceHintByte

(

const TUint8

aSecondServiceHintByte

)

Sets the second service hint byte for the remote device. The service hint bytes indicate the level of IrLMP support provided by the device.

Parameters

const TUint8 aSecondServiceHintByte

The second service hint byte. The individual bits have the following meaning: Bit 0 (0x01) - Telephony Bit 1 (0x02) - File Server Bit 2 (0x04) - IrCOMM Bit 3 (0x08) - reserved Bit 4 (0x10) - reserved Bit 5 (0x20) - IrOBEX Bit 6 (0x40) - reserved Bit 7 (0x80) - Extension

SetServiceHintByteCount(const TUint8)

IMPORT_C void

SetServiceHintByteCount

(

const TUint8

aServiceHintByteCount

)

Sets the number of service hint bytes for the remote device.

Parameters

const TUint8 aServiceHintByteCount

The number of service hint bytes.

SetSniffStatus(const TBool)

IMPORT_C void

SetSniffStatus

(

const TBool

aSniff

)

Sets the sniff status for the remote device, i.e. whether the device is capable of sniffing for IrDA devices.

Parameters

const TBool aSniff

True, if the device is capable of sniffing for IrDA devices; false, otherwise.

SetSolicitedStatus(const TBool)

IMPORT_C void

SetSolicitedStatus

(

const TBool

aSolicited

)

Sets the solicited status. The solicited status indcates whether a discovery was initiated by the host device or a remote device.

Parameters

const TBool aSolicited

ETrue, if the discovery was initiated by the host device; EFalse, if discovery was initiated by the remote device.

addrPtr()

SIrdaAddr *

addrPtr

(

)

const [private]