Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: ir_sock.h

IrDA constants

Support

Supported from 5.0

Description

A set of constants used by the IrDA Sockets API.

See also:


Protocol identifiers

Description

A list of constants that identify IrDA protocols.


KIrdaAddrFamily

const TUint KIrdaAddrFamily

Description

IrDA protocol family.


KIrmux

const TUint KIrmux

Description

IrMUX protocol within the IrDA protocol family.


KIrTinyTP

const TUint KIrTinyTP

Description

IrTinyTP protocol within the IrDA protocol family..

[Top]


Masks for service hint bytes

Description

A set of masks that identify specific bits within the service hint bytes. Service hint bytes indicate the level of IrLMP support provided by a device


KIrPnPMask

const TUint8 KIrPnPMask

Description

PnP support — first service hint byte.


KPalmtopMask

const TUint8 KPalmtopMask

Description

PDA/Palmtop — first service hint byte.


KComputerMask

const TUint8 KComputerMask

Description

Computer — first service hint byte.


KPrinterMask

const TUint8 KPrinterMask

Description

Printer — first service hint byte.


KModemMask

const TUint8 KModemMask

Description

IrModem — first service hint byte.


KFaxMask

const TUint8 KFaxMask

Support

Supported from 6.0

Description

Fax — first service hint byte.


KLANAccessMask

const TUint8 KLANAccessMask

Support

Supported from 6.0

Description

LAN Access — first service hint byte.


KExtensionMask

const TUint8 KExtensionMask

Description

Extension bit — first service hint byte.


KTelephonyMask

const TUint8 KTelephonyMask

Support

Supported from 6.0

Description

Telephony — second service hint byte.


KFileServerMask

const TUint8 KFileServerMask

Support

Supported from 6.0

Description

File Server — second service hint byte.


KIrCommMask

const TUint8 KIrCommMask

Description

IrCOMM support — second service hint byte.


KIrObexMask

const TUint8 KIrObexMask

Description

IrOBEX support — second service hint byte.

[Top]


IrDA Ioctls

Description

A set of constants used to specify an asynchronous control operation on a socket through RSocket::Ioctl().


command

Ioctl command

Description

Description


KDiscoveryIndicationIoctl

const TUint KDiscoveryIndicationIoctl

Description

Completes on receipt of a discovery indication.

Returns log entry in a TNameEntry.

Ioctl level : KIrdaAddrFamily


KExclusiveModeIoctl

const TUint KExclusiveModeIoctl

Description

Completes on successfully making RSocket EXCLUSIVE else returns error.

Completes successfully or returns KErrDisconnected if failed.

Ioctl level: KIrdaAddrFamily


KMultiplexModeIoctl

const TUint KMultiplexModeIoctl

Description

Completes on successfully making RSocket MULTIPLEXED else returns error.

Completes successfully or returns KErrDisconnected if failed.

Ioctl level: KIrdaAddrFamily


KIrmuxStatusRequestIoctl

const TUint KIrmuxStatusRequestIoctl

Description

Completes on doing a status request on IrMUX layer packets to send.

Returns TDes8* holding TUint indicating number of outstanding MUX data requests.

Ioctl level: KIrdaAddrFamily


KIrlapStatusRequestIoctl

const TUint KIrlapStatusRequestIoctl

Description

Completes on doing a status request on IrLAP layer packets to send.

Returns TDes8* holding TUint indicating the number of outstanding LAP data requests.

Ioctl level: KIrdaAddrFamily


KIdleRequestIoctl

const TUint KIdleRequestIoctl

Description

Completes on successfully putting RSocket into IDLE mode.

Completes successfully or returns KErrAbort if failed.

Ioctl level: KIrdaAddrFamily


KIdleClearRequestIoctl

const TUint KIdleClearRequestIoctl

Description

Completes on successfully taking RSocket out of IDLE mode.

Completes successfully or returns KErrAbort if failed.

Ioctl level: KIrdaAddrFamily


KDisconnectIndicationIoctl

const TUint KDisconnectIndicationIoctl

Description

Completes on receipt of an IrLAP disconnect indication.

Completes successfully on IrLAP or IrMUX disconnect on this connection.

Ioctl level: KIrdaAddrFamily


KIrlapStatusIndicationIoctl

const TUint KIrlapStatusIndicationIoctl

Description

Completes on doing a status request on IrLAP layer packets to send.

Returns TDes8* holding TUint indicating the number of outstanding LAP data requests.

Ioctl level: KIrdaAddrFamily


KIrmuxStatusIndicationIoctl

const TUint KIrmuxStatusIndicationIoctl

Description

Completes on receiving a status indication from IrLAP.

Returns TDes8* holding TUint indicating the number of outstanding MUX data requests.

Ioctl level: KIrdaAddrFamily


KIrlapResetRequestIoctl

const TUint KIrlapResetRequestIoctl

Description

Completes on doing an IrLAP link reset.

Does an SNRMP-UAF link reset which can be initiated from either primary or secondary.

Ioctl level: KIrdaAddrFamily


KIrlapResetIndicationIoctl

