Class CImTextServerSession

class CImTextServerSession : public CMsgActive;

Description

Creates/opens socket and sends and receives data.

Derivation

• CMsgActive - No description.

• CImTextServerSession - Creates/opens socket and sends and receives data.

Members

Defined in CImTextServerSession:

• Disconnect()Intended Usage : To disconnect and close socket connection. Error Condition : No...
• Disconnect(TRequestStatus &)
• DoCancel()Implements cancellation of an outstanding request.
• DoComplete(TInt &)
• DoRunL()
• EImClientMode
• EImServerMode
• GetConnectionStage()Intended Usage : Gets the stage of the connection process obtained from RConnect...
• GetCurrentTextLine(TDes8 &)Returns first full line of data received from socket to user Intended Usage : To...
• GetIAPBearer(TUint32 &)Returns the bearer type we are connected to with in aBearer or returns an error ...
• GetIAPValue(TUint32 &)Intended Usage : Returns the IAP we are connecting/connected with in aIAP or ret...
• GetRConnectionName(TName &)Intended Usage : Returns the name of the RConnection.
• LocalName()
• LogError(const TDesC8 &,const TInt)
• LogText(const TDesC8 &)
• NewL()cat Construction Intended Usage : Static factory constructor. Uses two phase con...
• NewL(RSocketServ &)
• NewL(TInt,TInt)cat Construction Intended Usage : Static factory constructor. Uses two phase con...
• NewLC(TImOperationMode,RSocketServ &)
• PerformLogging(TBool)
• QueueConnect(TRequestStatus &,const TDesC &,TInt,TBool)
• QueueConnect(TRequestStatus &,const TDesC &,TInt,TCallBack,TBool)
• QueueConnect(TRequestStatus &,const TDesC &,TInt,TCallBack,const CImIAPPreferences &,TInt,TBool)
• QueueConnect(TRequestStatus &,const TDesC &,TInt,TCallBack,const TUint32,TInt,TBool)
• QueueConnect(TRequestStatus &,const TDesC &,TInt,const CImIAPPreferences &,TInt,TBool)
• QueueConnect(TRequestStatus &,const TDesC &,TInt,const TUint32,TInt,TBool)
• QueueConnectL(TRequestStatus &,const TDesC &,TInt,const CImIAPPreferences &,TBool)Intended Usage : Queue a connect assuming the socket is successfully opened. Err...
• QueueConnectL(TRequestStatus &,const TDesC &,TInt,const CImIAPPreferences &,const TDesC8 &)Queue a connect on a socket assuming the socket is successfully opened.
• QueueReceiveNextTextLine(TRequestStatus &)...
• Receive(TDes8 &)
• Receive(TRequestStatus &,TDes8 &)
• ReceiveBinaryData(TRequestStatus &,TDes8 &,TInt)Intended Usage : Users queue a request for received data Error Condition : None
• SSLQueueConnectL(TRequestStatus &,const TDesC &,TInt,const CImIAPPreferences &,TBool)Intended Usage : Queue a wrapped SSL connect on an socket assuming the socket is...
• SSLQueueConnectL(TRequestStatus &,const TDesC &,TInt,const CImIAPPreferences &,const TDesC8 &)Queue a wrapped SSL connect on a socket assuming the socket is successfully open...
• Send(TRefByValue< const TDesC8 >,...)
• Send(TRequestStatus &,TRefByValue< const TDesC8 >,...)
• Send(TRequestStatus &,const TDesC8 &)Intended Usage : To send data. Error Condition : None
• Send(const TDesC8 &)
• SendQueueReceive(TRequestStatus &,TRefByValue< const TDesC8 >,...)
• SendQueueReceive(TRequestStatus &,const TDesC8 &)Intended Usage : To send data and queue a receive. Error Condition : None
• SendQueueReceiveWithTimeout(TRequestStatus &,TInt,const TDesC8 &)
• SendReceive(const TDesC8 &)
• SendWithTimeout(TRequestStatus &,TInt,const TDesC8 &)
• SetPrimaryTextServerSession(CImTextServerSession *)
• SetSSLTLSResponseL(const TDesC8 &)This method should be called before Send/SendQueueReceive() TLS command is sent....
• SetSecurity(TBool,TBool)
• TImOperationMode

