Class CTranpSession

class CTranpSession : public CBase;

Description

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CTranpSession - Encapsulates the behaviour for sending a picture to a peer device and for receiv...

Members

Defined in CTranpSession:

• Abort()Aborts any transmission in progress.
• Config()constReturns the configuration parameters.
• Config(const TTranpConfig &)Sets the configuration parameters.
• Connect()Establishes a connection with a peer device. This function is called before send...
• Disconnect()Breaks the connection with a peer device. This function is called after sending ...
• EReqCommandsRequest how many commands can be executed in one SCEP session.
• EReqImageInfoRequest still-information from the peer, e.g. resolution and size.
• EReqStatusRequest information about the peer's battery status and free memory.
• Get(TTranpPicture &)Receives a picture from a peer device.
• NewL(MTranpNotification &)Constructs and returns a pointer to a new picture transmission session.
• Put(const TTranpPicture &)Sends a picture to a peer device.
• Query(TTranP)Requests information on the processing ability of the peer device. Typically, th...
• TTranPThe type of information required from a peer device.
• ~CTranpSession()Frees all resources owned by the object, prior to its destruction.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CTranpSession* NewL(MTranpNotification &aNotifier);

Description

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

Parameters

MTranpNotification &aNotifier An implementation of the picture transmission callback interface.

Return value

CTranpSession * A pointer to the new picture transmission session.

IMPORT_C ~CTranpSession();

Description

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

IMPORT_C void Connect();

Description

Establishes a connection with a peer device. This function is called before sending a picture.

The callback function CTranpSession::Connect() is called when the connection has been successfully established.

See also:

• MTranpNotification::Connected()This function is called when a peer device connects successfully to the host dev...

IMPORT_C void Disconnect();

Description

Breaks the connection with a peer device. This function is called after sending a picture.

The callback function Disconnected() is called when the connection has been broken.

See also:

• MTranpNotification::Connected()This function is called when a peer device connects successfully to the host dev...

IMPORT_C void Abort();

Description

Aborts any transmission in progress.

IMPORT_C void Query(TTranP aWhat);

Description

Requests information on the processing ability of the peer device. Typically, this is called before sending a picture to that peer device. The information is returned through the callback function QueryComplete().

Parameters

CTranpSession::TTranP aWhat The specific type of information required from the peer device.

See also:

• MTranpNotification::QueryComplete()This function is called when an operation querying the processing ability of a p...

IMPORT_C void Get(TTranpPicture &aPicture);

Description

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 CTranpSession::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.

Parameters

TTranpPicture &aPicture The picture object

See also:

• MTranpNotification::Connected()This function is called when a peer device connects successfully to the host dev...
• MTranpNotification::ProgressIndication(TInt)This function is called during the sending or receiving of picture data and indi...
• MTranpNotification::GetComplete()This function is called when the reception of picture data is complete.
• MTranpNotification::Disconnected()This function is called when a peer device disconnects or is disconnected from t...
• MTranpNotification::Error(TInt)This function is called when the connection with the peer device drops during pi...

IMPORT_C void Put(const TTranpPicture &aPicture);

Description

Sends a picture to a peer device.

The following sequence of events is expected:

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

Transmission of picture data is complete, resulting in a call to the GetComplete() 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.

Parameters

const TTranpPicture &aPicture The picture object

See also:

• MTranpNotification::ProgressIndication(TInt)This function is called during the sending or receiving of picture data and indi...
• MTranpNotification::GetComplete()This function is called when the reception of picture data is complete.
• MTranpNotification::Error(TInt)This function is called when the connection with the peer device drops during pi...

IMPORT_C void Config(const TTranpConfig &aConfig);

Description

Sets the configuration parameters.

Parameters

const TTranpConfig &aConfig The configuration parameters

IMPORT_C TTranpConfig Config() const;

Description

Returns the configuration parameters.

Return value

TTranpConfig The configuration parameters.

TTranP

Description

The type of information required from a peer device.

EReqImageInfo 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.