TIrdaSockAddr Class Reference

#include <ir_sock.h>

Link against: irda.lib

class TIrdaSockAddr : public TSockAddr
Public Member Functions
TIrdaSockAddr()
TIrdaSockAddr(const TSockAddr &)
IMPORT_C TIrdaSockAddr &Cast(const TSockAddr &)
IMPORT_C TIrdaSockAddr &Cast(const TSockAddr *)
IMPORT_C TUint8GetCharacterSet()
IMPORT_C TUint8GetFirstServiceHintByte()
IMPORT_C TUint8GetHomePort()
IMPORT_C TUintGetHostDevAddr()
IMPORT_C TUint8GetIrlapVersion()
IMPORT_C TUintGetRemoteDevAddr()
IMPORT_C TUint8GetRemotePort()
IMPORT_C TUint8GetSecondServiceHintByte()
IMPORT_C TUint8GetServiceHintByteCount()
IMPORT_C TBoolGetSniffStatus()
IMPORT_C TBoolGetSolicitedStatus()
IMPORT_C voidSetCharacterSet(const TUint8)
IMPORT_C voidSetFirstServiceHintByte(const TUint8)
IMPORT_C voidSetHomePort(const TUint8)
IMPORT_C voidSetHostDevAddr(const TUint)
IMPORT_C voidSetIrlapVersion(const TUint8)
IMPORT_C voidSetRemoteDevAddr(const TUint)
IMPORT_C voidSetRemotePort(const TUint8)
IMPORT_C voidSetSecondServiceHintByte(const TUint8)
IMPORT_C voidSetServiceHintByteCount(const TUint8)
IMPORT_C voidSetSniffStatus(const TBool)
IMPORT_C voidSetSolicitedStatus(const TBool)
Inherited Attributes
TBuf8< KMaxSockAddrSize >::iBuf
TDes8::__DECLARE_TEST
TDes8::iMaxLength
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

Detailed Description

An IrDA socket address.

Constructor & Destructor Documentation

TIrdaSockAddr ( )

IMPORT_CTIrdaSockAddr()

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

TIrdaSockAddr ( const TSockAddr & )

IMPORT_CTIrdaSockAddr(const TSockAddr &aAddr)

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

Parameters
aAddrA socket address assumed to be valid IrDA socket address.

Member Function 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
aAddrA pointer to a general socket address.
Return Value
The socket address returned as a reference to an IrDA socket address. Casts a pointer to a general socket address into an IrDA socket address.The socket address returned as a reference to an IrDA 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
aAddrA pointer to a general socket address.
Return Value
The socket address returned as a reference to an IrDA socket address. Casts a pointer to a general socket address into an IrDA socket address.The socket address returned as a reference to an IrDA socket address.

GetCharacterSet ( )

IMPORT_C TUint8GetCharacterSet()const

Returns the character set supported by the remote device.

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

GetFirstServiceHintByte ( )

IMPORT_C TUint8GetFirstServiceHintByte()const

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

Return Value
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

GetHomePort ( )

IMPORT_C TUint8GetHomePort()const

GetHostDevAddr ( )

IMPORT_C TUintGetHostDevAddr()const

Returns the host device address.

Return Value
The host device address as a 32 bit value.

GetIrlapVersion ( )

IMPORT_C TUint8GetIrlapVersion()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.

Return Value
The device's IrLAP version number.

GetRemoteDevAddr ( )

IMPORT_C TUintGetRemoteDevAddr()const

Returns the remote device address.

Return Value
The remote device address as a 32 bit value.

GetRemotePort ( )

IMPORT_C TUint8GetRemotePort()const

GetSecondServiceHintByte ( )

IMPORT_C TUint8GetSecondServiceHintByte()const

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

Return Value
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

GetServiceHintByteCount ( )

IMPORT_C TUint8GetServiceHintByteCount()const

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

Return Value
The number of service hint bytes.

GetSniffStatus ( )

IMPORT_C TBoolGetSniffStatus()const

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

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

GetSolicitedStatus ( )

IMPORT_C TBoolGetSolicitedStatus()const

Returns the solicited status.

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

Return Value
True, if the discovery was initiated by the host device; false if the discovery was initiated by the remote device.

SetCharacterSet ( const TUint8 )

IMPORT_C voidSetCharacterSet(const TUint8aCharacterSet)

Sets the character set supported by the remote device.

Parameters
aCharacterSetOne of the TIASCharSet enumerator values defining the character set supported by the device

SetFirstServiceHintByte ( const TUint8 )

IMPORT_C voidSetFirstServiceHintByte(const TUint8aFirstServiceHintByte)

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
aFirstServiceHintByteThe 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 voidSetHomePort(const TUint8aHomePort)

SetHostDevAddr ( const TUint )

IMPORT_C voidSetHostDevAddr(const TUintaHost)

Sets the host device address.

Parameters
aHostThe host device address as a 32-bit value.

SetIrlapVersion ( const TUint8 )

IMPORT_C voidSetIrlapVersion(const TUint8aIrlapVersion)

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
aIrlapVersionThe device's IrLAP version number.

SetRemoteDevAddr ( const TUint )

IMPORT_C voidSetRemoteDevAddr(const TUintaRemote)

Sets the remote device address.

Parameters
aRemoteThe remote device address as a 32-bit value.

SetRemotePort ( const TUint8 )

IMPORT_C voidSetRemotePort(const TUint8aRemotePort)

SetSecondServiceHintByte ( const TUint8 )

IMPORT_C voidSetSecondServiceHintByte(const TUint8aSecondServiceHintByte)

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
aSecondServiceHintByteThe 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 voidSetServiceHintByteCount(const TUint8aServiceHintByteCount)

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

Parameters
aServiceHintByteCountThe number of service hint bytes.

SetSniffStatus ( const TBool )

IMPORT_C voidSetSniffStatus(const TBoolaSniff)

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

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

SetSolicitedStatus ( const TBool )

IMPORT_C voidSetSolicitedStatus(const TBoolaSolicited)

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

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