Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <ES_SOCK.H>
Link against: esock.lib

Class RServiceResolver

class RServiceResolver : public RSubSessionBase;

Description

Provides an interface to resolver service names and ports.

Derivation

Members

Defined in RServiceResolver:

Inherited from RSubSessionBase:


Member functions


Open(RSocketServ &,TUint,TUint,TUint)

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

Description

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.

Return value

TInt

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


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

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

Description

Gets a service by name asynchronously.

Parameters

const TDesC16 &aName

Name of the service to get.

TPckgBuf &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);

Description

Get a service by name.

Parameters

const TDesC16 &aName

Name of the service to get.

TPckgBuf &aPort

On return, the port associated with the service.

Return value

TInt

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


GetByNumber(const TUint,TDes &,TRequestStatus &)

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

Description

Gets the name of the service asynchronously.

Parameters

const TUint aPort

Port of the service.

TDes16 &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);

Description

Gets the name of the service

Parameters

const TUint aPort

Port of the service.

TDes16 &aName

On return, the name of the service.

Return value

TInt

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


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

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

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

Description

Registers a new service asynchronously.

Parameters

const TDesC16 &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 &)

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

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

Description

Registers a new service.

Parameters

const TDesC16 &aName

Name of the service.

const TUint &aPort

Port of the service.

Return value

TInt

KErrNone if successful, otherwise another of the system-wide error codes.


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

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

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

Description

Removes a service asynchronously.

Parameters

const TDesC16 &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 &)

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

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

Description

Removes a service.

Parameters

const TDesC16 &aName

Name of the service.

const TUint &aPort

Port of the service.

Return value

TInt

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


Close()

IMPORT_C void Close();

Description

Closes a service resolver service

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


Cancel()

IMPORT_C void Cancel();

Description

Cancels any pending request.