Collapse all Symbian^3 Application Developer Library

RServiceResolver Class Reference

class RServiceResolver : public RSubSessionBase

Provides an interface to resolver service names and ports.

Inherits from

RServiceResolver
- RSubSessionBase

Public Member Functions
IMPORT_C void	Cancel ()
IMPORT_C void	Close ()
IMPORT_C void	GetByName (const TDesC &, TPortNum &, TRequestStatus &)
IMPORT_C TInt	GetByName (const TDesC &, TPortNum &)
IMPORT_C void	GetByNumber (const TUint , TDes &, TRequestStatus &)
IMPORT_C TInt	GetByNumber (const TUint , TDes &)
IMPORT_C TInt	Open ( RSocketServ &, TUint , TUint , TUint )
IMPORT_C void	RegisterService (const TDesC &, const TUint &, TRequestStatus &)
IMPORT_C TInt	RegisterService (const TDesC &, const TUint &)
IMPORT_C void	RemoveService (const TDesC &, const TUint &, TRequestStatus &)
IMPORT_C TInt	RemoveService (const TDesC &, const TUint &)

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

Member Functions Documentation

Cancel()

IMPORT_C void

Cancel

(

)

Cancels any pending request.

Close()

IMPORT_C void

(

)

Closes a service resolver service

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

GetByName(const TDesC &, TPortNum &, TRequestStatus &)

IMPORT_C void	GetByName	(	const TDesC &	aName,
			TPortNum &	aPort,
			TRequestStatus &	aStatus
		)

Gets a service by name asynchronously.

Parameters

const TDesC & aName	Name of the service to get.
TPortNum & aPort	On completion, the port associated with the service.
TRequestStatus & aStatus	On completion, KErrNone if successful otherwise another of the system-wide error codes.

GetByName(const TDesC &, TPortNum &)

IMPORT_C TInt	GetByName	(	const TDesC &	aName,
			TPortNum &	aPort
		)

Get a service by name.

Parameters

const TDesC & aName	Name of the service to get.
TPortNum & aPort	On return, the port associated with the service.

GetByNumber(const TUint, TDes &, TRequestStatus &)

IMPORT_C void	GetByNumber	(	const TUint	aPort,
			TDes &	aName,
			TRequestStatus &	aStatus
		)

Gets the name of the service asynchronously.

Parameters

const TUint aPort	Port of the service.
TDes & aName	On completion, the name of the service.
TRequestStatus & aStatus	On completion, KErrNone if successful otherwise another of the system-wide error codes.

GetByNumber(const TUint, TDes &)

IMPORT_C TInt	GetByNumber	(	const TUint	aPort,
			TDes &	aName
		)

Gets the name of the service

Parameters

const TUint aPort	Port of the service.
TDes & aName	On return, the name of the service.

Open(RSocketServ &, TUint, TUint, TUint)

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

set up the sub session - unlike name resolvers and net databases, services can be socket type specific. Opens a service resolver service.

Unlike name resolvers ( RHostResolver ) and net databases ( RNetDatabase ), services can be socket type specific.

Parameters

RSocketServ & aSocketServer	The socket server session.
TUint anAddrFamily	A constant identifying the protocol family.
TUint sockType	A constant that identifies the socket type.
TUint aProtocol	A constant that identifies the protocol that provides the service.

RegisterService(const TDesC &, const TUint &, TRequestStatus &)

IMPORT_C void	RegisterService	(	const TDesC &	aName,
			const TUint &	aPort,
			TRequestStatus &	aStatus
		)

Registers a new service asynchronously.

capability: NetworkControl To protect against dangerous new services being added, which may steal legimate services resources

Parameters

const TDesC & aName	Name of the service.
const TUint & aPort	Port of the service.
TRequestStatus & aStatus	On completion, KErrNone if successful otherwise another of the system-wide error codes.

RegisterService(const TDesC &, const TUint &)

IMPORT_C TInt	RegisterService	(	const TDesC &	aName,
			const TUint &	aPort
		)

Registers a new service.

capability: NetworkControl To protect against dangerous new services being added, which may steal legimate services resources

Parameters

const TDesC & aName	Name of the service.
const TUint & aPort	Port of the service.

RemoveService(const TDesC &, const TUint &, TRequestStatus &)

IMPORT_C void	RemoveService	(	const TDesC &	aName,
			const TUint &	aPort,
			TRequestStatus &	aStatus
		)

Removes a service asynchronously.

capability: NetworkControl Ensure that only privileged apps can remove information from the service resolver

Parameters

const TDesC & aName	Name of the service to remove.
const TUint & aPort	Port of the service to remove.
TRequestStatus & aStatus	On completion, KErrNone if successful otherwise another of the system-wide error codes.

RemoveService(const TDesC &, const TUint &)

IMPORT_C TInt	RemoveService	(	const TDesC &	aName,
			const TUint &	aPort
		)

Removes a service.

capability: NetworkControl Ensure that only privileged apps can remove information from the service resolver

Parameters

const TDesC & aName	Name of the service.
const TUint & aPort	Port of the service.