IMPORT_C static CImTextServerSession* NewL();

Pre-Condition

None

Description

cat Construction Intended Usage : Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack.

Post-Condition

A fully constructed and initialised CImTextServerSession object.

Return value

Leave codes

IMPORT_C static CImTextServerSession* NewL(TInt aSendIdleTime, TInt aReceiveIdleTime);

Pre-Condition

None

Description

cat Construction Intended Usage : Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack.

Post-Condition

A fully constructed and initialised CImTextServerSession object.

Parameters

Return value

Leave codes

IMPORT_C static CImTextServerSession* NewLC(TImOperationMode aMode, RSocketServ &aServerServ);

Description

Parameters

Return value

IMPORT_C static CImTextServerSession* NewL(RSocketServ &aServerServ);

Description

Parameters

Return value

IMPORT_C void QueueConnectL(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const CImIAPPreferences &aIAPPreferences, TBool aEnableTimeout=ETrue);

Pre-Condition

None

Description

Intended Usage : Queue a connect assuming the socket is successfully opened. Error Condition : KErrNoMemory

Post-Condition

connection is ready to send and receive data.

Parameters

IMPORT_C void QueueConnectL(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const CImIAPPreferences &aIAPPreferences, const TDesC8 &aSSLDomainName);

Pre-Condition

None

Description

Queue a connect on a socket assuming the socket is successfully opened.

Post-Condition

Connection is ready to send and receive data

Parameters

IMPORT_C void SSLQueueConnectL(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const CImIAPPreferences &aIAPPreferences, TBool aEnableTimeout=ETrue);

Pre-Condition

None

Description

Intended Usage : Queue a wrapped SSL connect on an socket assuming the socket is successfully opened. Error Condition : KErrNoMemory, EImskSocketOpen

Post-Condition

connection is ready to send and receive data.

Parameters

IMPORT_C void SSLQueueConnectL(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const CImIAPPreferences &aIAPPreferences, const TDesC8 &aSSLDomainName);

Pre-Condition

None

Description

Queue a wrapped SSL connect on a socket assuming the socket is successfully opened.

Post-Condition

Connection is ready to send and receive data

Parameters

IMPORT_C void Disconnect();

Pre-Condition

None

Description

Intended Usage : To disconnect and close socket connection. Error Condition : None

Post-Condition

connection is closed.

IMPORT_C void Disconnect(TRequestStatus &aStatus);

Description

Parameters

IMPORT_C const TDesC& LocalName();

Description

Return value

IMPORT_C void SetSSLTLSResponseL(const TDesC8 &aDesc);

Pre-Condition

aDesc cannot be zero length

Description

This method should be called before Send/SendQueueReceive() TLS command is sent. Intended Usage : To use for secure connection. Error Condition : KErrNoMemory

Post-Condition

iTLSResponse is filled with aDesc contents

Parameters

Leave codes

IMPORT_C void Send(TRequestStatus &aStatus, const TDesC8 &aDesc);

Description

Intended Usage : To send data. Error Condition : None

Post-Condition

None

Parameters

IMPORT_C void SendWithTimeout(TRequestStatus &aStatus, TInt aIdleTime, const TDesC8 &aDesc);

Description

Parameters

IMPORT_C void SendQueueReceiveWithTimeout(TRequestStatus &aStatus, TInt aIdleTime, const TDesC8 &aDesc);

Description

Parameters

IMPORT_C void Send(TRequestStatus &aStatus, TRefByValue< const TDesC8 > aFmt,...);

Description

Parameters

IMPORT_C void SendQueueReceive(TRequestStatus &aStatus, const TDesC8 &aDesc);

Description

Intended Usage : To send data and queue a receive. Error Condition : None

Post-Condition

Sends the data and queues a receive. GetCurrentTextLine should be called after this method to read received data

