RSubSessionBase Class Reference

#include <e32std.h>

class RSubSessionBase

Public Member Functions
TInt	SubSessionHandle()

Protected Member Functions
	RSubSessionBase()
IMPORT_C void	CloseSubSession(TInt)
IMPORT_C TInt	CreateAutoCloseSubSession(RSessionBase &, TInt, const TIpcArgs &)
TInt	CreateSubSession(const RSessionBase &, TInt, const TIpcArgs &)
TInt	CreateSubSession(const RSessionBase &, TInt)
TInt	Send(TInt, const TIpcArgs &)
TInt	Send(TInt)
void	SendReceive(TInt, const TIpcArgs &, TRequestStatus &)
TInt	SendReceive(TInt, const TIpcArgs &)
void	SendReceive(TInt, TRequestStatus &)
TInt	SendReceive(TInt)
IMPORT_C const RSessionBase	Session()

Detailed Description

Client-side handle to a sub-session.

It represents a client-side sub-session, and has a corresponding sub-session object on the server-side.

Clients normally define and implement a derived class to provide a richer interface. In particular, a derived class should:

1. provide a function to create a new sub-session with the server; this should call CreateSubSession().

2. provide a function to close the current sub-session; this should call CloseSubSession().

A session must already exist with a server before a client can establish any sub-sessions.

Constructor & Destructor Documentation

RSubSessionBase ( )

RSubSessionBase

(

)

[protected, inline]

Default constructor

Member Function Documentation

CloseSubSession ( TInt )

IMPORT_C void

CloseSubSession

(

TInt

aFunction

)

[protected]

Closes the sub-session.

Parameters
aFunction	The opcode specifying the requested service; the server should interpret this as a request to close the sub-session.

CreateAutoCloseSubSession ( RSessionBase &, TInt, const TIpcArgs & )

IMPORT_C TInt	CreateAutoCloseSubSession	(	RSessionBase &	aSession,
			TInt	aFunction,
			const TIpcArgs &	aArgs
		)	[protected]

Creates a new sub-session within an existing session. The new sub-session takes ownership of the session so that when the sub-session is closed, the session is closed too. If the creation of the sub-session fails, the session is closed immediately. In other words, this method will always take ownership of the session, whether it succeeds or not and the caller should never need to close it.

Parameters
aSession	The session to which this sub-session will belong.
aFunction	The opcode specifying the requested service; the server should interpret this as a request to create a sub-session.
aArgs	The arguments to be sent to the server as part of the sub-session create request. The fourth argument is not sent to the server, instead it is replaced with a descriptor reference to the 32bit value where the server should store the handle of the created sub-session.

Return Value: KErrNone if successful, otherwise one of the other system-wide error codes.

CreateSubSession ( const RSessionBase &, TInt, const TIpcArgs & )

TInt	CreateSubSession	(	const RSessionBase &	aSession,
			TInt	aFunction,
			const TIpcArgs &	aArgs
		)	[protected, inline]

Creates a new sub-session within an existing session.

Parameters
aSession	The session to which this sub-session will belong.
aFunction	The opcode specifying the requested service; the server should interpret this as a request to create a sub-session.
aArgs	The message arguments.

Return Value: KErrNone if successful, otherwise one of the system-wide error codes.

CreateSubSession ( const RSessionBase &, TInt )

TInt	CreateSubSession	(	const RSessionBase &	aSession,
			TInt	aFunction
		)	[protected, inline]

Creates a new sub-session within an existing session.

This variant sends no message arguments to the server.

Parameters
aSession	The session to which this sub-session will belong.
aFunction	The opcode specifying the requested service; the server should interpret this as a request to create a sub-session.

Return Value: KErrNone if successful, otherwise one of the system-wide error codes.

Send ( TInt, const TIpcArgs & )

TInt	Send	(	TInt	aFunction,
			const TIpcArgs &	aArgs
		)	const [protected, inline]

Sends a blind message to the server - no reply is expected.

A set of message arguments is passed that can be used to specify client addresses, which the server can use to read from and write to the client address space.

Note that this function can fail if there are no available message-slots, either in the system wide pool (if this is being used), or in the session reserved pool (if this is being used). If the client request is synchronous, then always use the synchronous variant of SendReceive(); this is guaranteed to reach the server.

Parameters
aFunction	The opcode specifying the requested service.
aArgs	The message arguments.

Return Value: KErrNone if successful, otherwise one of the system-wide error codes.

Send ( TInt )

TInt

Send

(

TInt

aFunction

)

const [protected, inline]

Sends a blind message to the server - no reply is expected.

This variant sends no message arguments to the server.

Parameters
aFunction	The opcode specifying the requested service.

Return Value: KErrNone if successful, otherwise one of the system-wide error codes.

SendReceive ( TInt, const TIpcArgs &, TRequestStatus & )

void	SendReceive	(	TInt	aFunction,
			const TIpcArgs &	aArgs,
			TRequestStatus &	aStatus
		)	const [protected, inline]

Sends a message to the server and waits asynchronously for the reply.

An opcode specifies the service required. A set of message arguments is passed that can be used to specify client addresses, which the server can use to read from and write to the client address space.

Parameters
aFunction	The opcode specifying the requested service.
aArgs	The message arguments.
aStatus	A request status which indicates the completion status of the asynchronous request.

SendReceive ( TInt, const TIpcArgs & )

TInt	SendReceive	(	TInt	aFunction,
			const TIpcArgs &	aArgs
		)	const [protected, inline]

Sends a message to the server and waits synchronously for a reply.

Note that this function will only fail if the server itself fails or environmental errors occur in the server. All requests made using this function are guaranteed to reach the server. This means that all synchronous client requests (typically those that return void) should be routed through this synchronous variant of SendReceive().

Parameters
aFunction	The opcode specifying the requested service.
aArgs	The message arguments.

Return Value: KErrNone if successful, otherwise one of the system-wide error codes.

SendReceive ( TInt, TRequestStatus & )

void	SendReceive	(	TInt	aFunction,
			TRequestStatus &	aStatus
		)	const [protected, inline]

Sends a message to the server and waits asynchronously for the reply.

An opcode specifies the service required. This variant sends no message arguments to the server.

Parameters
aFunction	The opcode specifying the requested service.
aStatus	A request status which indicates the completion status of the asynchronous request.

SendReceive ( TInt )

TInt

SendReceive

(

TInt

aFunction

)

const [protected, inline]

Sends a message to the server and waits synchronously for a reply.

An opcode specifies the service required. This variant sends no message arguments to the server.

Parameters
aFunction	The opcode specifying the requested service.

Return Value: KErrNone if successful, otherwise one of the system-wide error codes.

Session ( )

IMPORT_C const RSessionBase

Session

(

)

const [protected]

Returns a copy of the session associated with this sub-session.

Return Value: a copy of the session

SubSessionHandle ( )

TInt

SubSessionHandle

(

)

const [inline]

Gets the sub-session handle number.

This number is automatically passed to the server when making requests and is used to identify the appropriate server-side sub-session.

Return Value: The sub-session handle number.