CTranpSession Class Reference

#include "tranp.h"

Link against: irtranp.lib

class CTranpSession : public CBase

Inherits from

  • CTranpSession
    Public Member Enumerations
    enumTTranP { EReqImageInfo, EReqStatus, EReqCommands }
    Public Member Functions
    ~CTranpSession()
    IMPORT_C voidAbort()
    IMPORT_C voidConfig(const TTranpConfig &)
    IMPORT_C TTranpConfigConfig()
    IMPORT_C voidConnect()
    IMPORT_C voidDisconnect()
    IMPORT_C voidGet(TTranpPicture &)
    IMPORT_C CTranpSession *NewL(MTranpNotification &)
    IMPORT_C voidPut(const TTranpPicture &)
    IMPORT_C voidQuery(TTranP)
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

    Encapsulates the behaviour for sending a picture to a peer device and for receiving a picture from a peer device.

    Member Enumeration Documentation

    Enum TTranP

    The type of information required from a peer device.

    EnumeratorValueDescription
    EReqImageInfo0

    Request still-information from the peer, e.g. resolution and size.

    EReqStatus

    Request information about the peer's battery status and free memory.

    EReqCommands

    Request how many commands can be executed in one SCEP session.

    Constructor & Destructor Documentation

    ~CTranpSession ( )

    IMPORT_C~CTranpSession()

    Frees all resources owned by the object, prior to its destruction.

    Member Function Documentation

    Abort ( )

    IMPORT_C voidAbort()

    Aborts any transmission in progress.

    Config ( const TTranpConfig & )

    IMPORT_C voidConfig(const TTranpConfig &aConfig)

    No Longer used.

    irda client libraries left in to avoid breaks

    Config ( )

    IMPORT_C TTranpConfigConfig()const

    No Longer used.

    irda client libraries left in to avoid breaks

    Connect ( )

    IMPORT_C voidConnect()

    No Longer used.

    irda client libraries left in to avoid breaks

    Disconnect ( )

    IMPORT_C voidDisconnect()

    No Longer used.

    irda client libraries left in to avoid breaks

    Get ( TTranpPicture & )

    IMPORT_C voidGet(TTranpPicture &aPicture)

    Receives a picture from a peer device.

    The following sequence of events is expected:

    A peer device connects successfully, resulting in a call to the Connect() callback function.

    The peer device sends picture data, resulting in successive calls to the ProgressIndication() callback function indicating how much of the picture data has been received.

    Reception of picture data is complete, resulting in a call to the GetComplete() call back function.

    Disconnection from the peer device, resulting in a call the Disconnected() callback function.

    If the connection with the peer device is dropped at any stage in the transmission, then this results in a call to the Error() callback function.

    See also: MTranpNotification::Connected() MTranpNotification::ProgressIndication() MTranpNotification::GetComplete() MTranpNotification::Disconnected() MTranpNotification::Error()

    ParameterDescription
    aPictureThe picture object

    NewL ( MTranpNotification & )

    IMPORT_C CTranpSession *NewL(MTranpNotification &aNotifier)[static]

    Constructs and returns a pointer to a new picture transmission session.

    ParameterDescription
    aNotifierAn implementation of the picture transmission callback interface.

    Returns: A pointer to the new picture transmission session.

    Put ( const TTranpPicture & )

    IMPORT_C voidPut(const TTranpPicture &aPicture)

    No Longer used.

    irda client libraries left in to avoid breaks

    Query ( TTranP )

    IMPORT_C voidQuery(TTranPaWhat)

    No Longer used.

    irda client libraries left in to avoid breaks

    © Nokia 2011.