Location:
IMSK.H
Link against: imut.lib
class CImTextServerSession : public CMsgActive;
Creates/opens socket and sends and receives data.
CMsgActive
- No description.
CImTextServerSession
- Creates/opens socket and sends and receives data
Defined in CImTextServerSession
:
Disconnect()
, Disconnect()
, DoCancel()
, DoComplete()
, DoRunL()
, EImClientMode
, EImServerMode
, GetConnectionStage()
, GetCurrentTextLine()
, GetIAPBearer()
, GetIAPValue()
, GetRConnectionName()
, LocalName()
, LogError()
, LogText()
, NewL()
, NewL()
, NewL()
, NewLC()
, PerformLogging()
, QueueConnect()
, QueueConnect()
, QueueConnect()
, QueueConnect()
, QueueConnect()
, QueueConnect()
, QueueConnectL()
, QueueReceiveNextTextLine()
, Receive()
, Receive()
, ReceiveBinaryData()
, SSLQueueConnectL()
, Send()
, Send()
, Send()
, Send()
, SendQueueReceive()
, SendQueueReceive()
, SendQueueReceiveWithTimeout()
, SendReceive()
, SendWithTimeout()
, SetPrimaryTextServerSession()
, SetSSLTLSResponseL()
, SetSecurity()
, TImOperationMode
static IMPORT_C CImTextServerSession *NewL();
None
cat Construction Intended Usage : Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack
.
A fully constructed and initialised CImTextServerSession object.
|
|
static IMPORT_C CImTextServerSession *NewL(TInt aSendIdleTime, TInt aReceiveIdleTime);
None
cat Construction Intended Usage : Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack
.
A fully constructed and initialised CImTextServerSession object.
|
|
|
static IMPORT_C CImTextServerSession *NewLC(TImOperationMode aMode, RSocketServ &aServerServ);
|
|
static IMPORT_C CImTextServerSession *NewL(RSocketServ &aServerServ);
|
|
IMPORT_C void QueueConnectL(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const CImIAPPreferences &aIAPPreferences,
TBool aEnableTimeout=ETrue);
None
Intended Usage : Queue a connect assuming the socket is successfully opened. Error Condition : KErrNoMemory
connection is ready to send and receive data.
|
IMPORT_C void SSLQueueConnectL(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const CImIAPPreferences
&aIAPPreferences, TBool aEnableTimeout=ETrue);
None
Intended Usage : Queue a wrapped SSL connect on an socket assuming the socket is successfully opened. Error Condition : KErrNoMemory, EImskSocketOpen
connection is ready to send and receive data.
|
IMPORT_C void Disconnect();
None
Intended Usage : To disconnect and close socket connection. Error Condition : None
connection is closed.
IMPORT_C void SetSSLTLSResponseL(const TDesC8 &aDesc);
aDesc cannot be zero length
This method should be called before Send/SendQueueReceive() TLS command is sent. Intended Usage : To use for secure connection. Error Condition : KErrNoMemory
iTLSResponse is filled with aDesc contents
|
|
IMPORT_C void Send(TRequestStatus &aStatus, const TDesC8 &aDesc);
Intended Usage : To send data. Error Condition : None
None
|
IMPORT_C void SendWithTimeout(TRequestStatus &aStatus, TInt aIdleTime, const TDesC8 &aDesc);
|
IMPORT_C void SendQueueReceiveWithTimeout(TRequestStatus &aStatus, TInt aIdleTime, const TDesC8 &aDesc);
|
IMPORT_C void Send(TRequestStatus &aStatus, TRefByValue< const TDesC8 > aFmt,...);
|
IMPORT_C void SendQueueReceive(TRequestStatus &aStatus, const TDesC8 &aDesc);
Intended Usage : To send data and queue a receive. Error Condition : None
Sends the data and queues a receive. GetCurrentTextLine should be called after this method to read received data
|
IMPORT_C void SendQueueReceive(TRequestStatus &aStatus, TRefByValue< const TDesC8 > aFmt,...);
|
IMPORT_C TImLineType GetCurrentTextLine(TDes8 &aDesc);
Returns first full line of data received from socket to user Intended Usage : To return received data. Error Condition : None
returns the received buffer in the form of aDesc
|
|
IMPORT_C void QueueReceiveNextTextLine(TRequestStatus &aStatus);
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
|
IMPORT_C void ReceiveBinaryData(TRequestStatus &aStatus, TDes8 &aDes, TInt aLen);
Intended Usage : Users queue a request for received data Error Condition : None
aDes will be filled with received data of aLen. ReceiveBinaryData should be called after Send.
|
IMPORT_C void LogError(const TDesC8 &aString, const TInt aError);
|
IMPORT_C TInt GetIAPValue(TUint32 &aIAP);
Intended Usage : Returns the IAP we are connecting/connected with in aIAP or returns an error code
aIAP will be filled with current IAP connected.
|
|
IMPORT_C TInt GetRConnectionName(TName &aName);
Intended Usage : Returns the name of the RConnection
.
aName will be filled with current name of the RConnection
.
|
|
IMPORT_C TInt GetIAPBearer(TUint32 &aBearer);
Returns the bearer type we are connected to with in aBearer or returns an error code
|
|
IMPORT_C TInt GetConnectionStage();
Intended Usage : Gets the stage of the connection process obtained from RConnection
|
IMPORT_C void SetPrimaryTextServerSession(CImTextServerSession *aPrimaryTextServerSession);
|
IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, TBool aEnableTimeout=ETrue);
|
IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const CImIAPPreferences &aIAPPreferences,
TInt aType, TBool aEnableTimeout=ETrue);
|
IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, TCallBack aDisconnectFunction,
const TUint32 aIntraddress, TInt aType, TBool aEnableTimeout=ETrue);
|
IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, const TUint32 aIAPaddress,
TInt aType, TBool aEnableTimeout=ETrue);
|
IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, TCallBack aDisconnectFunction,
TBool aEnableTimeout=ETrue);
|
IMPORT_C void QueueConnect(TRequestStatus &aStatus, const TDesC &anAddressDesc, TInt aPortNum, TCallBack aDisconnectFunction,
const CImIAPPreferences &aIAPPreferences, TInt aType, TBool aEnableTimeout=ETrue);
|
IMPORT_C TInt Send(const TDesC8 &aDesc);
|
|
IMPORT_C TInt Send(TRefByValue< const TDesC8 > aFmt,...);
|
|
IMPORT_C TInt SendReceive(const TDesC8 &aDesc);
|
|
IMPORT_C void Receive(TRequestStatus &aStatus, TDes8 &rDes);
|
IMPORT_C TInt SetSecurity(TBool aSecurityOn, TBool aUnattendedMode=0);
|
|
private: virtual void DoCancel();
Implements cancellation of an outstanding request.
This function is called as part of the active object's 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.
DoCancel()
must not wait for event completion; this is handled by Cancel()
.