#include <ir_sock.h>
| class TIrdaSockAddr : public TSockAddr |
| Inherited Attributes | |
|---|---|
| TBuf8< KMaxSockAddrSize >::iBuf | |
| TDes8::__DECLARE_TEST | |
| TDes8::iMaxLength | |
An IrDA socket address.
| IMPORT_C | TIrdaSockAddr | ( | ) |
Default constructor. Sets the protocol family to the value of the constant KIrdaAddrFamily.
| IMPORT_C | TIrdaSockAddr | ( | const TSockAddr & | aAddr | ) |
Copy constructor. Assumes that the source address is an IrDA socket address.
| Parameter | Description |
|---|---|
| aAddr | A socket address assumed to be valid IrDA socket address. |
| IMPORT_C TIrdaSockAddr & | Cast | ( | const TSockAddr & | aAddr | ) | [static] |
Casts a reference to a general socket address into an IrDA socket address.
| Parameter | Description |
|---|---|
| aAddr | A pointer to a general socket address. |
Returns: 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.
| IMPORT_C TIrdaSockAddr & | Cast | ( | const TSockAddr * | aAddr | ) | [static] |
Casts a reference to a general socket address into an IrDA socket address.
| Parameter | Description |
|---|---|
| aAddr | A pointer to a general socket address. |
Returns: 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.
| IMPORT_C TUint8 | GetCharacterSet | ( | ) | const |
Returns the character set supported by the remote device.
Returns: One of the TIASCharSet enumerator values defining the character set supported by the device.
| 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.
Returns: 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
| IMPORT_C TUint | GetHostDevAddr | ( | ) | const |
Returns the host device address.
Returns: The host device address as a 32 bit value.
| 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.
Returns: The device's IrLAP version number.
| IMPORT_C TUint | GetRemoteDevAddr | ( | ) | const |
Returns the remote device address.
Returns: The remote device address as a 32 bit value.
| 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.
Returns: 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
| IMPORT_C TUint8 | GetServiceHintByteCount | ( | ) | const |
Returns the number of service hint bytes for the remote device.
Returns: The number of service hint bytes.
| IMPORT_C TBool | GetSniffStatus | ( | ) | const |
Returns the remote device's sniff status, i.e. whether the device is capable of sniffing for IrDA devices.
Returns: True, if the device is capable of sniffing for IrDA devices; false, otherwise.
| 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.
Returns: True, if the discovery was initiated by the host device; false if the discovery was initiated by the remote device.
| IMPORT_C void | SetCharacterSet | ( | const TUint8 | aCharacterSet | ) |
Sets the character set supported by the remote device.
| Parameter | Description |
|---|---|
| aCharacterSet | One of the TIASCharSet enumerator values defining the character set supported by the device |
| 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.
| Parameter | Description |
|---|---|
| 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 |
| IMPORT_C void | SetHostDevAddr | ( | const TUint | aHost | ) |
Sets the host device address.
| Parameter | Description |
|---|---|
| aHost | The host device address as a 32-bit value. |
| 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.
| Parameter | Description |
|---|---|
| aIrlapVersion | The device's IrLAP version number. |
| IMPORT_C void | SetRemoteDevAddr | ( | const TUint | aRemote | ) |
Sets the remote device address.
| Parameter | Description |
|---|---|
| aRemote | The remote device address as a 32-bit value. |
| 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.
| Parameter | Description |
|---|---|
| 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 |
| IMPORT_C void | SetServiceHintByteCount | ( | const TUint8 | aServiceHintByteCount | ) |
Sets the number of service hint bytes for the remote device.
| Parameter | Description |
|---|---|
| aServiceHintByteCount | The number of service hint bytes. |
| 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.
| Parameter | Description |
|---|---|
| aSniff | True, if the device is capable of sniffing for IrDA devices; false, otherwise. |
| 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.
| Parameter | Description |
|---|---|
| aSolicited | ETrue, if the discovery was initiated by the host device; EFalse, if discovery was initiated by the remote device. |