Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <IR_SOCK.H>
Link against: irda.lib

Class TIrdaSockAddr

class TIrdaSockAddr : public TSockAddr;

Description

An IrDA socket address.

Derivation

Members

Defined in TIrdaSockAddr:

Construction and destruction

TIrdaSockAddr()

IMPORT_C TIrdaSockAddr();

Description

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

TIrdaSockAddr(const TSockAddr &)

IMPORT_C TIrdaSockAddr(const TSockAddr &aAddr);

Description

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.

[Top]

Member functions

Cast(const TSockAddr &)

IMPORT_C static TIrdaSockAddr& Cast(const TSockAddr &aAddr);

Description

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

Parameters

const TSockAddr &aAddr

A pointer to a general socket address.

Return value

TIrdaSockAddr &

The socket address returned as a reference to an IrDA socket address.

Cast(const TSockAddr *)

IMPORT_C static TIrdaSockAddr& Cast(const TSockAddr *aAddr);

Description

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

Parameters

const TSockAddr *aAddr

A pointer to a general socket address.

Return value

TIrdaSockAddr &

The socket address returned as a reference to an IrDA socket address.

GetRemoteDevAddr()const

IMPORT_C TUint GetRemoteDevAddr() const;

Description

Returns the remote device address.

Return value

TUint

The remote device address as a 32 bit value.

SetRemoteDevAddr(const TUint)

IMPORT_C void SetRemoteDevAddr(const TUint aRemote);

Description

Sets the remote device address.

Parameters

const TUint aRemote

The remote device address as a 32-bit value.

GetHostDevAddr()const

IMPORT_C TUint GetHostDevAddr() const;

Description

Returns the host device address.

Return value

TUint

The host device address as a 32 bit value.

SetHostDevAddr(const TUint)

IMPORT_C void SetHostDevAddr(const TUint aHost);

Description

Sets the host device address.

Parameters

const TUint aHost

The host device address as a 32-bit value.

GetSniffStatus()const

IMPORT_C TBool GetSniffStatus() const;

Description

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

Return value

TBool

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

SetSniffStatus(const TBool)

IMPORT_C void SetSniffStatus(const TBool aSniff);

Description

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.

GetSolicitedStatus()const

IMPORT_C TBool GetSolicitedStatus() const;

Description

Returns the solicited status.

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

Return value

TBool

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

SetSolicitedStatus(const TBool)

IMPORT_C void SetSolicitedStatus(const TBool aSolicited);

Description

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.

GetIrlapVersion()const

IMPORT_C TUint8 GetIrlapVersion() const;

Description

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

TUint8

The device's IrLAP version number.

SetIrlapVersion(const TUint8)

IMPORT_C void SetIrlapVersion(const TUint8 aIrlapVersion);

Description

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.

GetCharacterSet()const

IMPORT_C TUint8 GetCharacterSet() const;

Description

Returns the character set supported by the remote device.

Return value

TUint8

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

SetCharacterSet(const TUint8)

IMPORT_C void SetCharacterSet(const TUint8 aCharacterSet);

Description

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

GetFirstServiceHintByte()const

IMPORT_C TUint8 GetFirstServiceHintByte() const;

Description

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

Return value

TUint8

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)

SetFirstServiceHintByte(const TUint8)

IMPORT_C void SetFirstServiceHintByte(const TUint8 aFirstServiceHintByte);

Description

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

GetSecondServiceHintByte()const

IMPORT_C TUint8 GetSecondServiceHintByte() const;

Description

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

Return value

TUint8

The second service hint byte. The individual bits have the following meaning: Bit 0 (0x01) - Telephony Bit 1 (0x02) - File Server Bit 2 (0x04)

SetSecondServiceHintByte(const TUint8)

IMPORT_C void SetSecondServiceHintByte(const TUint8 aSecondServiceHintByte);

Description

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

GetServiceHintByteCount()const

IMPORT_C TUint8 GetServiceHintByteCount() const;

Description

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

Return value

TUint8

The number of service hint bytes.

SetServiceHintByteCount(const TUint8)

IMPORT_C void SetServiceHintByteCount(const TUint8 aServiceHintByteCount);

Description

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

Parameters

const TUint8 aServiceHintByteCount

The number of service hint bytes.

GetHomePort()const

IMPORT_C TUint8 GetHomePort() const;

Description

Return value

TUint8

SetHomePort(const TUint8)

IMPORT_C void SetHomePort(const TUint8 aHomePort);

Description

Parameters

const TUint8 aHomePort

GetRemotePort()const

IMPORT_C TUint8 GetRemotePort() const;

Description

Return value

TUint8

SetRemotePort(const TUint8)

IMPORT_C void SetRemotePort(const TUint8 aRemotePort);

Description

Parameters

const TUint8 aRemotePort

[Previous] [Top] [Next]