const TUint KIrlapResetIndicationIoctl

Description

Completes on receipt of an IrLAP link reset indication.

Completes with error value KErrNone if link is successfully reset.

Ioctl level: KIrdaAddrFamily


KIrlapDisconnectRequestIoctl

const TUint KIrlapDisconnectRequestIoctl

Description

Completes on doing an IrLAP link reset.

Does a DISCP-UAF link disconnect which can be initiated from either primary or secondary.

Ioctl level: KIrdaAddrFamily

[Top]


IrDA Options

Description

A list of currently supported IrDA options.

They are passed as the second parameter in calls toRSocket::SetOpt()andRSocket::GetOpt().


Option

Option

Description

Option level


KUnexpeditedDataOpt

const TUint KUnexpeditedDataOpt

Description

KLevelIrlap.

Sets transfer mode to be unexpedited (the default).

Not recommended for use with SetOpt(). Preferred use is withRSocket::Send()

Returns KErrNone


KExpeditedDataOpt

const TUint KExpeditedDataOpt

Description

KLevelIrlap

Sets transfer mode to be expedited (urgent).

Not recommended for use with SetOpt(). Preferred use is withRSocket::Send()

Returns KErrNone


KDiscoverySlotsOpt

const TUint KDiscoverySlotsOpt

Description

KLevelIrlap

Sets number of discovery slots.

Returns KErrNone


KUserBaudOpt

const TUint KUserBaudOpt

Description

KLevelIrlap

Sets the requested maximum link baud rate.

Returns KErrInUse, if the link is already running.

Returns with the currently set maximum link baud supported.


KHostMaxDataSizeOpt

const TUint KHostMaxDataSizeOpt

Description

KLevelIrlap

Sets the requested maximum data packet size that can be received by the host.

Returns KErrInUse, if the link is already running.

Returns with the currently set value for the maximum receivable data size of the host IrLAP layer.


KRemoteMaxDataSizeOpt

const TUint KRemoteMaxDataSizeOpt

Description

KLevelIrlap

Returns KErrNotSupported.

Cannot set this value for the remote station.

Returns with the currently set value for the maximum transmissible data size to remote IrLAP layer.


KHostMaxTATimeOpt

const TUint KHostMaxTATimeOpt

Description

KLevelIrlap

Set the maximum link turnaround time for the host IrLAP layer.

Returns KErrInUse, if the link is already running.

Returns with the currently set value for the host link turnaround time


KTinyTPLocalSegSizeOpt

const TUint KTinyTPLocalSegSizeOpt

Description

KLevelIrmux

Turns on transport layer segmentation with the segment size specified. This value is advertised to the remote machine as the maximum amount of data we can reassemble.

Returns KErrNone


KTinyTPRemoteSegSizeOpt

const TUint KTinyTPRemoteSegSizeOpt

Description

KLevelIrmux

Queries the remote machine’s segment size. The remote machine is unable to assemble more data than this.

Returns the remote machine’s segment size.


KFirstHintByteOpt

const TUint KFirstHintByteOpt

Description

KLevelIrlap

Sets the host's first service hint byte used in XID frames.

Retrieves the first hint byte.


KSecondHintByteOpt

const TUint KSecondHintByteOpt

Description

KLevelIrlap

Sets the host's second service hint byte used in XID frames.

Retrieves the second hint byte


KIrlapDisableResetOpt

const TUint KIrlapDisableResetOpt

Support

Supported from 5.1

Description

KLevelIrlap

Disables IrLAP level reset_check/wait states


KLocalBusyDetectedOpt

const TUint KLocalBusyDetectedOpt

Support

Supported from 5.1

Description

KLevelIrlap

Allows the client to set local busy in IrLAP.


KLocalBusyClearedOpt

const TUint KLocalBusyClearedOpt

Support

Supported from 5.1

Description

KLevelIrlap

Allows the client to clear local busy in IrLAP


KEnableMinTASpinLocksOpt

const TUint KEnableMinTASpinLocksOpt

Support

Supported from 5.1
Withdrawn in 6.0

Description

KLevelIrlap

Sets the IrLAP state machine into operating spin loops to guarantee minimum turnaround times to remote devices.

By default, looping is always OFF.


KDiscoveryResponseDisableOpt

KDiscoveryResponseDisableOpt

Support

Supported from 6.0

Description

KLevelIrlap

Disables discovery response for a short period (typically 3 seconds).

[Top]


Option levels for the IrDA options

Description

Option levels specify how an IrDA option should be interpreted.


KLevelIrlap

const TUint KLevelIrlap

Description

The option relates to IrLAP.


KLevelIrmux

const TUint KLevelIrmux

Description

The option relates to IrMUX.

[Top]


Maximum descriptor lengths

Description


KIASClassNameMax

const TUint KIASClassNameMax

Description

The maximum length of a class name in an IAS entry.


KIASAttributeNameMax

const TUint KIASAttributeNameMax

Description

The maximum length of an attribute in an IAS entry.


KMaxQueryStringLength

const TUint KMaxQueryStringLength

Description

The maximum length of aTIASQuerydescriptor.