#include <es_sock.h>
Link against: esock.lib
class RSubConnection : public RCommsSubSession |
Public Member Enumerations | |
---|---|
enum | TSubConnType { EAttachToDefault, ECreateNew, EWaitIncoming } |
Public Member Functions | |
---|---|
RSubConnection() | |
IMPORT_C void | Add(RSocket &, TRequestStatus &) |
IMPORT_C void | CancelEventNotification() |
IMPORT_C void | Close() |
IMPORT_C TInt | Control(TUint, TUint, TDes8 &) |
IMPORT_C void | EventNotification(TNotificationEventBuf &, TBool, TRequestStatus &) |
IMPORT_C void | EventNotification(TNotificationEventBuf &, TEventFilter, TUint, TRequestStatus &) |
IMPORT_C TInt | GetParameters(RSubConParameterBundle &) |
IMPORT_C TInt | GetParameters(RParameterFamilyBundle &) |
IMPORT_C TInt | Open(RSocketServ &, TSubConnType, RConnection &) |
IMPORT_C void | Remove(RSocket &, TRequestStatus &) |
TBool | SameSession(TInt) |
IMPORT_C TInt | SetParameters(const RSubConParameterBundle &) |
IMPORT_C TInt | SetParameters(const RParameterFamilyBundle &) |
IMPORT_C void | Start(TRequestStatus &) |
IMPORT_C TInt | Start() |
IMPORT_C TInt | Stop() |
The sub-connection can represent a end-to-end channel and/or a channel from this device to an intermediate device (e.g an access server such as a GGSN which using UMTS and PDP contexts. Properties can be specified simultaneously on protocol and link level.)
Since v9.0
Enumerator | Value | Description |
---|---|---|
EAttachToDefault | ||
ECreateNew | ||
EWaitIncoming |
IMPORT_C void | Add | ( | RSocket & | aSocket, |
TRequestStatus & | aStatus | |||
) |
Associate a socket with a subconnection. The socket must already be using the same connection or the association attempt will fail. The completion of this method does not indicate that the socket is now running over the sub-connection, it only indicates that the association is complete and a negotiation has started to move the socket onto the subconnection. An event (via eventNotification) will be sent once the socket is running on the sub-connection.
Parameters | |
---|---|
aSocket | Socket to be associated with the Sub-Connection |
aStatus | Status to complete when socket has been added (or failed to add) |
IMPORT_C void | CancelEventNotification | ( | ) |
Cancel an outstanding Event Notification request
IMPORT_C void | Close | ( | ) |
Closes the sub-connection.
The sub-connection will not be dropped immediately: it will be dropped when there is no more data traffic on the sub-connection.
IMPORT_C void | EventNotification | ( | TNotificationEventBuf & | aEventBuffer, |
TBool | aGenericEventsOnly, | |||
TRequestStatus & | aStatus | |||
) |
Requests asynchronous event notification for the sub-connection.
Parameters | |
---|---|
aEventBuffer | A buffer to receive event notification. |
aStatus | On return, the status of the request. |
IMPORT_C void | EventNotification | ( | TNotificationEventBuf & | aEventBuffer, |
TEventFilter | aEventFilterList, | |||
TUint | aEventListLength, | |||
TRequestStatus & | aStatus | |||
) |
Requests asynchronous notification of a specific list of events for the sub-connection.
Parameters | |
---|---|
aEventBuffer | A buffer to receive event notification. |
aEventFilterList | list of event filters specifying a subset of events of interest. |
aEventListLength | Length of the filter list provided |
aStatus | On return, the status of the request. |
IMPORT_C TInt | GetParameters | ( | RSubConParameterBundle & | aParametersSet | ) |
Fetch the sub-connection's current parameters (Requested, Acceptable and Granted)
Parameters | |
---|---|
aParametersSet | bundle of parameters to write the current parameters into |
IMPORT_C TInt | GetParameters | ( | RParameterFamilyBundle & | aParametersSet | ) |
Fetch the sub-connection's current parameters (Requested, Acceptable and Granted)
Parameters | |
---|---|
aParametersSet | bundle of parameters to write the current parameters into |
IMPORT_C TInt | Open | ( | RSocketServ & | aServer, |
TSubConnType | aSubConnType, | |||
RConnection & | aConnection | |||
) |
Opens a new RSubConnection instance.
Parameters | |
---|---|
aSubConnType | specifies the type of sub connection, the different available types are defined by TSubConnType. |
aConnection | Parent Connection that is to be sub divided by this sub-connection |
IMPORT_C void | Remove | ( | RSocket & | aSocket, |
TRequestStatus & | aStatus | |||
) |
Remove a socket from a subconnection. The socket will be moved back to the default sub-connection. The successful completion of this method does not indicate that the socket has moved back to the default sub-connection, it only indicates that the move negotiation has been successful. An event (via eventNotification) will be sent once the socket is running on the default sub-connection.
Parameters | |
---|---|
aSocket | Socket to be removed from the Sub-Connection |
aStatus | Status to complete when socket has been removed (or failed to remove) |
Checks that the Session Handle passed is the same as that of this RSubConnection.
Use to verify the RSubConnection argument passed to the RSocket and RHostResolver Open(..., RSubConnection& aSubConnection) methods.
Parameters | |
---|---|
aSessionHandle | The handle which is to be checked against that of this RSubConnection |
IMPORT_C TInt | SetParameters | ( | const RSubConParameterBundle & | aParametersSet | ) |
Set Parameters of the sub-connection. Successful completion of this method only indicates that the negotiation has been successfully started. An event via eventNotification) will be sent once the granted parameters are available.
Parameters | |
---|---|
aParametersSet | bundle of parameters to be applied to the sub-connection |
IMPORT_C TInt | SetParameters | ( | const RParameterFamilyBundle & | aParametersSet | ) |
Set Parameters of the sub-connection. Successful completion of this method only indicates that the negotiation has been successfully started. An event via eventNotification) will be sent once the granted parameters are available.
Parameters | |
---|---|
aParametersSet | bundle of parameters to be applied to the sub-connection |