Parameters

IMPORT_C void SendQueueReceive(TRequestStatus &aStatus, TRefByValue< const TDesC8 > aFmt,...);

Description

Parameters

IMPORT_C TImLineType GetCurrentTextLine(TDes8 &aDesc);

Description

Returns first full line of data received from socket to user Intended Usage : To return received data. Error Condition : None

Post-Condition

returns the received buffer in the form of aDesc

Parameters

Return value

IMPORT_C void QueueReceiveNextTextLine(TRequestStatus &aStatus);

Description

User queues a new request from the socket (unless there's a full line of data in buffer then signal user and there's no need to make a receive request) Intended Usage : User queues a new request from the socket. Error Condition : None

Parameters

IMPORT_C void ReceiveBinaryData(TRequestStatus &aStatus, TDes8 &aDes, TInt aLen);

Description

Intended Usage : Users queue a request for received data Error Condition : None

Post-Condition

aDes will be filled with received data of aLen. ReceiveBinaryData should be called after Send.

Parameters

IMPORT_C void LogText(const TDesC8 &aString);

Description

Parameters

IMPORT_C void LogError(const TDesC8 &aString, const TInt aError);

Description

Parameters

IMPORT_C TInt GetIAPValue(TUint32 &aIAP);

Description

Intended Usage : Returns the IAP we are connecting/connected with in aIAP or returns an error code

Post-Condition

aIAP will be filled with current IAP connected.

Parameters

Return value

IMPORT_C TInt GetRConnectionName(TName &aName);

Description

Intended Usage : Returns the name of the RConnection.

Post-Condition

aName will be filled with current name of the RConnection.

Parameters

Return value

IMPORT_C TInt GetIAPBearer(TUint32 &aBearer);

Description

Returns the bearer type we are connected to with in aBearer or returns an error code

Parameters

Return value

IMPORT_C TInt GetConnectionStage();

Description

Intended Usage : Gets the stage of the connection process obtained from RConnection

Return value

IMPORT_C void SetPrimaryTextServerSession(CImTextServerSession *aPrimaryTextServerSession);

Description

Parameters

IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, TBool aEnableTimeout=ETrue);

Description

Parameters

IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const CImIAPPreferences &aIAPPreferences, TInt aType, TBool aEnableTimeout=ETrue);

Description

Parameters

IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, TCallBack aDisconnectFunction, const TUint32 aIntraddress, TInt aType, TBool aEnableTimeout=ETrue);

Description

Parameters

IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const TUint32 aIAPaddress, TInt aType, TBool aEnableTimeout=ETrue);

Description

Parameters

IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, TCallBack aDisconnectFunction, TBool aEnableTimeout=ETrue);

Description

Parameters

IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, TCallBack aDisconnectFunction, const CImIAPPreferences &aIAPPreferences, TInt aType, TBool aEnableTimeout=ETrue);

Description

Parameters

IMPORT_C TInt Send(const TDesC8 &aDesc);

Description

Parameters

Return value

IMPORT_C TInt Send(TRefByValue< const TDesC8 > aFmt,...);

Description

Parameters

Return value

IMPORT_C TInt SendReceive(const TDesC8 &aDesc);

Description

Parameters

Return value

IMPORT_C TInt Receive(TDes8 &rDes);

Description

Parameters

Return value

IMPORT_C void Receive(TRequestStatus &aStatus, TDes8 &rDes);

Description

Parameters

IMPORT_C TInt SetSecurity(TBool aSecurityOn, TBool aUnattendedMode=0);

Description

Parameters

Return value

IMPORT_C void PerformLogging(TBool aLogging);

Description

Parameters

private: virtual void DoRunL();

Description

private: virtual void DoComplete(TInt &aStatusValue);

Description

Parameters

private: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's CActive::Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

CImTextServerSession::DoCancel() must not wait for event completion; this is handled by CActive::Cancel().

See also:

• CActive::Cancel()Cancels the wait for completion of an outstanding request.

TImOperationMode

Description