RNetDatabase Class Reference

#include <es_sock.h>

Link against: esock.lib

class RNetDatabase : public RSubSessionBase

Inherits from

RNetDatabase
- RSubSessionBase

Public Member Functions
IMPORT_C void	Add(const TDesC8 &, TRequestStatus &)
IMPORT_C TInt	Add(const TDesC8 &)
IMPORT_C void	Cancel()
IMPORT_C void	Close()
IMPORT_C TInt	Open(RSocketServ &, TUint, TUint)
IMPORT_C void	Query(const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C TInt	Query(const TDesC8 &, TDes8 &)
IMPORT_C void	Remove(const TDesC8 &, TRequestStatus &)
IMPORT_C TInt	Remove(const TDesC8 &)

Inherited Functions
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const

Detailed Description

Provides an interface to network databases, such as LM-IAS with IrDA, that may be provided by particular protocol modules.

Before making any queries, a connection to a socket server session must be made.

Each function is available in both synchronous and asynchronous versions.

A single RNetDatabase can only perform one request of any type at once. A client is panicked if it makes two requests.

Particular database access services will specify the format of queries and of responses.

Member Function Documentation

Add ( const TDesC8 &, TRequestStatus & )

IMPORT_C void	Add	(	const TDesC8 &	anItem,
			TRequestStatus &	aStat
		)

Adds a record to the database asynchronously.

Parameters
anItem	The record to add
aStat	Indicates asynchronous operation and on completion contains an error code: see the system-wide error codes.

Capability
Dependent	on the type of connection so deferred to PRT

Add ( const TDesC8 & )

IMPORT_C TInt

Add

(

const TDesC8 &

anItem

)

Adds a record to the database.

Parameters
anItem	The record to add

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

Capability
Dependent	on the type of connection so deferred to PRT

Cancel ( )

IMPORT_C void

Cancel

(

)

Cancels any outstanding asynchronous calls, which will return with error code KErrCancel.

Close ( )

IMPORT_C void

(

)

Closes a database access service. If a service has been opened using Open(), then it should be closed using Close(). This will ensure all associated resources are released.

Open ( RSocketServ &, TUint, TUint )

IMPORT_C TInt	Open	(	RSocketServ &	aSocketServer,
			TUint	anAddrFamily,
			TUint	aProtocol
		)

Initialises a database access service provided by a particular protocol. It must be called before other object functions are used.

Parameters
aSocketServer	The socket server session
anAddrFamily	A constant identifying the protocol family
aProtocol	A constant that identifies the protocol that provides the database access service

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

Query ( const TDesC8 &, TDes8 &, TRequestStatus & )

IMPORT_C void	Query	(	const TDesC8 &	aQuery,
			TDes8 &	aResult,
			TRequestStatus &	aStat
		)

Makes a query to the database asynchronously.

Parameters
aQuery	The query to perform
aResult	The result of the query
aStat	Indicates asynchronous operation and on completion contains an error code: see the system-wide error codes.

Capability
Dependent	on the type of connection so deferred to PRT

Query ( const TDesC8 &, TDes8 & )

IMPORT_C TInt	Query	(	const TDesC8 &	aQuery,
			TDes8 &	aResult
		)

Makes a query to the database.

Parameters
aQuery	The query to perform
aResult	The result of the query

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

Capability
Dependent	on the type of connection so deferred to PRT

Remove ( const TDesC8 &, TRequestStatus & )

IMPORT_C void	Remove	(	const TDesC8 &	anItem,
			TRequestStatus &	aStat
		)

Removes a record from the database asynchronously.

Parameters
anItem	The record to remove
aStat	Indicates asynchronous operation and on completion contains an error code: see the system-wide error codes.

Capability
Dependent	on the type of connection so deferred to PRT

Remove ( const TDesC8 & )

IMPORT_C TInt

Remove

(

const TDesC8 &

anItem

)

Removes a record from the database.

Parameters
anItem	The record to remove

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

Capability
Dependent	on the type of connection so deferred to PRT