Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: obexconstants.h
Link against: obex.lib

Class TObexProtocolPolicy

class TObexProtocolPolicy;

Description

Contains information about OBEX packet sizing policy, defining the maximum buffer size for receive and transmit packets

Members

Defined in TObexProtocolPolicy:
ReceiveMtu(), SetReceiveMtu(), SetTransmitMtu(), TObexProtocolPolicy(), TransmitMtu(), Version()


Construction and destruction


TObexProtocolPolicy()

IMPORT_C TObexProtocolPolicy();

Description

Sets up class with default values

[Top]


Member functions


SetReceiveMtu()

IMPORT_C TInt SetReceiveMtu(TUint16 aReceiveMtu);

Description

Sets the maximum size of the receive packet buffer for the policy. For the IrDA transport, if the new receive buffer size is different to KObexPacketDefaultSize the receive packet size is set to equal the new buffer size. Otherwise the packet size is set to the protocol defined limit.

Parameters

TUint16 aReceiveMtu

The new buffer size

Return value

TInt

KErrNone on success. KErrArgument if the packet size is not supported


SetTransmitMtu()

IMPORT_C TInt SetTransmitMtu(TUint16 aTransmitMtu);

Description

Sets the maximum size of the transmit packet buffer for the policy

Parameters

TUint16 aTransmitMtu

The new buffer size

Return value

TInt

KErrNone on success. KErrArgument if the packet size is not supported


Version()

IMPORT_C TUint16 Version() const;

Description

Gets the version of the protocol policy format that this class supports

Return value

TUint16

Protocol policy version


ReceiveMtu()

IMPORT_C TUint16 ReceiveMtu() const;

Description

Gets the policy's receive packet buffer size

Return value

TUint16

Receive packet buffer size


TransmitMtu()

IMPORT_C TUint16 TransmitMtu() const;

Description

Gets the policy's transmit packet buffer size

Return value

TUint16

Transmit packet buffer size