CSSLProviderBase Class Reference
class CSSLProviderBase : public CBase |
Abstract base class for all SSL protocol implementations.
- Since
- v5.0
No longer used by networking
Public Member Functions |
---|
| CSSLProviderBase(CSSLFactory &) |
| ~CSSLProviderBase() |
TInt
| ActiveOpen() |
TInt
| ActiveOpen(const TDesC8 &) |
void | CancelIoctl(TUint, TUint) |
void | Close() |
void | ConnectCompleted() |
void | ConstructL(MSSLSocketNotify *) |
const TInt | GetOption(TUint, TUint, TDes8 &) |
void | Ioctl(TUint, TUint, TDes8 *) |
TInt
| PassiveOpen(TUint) |
TInt
| PassiveOpen(TUint, const TDesC8 &) |
void | Process(RMBufChain &) |
void | ProcessL(const TDesC8 &) |
void | SetNotify(MSSLSocketNotify *) |
TInt
| SetOption(TUint, TUint, const TDesC8 &) |
void | Shutdown() |
TUint
| Write(const TDesC8 &, TUint, TSockAddr *) |
Constructor & Destructor Documentation
CSSLProviderBase(CSSLFactory &)
~CSSLProviderBase()
~CSSLProviderBase | ( | ) | [virtual] |
Member Functions Documentation
ActiveOpen()
TInt
| ActiveOpen | ( | ) | [pure virtual] |
Initiates a connection operation.
This means that it tells the protocol to attempt to connect to a peer. It is called by the socket server in response to a connect request from a client. ActiveOpen() is only ever called on connection-oriented sockets. Such a socket should always have both the local address and the remote address specified before ActiveOpen() is called. If this is not the case, then the protocol should panic. When a connection has completed, the protocol should call ConnectComplete() on its TNotify.
If an error occurs during connection the protocol should not call ConnectComplete() at all; instead it should call Error().
ActiveOpen(const TDesC8 &)
TInt
| ActiveOpen | ( | const TDesC8 & | aConnectionData | ) | [pure virtual] |
Same as ActiveOpen(), but with user data in the connection frame.
Parameters
const TDesC8 & aConnectionData | User specified connection data. |
CancelIoctl(TUint, TUint)
void | CancelIoctl | ( | TUint | aLevel, |
| TUint | aName |
| ) | [pure virtual] |
Close()
void | Close | ( | ) | [pure virtual] |
ConnectCompleted()
void | ConnectCompleted | ( | ) | [pure virtual] |
Indicates that the connection has been completed.
ConstructL(MSSLSocketNotify *)
GetOption(TUint, TUint, TDes8 &)
Ioctl(TUint, TUint, TDes8 *)
PassiveOpen(TUint)
TInt
| PassiveOpen | ( | TUint | aQueSize | ) | [pure virtual] |
Tells the protocol to start waiting for an incoming connection request on this socket (i.e. port).
It is called by the socket server in response to a listen request from a client.
PassiveOpen() is only ever called on connection-oriented sockets. Such a socket should always have both the local address and the remote address specified before PassiveOpen() is called. If this is not the case, then the protocol should panic.
The protocol should keep a count of sockets in Start state - incrementing a variable in ConnectComplete(), and decrementing it in Start().
When a connection has completed, the protocol should call ConnectComplete() on its TNotify.
If an error occurs during connection the protocol should not call ConnectComplete() at all; instead it should call Error().
Parameters
TUint aQueSize | The number of sockets which can be waiting for an outstanding Start() after calling ConnectComplete(). |
PassiveOpen(TUint, const TDesC8 &)
TInt
| PassiveOpen | ( | TUint | aQueSize, |
| const TDesC8 & | aConnectionData |
| ) | [pure virtual] |
Same as PassiveOpen(), but with user data in the connection frame.
Parameters
TUint aQueSize | The number of sockets which can be waiting for an outstanding Start() after calling ConnectComplete(). |
const TDesC8 & aConnectionData | User specified connection data |
Process(RMBufChain &)
void | Process | ( | RMBufChain & | aBuf | ) | [pure virtual] |
Process the event in the buffer.
Parameters
RMBufChain & aBuf | Chain with events to process. |
ProcessL(const TDesC8 &)
void | ProcessL | ( | const TDesC8 & | aDesc | ) | [pure virtual] |
SetNotify(MSSLSocketNotify *)
Set the notification parent,
SetOption(TUint, TUint, const TDesC8 &)
Parameters
TUint level | Integer constant identifying the option. |
TUint name | Option name. |
const TDesC8 & anOption | Option value packaged in a descriptor. |
Shutdown()
void | Shutdown | ( | ) | [pure virtual] |
Terminates a connection (or closes a non connection-oriented socket down).
Normally, when the socket server has called Shutdown() for a socket, it will wait for the socket to call CanClose() before destroying the CServProviderBase object.
Write(const TDesC8 &, TUint, TSockAddr *)
Member Enumerations Documentation
Enum TCloseType
Enumerators
ENormal |
Normal.
|
EStopInput |
Stop input.
|
EStopOutput |
Stop output.
|
EImmediate |
Close immediately.
|
Member Data Documentation
MSSLSocketNotify * iSocket
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.