| class CServProviderBase : public CBase |
Service Access Point.
Provides transport services to a single protocol. Several of the calls to CServProviderBase have pre-conditions attached to them - for example a connection oriented protocol must have its local address set (either by a SetLocalName() or AutoBind()) before it is opened. If the socket server calls the CServProviderBase in such an erroneous way, the protocol should panic.
Since 5.0
| Public Member Enumerations | |
|---|---|
| enum | TCloseType { ENormal, EStopInput, EStopOutput, EImmediate } |
| Protected Attributes | |
|---|---|
| MSocketNotify * | iSocket |
| Private Attributes | |
|---|---|
| TUint | iSockType |
| HBufC8 * | iV1ShimDataIn |
| HBufC8 * | iV1ShimDataOut |
| void | ActiveOpen | ( | const TDesC8 & | aConnectionData | ) | [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.
This version of the function has user data in the connection frame.
Only ever called on connection-oriented sockets. Such a socket should always have both the local address and the remote address specified before this function 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().
| const TDesC8 & aConnectionData | If the protocol supports user specified connection data, then it will be held in this buffer. |
| void | AutoBind | ( | ) | [pure virtual] |
Specifies that the protocol should choose a local address for the service access point itself.
| void | CancelIoctl | ( | TUint | aLevel, |
| TUint | aName | |||
| ) | [pure virtual] | |||
Cancels an outstanding Ioctl call. You are guaranteed only to have one outstanding at once.
| IMPORT_C void | GetData | ( | TDes8 & | aDesc, |
| TUint | options, | |||
| TSockAddr * | anAddr = NULL | |||
| ) | [virtual] | |||
Gets data which the protocol has indicated is waiting in its buffers using the NewData up-call on the MSocketNotify.
GetData() will only ever be called for as much data as the protocol has specified it can process using the NewData up-call.
For stream oriented protocols GetData() should fill the descriptor with data from the stream. On a datagram protocol GetData() should copy one datagram into the descriptor and set the length of the descriptor. If a full datagram will not fit into the supplied descriptor, the overflow should be discarded.
anAddr should be filled in by the protocol with the address of where the data came from.
| IMPORT_C TInt | GetData | ( | RMBufChain & | aData, |
| TUint | aLength, | |||
| TUint | aOptions, | |||
| TSockAddr * | anAddr = NULL | |||
| ) | [virtual] | |||
Gets data which the protocol has indicated is waiting in its buffers using the NewData up-call on the MSocketNotify.
GetData() will only ever be called for as much data as the protocol has specified it can process using the NewData up-call.
For stream oriented protocols GetData() should fill the descriptor with data from the stream. On a datagram protocol GetData() should copy one datagram into the descriptor and set the length of the descriptor. If a full datagram will not fit into the supplied descriptor, the overflow should be discarded.
anAddr should be filled in by the protocol with the address of where the data came from.
| RMBufChain & aData | |
| TUint aLength | |
| TUint aOptions | Protocol specific options. |
| TSockAddr * anAddr = NULL | Address where the data came from. |
| TInt | GetOption | ( | TUint | level, |
| TUint | name, | |||
| TDes8 & | anOption | |||
| ) | const [pure virtual] | |||
Gets some protocol specific option when called by the socket server on behalf of a client. A protocol may pass the request down a protocol stack (to protocols it is bound to) using the GetOption() function of CProtocolBase.
System wide error code.
| void | Ioctl | ( | TUint | level, |
| TUint | name, | |||
| TDes8 * | anOption | |||
| ) | [pure virtual] | |||
Performs some protocol specific IO control.
If this function is called erroneously, the protocol should call Error() on the socket. If an Ioctl call is already outstanding, the client will be panicked with the value ETwoIoctls.
| IMPORT_C void | JoinSubConnectionL | ( | ESock::CSubConnectionProviderBase & | aSubConnProvider | ) | [virtual] |
| ESock::CSubConnectionProviderBase & aSubConnProvider |
| IMPORT_C void | LeaveSubConnection | ( | ESock::CSubConnectionProviderBase & | aSubConnProvider | ) | [virtual] |
| ESock::CSubConnectionProviderBase & aSubConnProvider |
| void | LocalName | ( | TSockAddr & | anAddr | ) | const [pure virtual] |
Gets the local name (address) of the socket service provider entity. The format of the data in the TSockAddr object is defined by individual protocols.
The local address is the address of the local machine plus a local port number. Generally only the port number is important, unless you have two IP interfaces, for example.
| TSockAddr & anAddr | The address to be filled in |
| 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.
Only ever called on connection-oriented sockets. Such a socket should always have both the local address and the remote address specified before this function is called. If this is not the case, then the protocol should panic.
The aQue parameter is the number of sockets which can be waiting for an outstanding Start after calling ConnectComplete(). The protocol should keep a count of sockets in this 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().
| TUint aQueSize | Size of connect queue. |
| TInt | PassiveOpen | ( | TUint | aQueSize, |
| const TDesC8 & | aConnectionData | |||
| ) | [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.
This version of the function has user data in the connection frame.
Only ever called on connection-oriented sockets. Such a socket should always have both the local address and the remote address specified before this function is called. If this is not the case then the protocol should panic.
The aQue parameter is the number of sockets which can be waiting for an outstanding Start after calling ConnectComplete(). The protocol should keep a count of sockets in this 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().
| void | RemName | ( | TSockAddr & | anAddr | ) | const [pure virtual] |
Gets the remote name (address) of the socket service provider entity. The format of the data in the TSockAddr object is defined by individual protocols.
A remote address is either the address you're sending data to (non connection-oriented sockets)* or the remote end of the connection. It is the address of the remote machine (your peer in the network) plus a port number.
RemName is only meaningful if the socket server client has called Connect() to set up a default address for SendTo(). This function will only be called on the protocol if this is the case.
| TSockAddr & anAddr | The address to be filled in |
| IMPORT_C TInt | SecurityCheck | ( | MProvdSecurityChecker * | aSecurityChecker | ) | [virtual] |
Use the class instance argument to perform security policy checks on the originating client process.
This method is called when a SAP is created and when a socket is transferred between sessions. The SAP is required to check whether the originating client process has enough privileges to request services from the SAP. The MProvdSecurityChecker class instance is used to perform security policy checks. The SAP may choose to perform a security policy check in its SecurityCheck(...) method, or it may choose to store the MProvdSecurityChecker class instance argument and perform checking later (i.e. when subsequent SAP methods are called).
KErrPermissionDenied if SAP wishes to disallow access to the client, else KErrNone. This would normally be as a result of calling MProvdSecurityChecker::CheckPolicy(...) with a suitable security policy argument.
| MProvdSecurityChecker * aSecurityChecker | Pointer to class used by SAP to perform security checks on the client process. This pointer becomes invalid when the SAP is destroyed or detached. |
| TInt | SetLocalName | ( | TSockAddr & | anAddr | ) | [pure virtual] |
Sets the local name (address) of the socket service provider entity. The format of the data in the TSockAddr object is defined by individual protocols.
Returns KErrNone if the local name is correctly set or, if this is not the case, an informative error number.
| TSockAddr & anAddr | The address |
| IMPORT_C void | SetNotify | ( | MSocketNotify * | aSocket | ) | [virtual] |
| MSocketNotify * aSocket |
| TInt | SetOption | ( | TUint | level, |
| TUint | name, | |||
| const TDesC8 & | anOption | |||
| ) | [pure virtual] | |||
Sets some protocol specific option when called by the socket server on behalf of a client. A protocol may pass the request down a protocol stack (to protocols it is bound to) using the SetOption() function of CProtocolBase.
System wide error code.
| TInt | SetRemName | ( | TSockAddr & | anAddr | ) | [pure virtual] |
Sets the remote name (address) of the socket service provider entity. The format of the data in the TSockAddr object is defined by individual protocols.
Returns KErrNone if the remote name is correctly set or, if this is not the case, an informative error number.
| TSockAddr & anAddr | The address |
| void | Shutdown | ( | TCloseType | option | ) | [pure virtual] |
Terminates a connection (or closes a non connection-oriented socket down).
The value of the option argument specifies the type of processing which will be required of the protocol after this function is called.
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. However, if the option argument is EImmediate, the CServProviderBase will be destroyed as soon as Shutdown() returns.
| TCloseType option | The shutdown type. |
| void | Shutdown | ( | TCloseType | option, |
| const TDesC8 & | aDisconnectionData | |||
| ) | [pure virtual] | |||
Terminates a connection (or closes a non connection-oriented socket down).
The value of the option argument specifies the type of processing which will be required of the protocol after this function is called.
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. However, if the option argument is EImmediate, the CServProviderBase will be destroyed as soon as Shutdown() returns.
| TCloseType option | The shutdown type. |
| const TDesC8 & aDisconnectionData | If the protocol supports disconnect data, any such data required will be held in this buffer. |
| IMPORT_C TUint | Write | ( | const TDesC8 & | aDesc, |
| TUint | options, | |||
| TSockAddr * | anAddr = NULL | |||
| ) | [virtual] | |||
Sends data onto the network via the protocol.
Connection-oriented sockets must be in a connected state (that is ConnectComplete() has been called on their MSocketNotify before Write() is called).
The socket server keeps track of how much data is waiting and then tries to send it all until the protocol tells it to hold off by returning 0 (datagram sockets) or 'less than all data consumed' (stream sockets) to Write(). The protocol should call CanSend() when it is ready to send more data.
anAddr is the address to write the data to. Connection oriented sockets always use the default value.
For stream-oriented protocols the return value is the number of bytes actually written. If this is less than the length of the descriptor then the protocol should call CanSend() when it is ready to send more data. For datagram-oriented protocols, the write should return either 0 if the write cannot be completed, or the length of the descriptor if the write succeeds - no other values are valid. If the Write() must return 0, then it should call CanSend() when it is ready to send more data. If the Write() fails due to some error, then it should call Error() with an informative error number.
| IMPORT_C TInt | Write | ( | RMBufChain & | aData, |
| TUint | aOptions, | |||
| TSockAddr * | anAddr = NULL | |||
| ) | [virtual] | |||
Sends data onto the network via the protocol.
Connection-oriented sockets must be in a connected state (that is ConnectComplete() has been called on their MSocketNotify before Write() is called).
The socket server keeps track of how much data is waiting and then tries to send it all until the protocol tells it to hold off by returning 0 (datagram sockets) or 'less than all data consumed' (stream sockets) to Write(). The protocol should call CanSend() when it is ready to send more data.
anAddr is the address to write the data to. Connection oriented sockets always use the default value.
For stream-oriented protocols the return value is the number of bytes actually written. If this is less than the length of the descriptor then the protocol should call CanSend() when it is ready to send more data. For datagram-oriented protocols, the write should return either 0 if the write cannot be completed, or the length of the descriptor if the write succeeds - no other values are valid. If the Write() must return 0, then it should call CanSend() when it is ready to send more data. If the Write() fails due to some error, then it should call Error() with an informative error number.
| RMBufChain & aData | The data to be sent. |
| TUint aOptions | Protocol specific options. |
| TSockAddr * anAddr = NULL | Address to write the data to. |
Describes the behaviour the SAP should take on shutdown.
| ENormal | |
| EStopInput | |
| EStopOutput | |
| EImmediate |
| MSocketNotify * | iSocket | [protected] |
On socket creation, the socket server sets this member to point to a server notification interface.