A Sub-Connection, a channel within a Connection. More...

#include <es_sock.h>

Inheritance diagram for RSubConnection:

Classes
struct	TEventFilter

Public Types
enum	TSubConnType { EAttachToDefault , ECreateNew , EWaitIncoming }

Public Member Functions
IMPORT_C	RSubConnection ()
	Empty sub-connection handle constructor.

IMPORT_C TInt	Open (RSocketServ &aServer, TSubConnType aSubConnType, RConnection &aConnection)
	Opens a new RSubConnection instance.

IMPORT_C void	Close ()
	Closes the sub-connection.

IMPORT_C void	Start (TRequestStatus &aStatus)
	Unused.

IMPORT_C TInt	Start ()
	Unused.

IMPORT_C TInt	Stop ()
	Unused.

IMPORT_C void	Add (RSocket &aSocket, TRequestStatus &aStatus)
	Associate a socket with a subconnection.

IMPORT_C void	Remove (RSocket &aSocket, TRequestStatus &aStatus)
	Remove a socket from a subconnection.

IMPORT_C TInt	SetParameters (const RSubConParameterBundle &aParametersSet)
	Set Parameters of the sub-connection.

IMPORT_C TInt	GetParameters (RSubConParameterBundle &aParametersSet)
	Fetch the sub-connection's current parameters (Requested, Acceptable and Granted)

IMPORT_C TInt	SetParameters (const RParameterFamilyBundle &aParametersSet)
	Set Parameters of the sub-connection.

IMPORT_C TInt	GetParameters (RParameterFamilyBundle &aParametersSet)
	Fetch the sub-connection's current parameters (Requested, Acceptable and Granted)

IMPORT_C void	EventNotification (TNotificationEventBuf &aEventBuffer, TBool aGenericEventsOnly, TRequestStatus &aStatus)
	Requests asynchronous event notification for the sub-connection.

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.

IMPORT_C void	CancelEventNotification ()
	Cancel an outstanding Event Notification request.

IMPORT_C TInt	Control (TUint aOptionLevel, TUint aOptionName, TDes8 &aOption)

TBool	SameSession (TInt aSessionHandle)
	Checks that the Session Handle passed is the same as that of this RSubConnection.

Friends
class	RConnection

Detailed Description

A Sub-Connection, a channel within a Connection.

A representation of a channel between this device and remote devices with which we are communicating. This channel will be used by one or more sockets. Depending on the state of the channel, it may not be possible to bind arbitary sockets into it. Attempts to bind sockets from different protocol families to a single channel is an error, as each channel can only be used by one protocol family.

Note: 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.)

Before using any of these services, a connection to a socket server session must have been made and the connection must be open.

API status: Published to all clients. Released API. Since v9.0

Definition at line 1567 of file es_sock.h.

Member Enumeration Documentation

◆ TSubConnType

enum RSubConnection::TSubConnType

Enumerator
EAttachToDefault
ECreateNew
EWaitIncoming

Definition at line 1583 of file es_sock.h.

Constructor & Destructor Documentation

◆ RSubConnection()

IMPORT_C RSubConnection::RSubConnection ( )

Empty sub-connection handle constructor.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Add()

IMPORT_C void RSubConnection::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)

(generated from Symbian Developer Library)

◆ CancelEventNotification()

IMPORT_C void RSubConnection::CancelEventNotification ( )

Cancel an outstanding Event Notification request.

(generated from Symbian Developer Library)

◆ Close()

IMPORT_C void RSubConnection::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.

(generated from Symbian Developer Library)

◆ Control()

IMPORT_C TInt RSubConnection::Control	(	TUint	aOptionLevel,
		TUint	aOptionName,
		TDes8 &	aOption
	)

◆ EventNotification() [1/2]

IMPORT_C void RSubConnection::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.

(generated from Symbian Developer Library)

◆ EventNotification() [2/2]

IMPORT_C void RSubConnection::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.

(generated from Symbian Developer Library)

◆ GetParameters() [1/2]

IMPORT_C TInt RSubConnection::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

(generated from Symbian Developer Library)

◆ GetParameters() [2/2]

IMPORT_C TInt RSubConnection::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

(generated from Symbian Developer Library)

◆ Open()

IMPORT_C TInt RSubConnection::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

(generated from Symbian Developer Library)

◆ Remove()

IMPORT_C void RSubConnection::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)

(generated from Symbian Developer Library)

◆ SameSession()

TBool RSubConnection::SameSession ( TInt aSessionHandle )

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

(generated from Symbian Developer Library)

◆ SetParameters() [1/2]

IMPORT_C TInt RSubConnection::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

(generated from Symbian Developer Library)

◆ SetParameters() [2/2]

IMPORT_C TInt RSubConnection::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

(generated from Symbian Developer Library)

◆ Start() [1/2]

IMPORT_C TInt RSubConnection::Start ( )

Unused.

(generated from Symbian Developer Library)

◆ Start() [2/2]

IMPORT_C void RSubConnection::Start ( TRequestStatus & aStatus )

Unused.

(generated from Symbian Developer Library)

◆ Stop()

IMPORT_C TInt RSubConnection::Stop ( )

Unused.

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

◆ RConnection

friend class RConnection

friend

Definition at line 1581 of file es_sock.h.

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ TSubConnType

Constructor & Destructor Documentation

◆ RSubConnection()

Member Function Documentation

◆ Add()

◆ CancelEventNotification()

◆ Close()

◆ Control()

◆ EventNotification() [1/2]

◆ EventNotification() [2/2]

◆ GetParameters() [1/2]

◆ GetParameters() [2/2]

◆ Open()

◆ Remove()

◆ SameSession()

◆ SetParameters() [1/2]

◆ SetParameters() [2/2]

◆ Start() [1/2]

◆ Start() [2/2]

◆ Stop()

Friends And Related Symbol Documentation

◆ RConnection