Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
RServiceResolver Class Reference

Provides an interface to resolver service names and ports. More...

#include <es_sock.h>

Inheritance diagram for RServiceResolver:
RSubSessionBase

Public Member Functions

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.
 
IMPORT_C void GetByName (const TDesC &aName, TPortNum &aPort, TRequestStatus &aStatus)
 Gets a service by name asynchronously.
 
IMPORT_C TInt GetByName (const TDesC &aName, TPortNum &aPort)
 Get a service by name.
 
IMPORT_C void GetByNumber (const TUint aPort, TDes &aName, TRequestStatus &aStatus)
 Gets the name of the service asynchronously.
 
IMPORT_C TInt GetByNumber (const TUint aPort, TDes &aName)
 Gets the name of the service.
 
IMPORT_C void RegisterService (const TDesC &aName, const TUint &aPort, TRequestStatus &aStatus)
 Registers a new service asynchronously.
 
IMPORT_C TInt RegisterService (const TDesC &aName, const TUint &aPort)
 Registers a new service.
 
IMPORT_C void RemoveService (const TDesC &aName, const TUint &aPort, TRequestStatus &aStatus)
 Removes a service asynchronously.
 
IMPORT_C TInt RemoveService (const TDesC &aName, const TUint &aPort)
 Removes a service.
 
IMPORT_C void Close ()
 Closes a service resolver service.
 
IMPORT_C void Cancel ()
 Cancels any pending request.
 
- Public Member Functions inherited from RSubSessionBase
TInt SubSessionHandle () const
 Gets the sub-session handle number.
 

Additional Inherited Members

- Protected Member Functions inherited from RSubSessionBase
 RSubSessionBase ()
 Default constructor.
 
IMPORT_C const RSessionBase Session () const
 Returns a copy of the session associated with this sub-session.
 
TInt CreateSubSession (const RSessionBase &aSession, TInt aFunction, const TIpcArgs &aArgs)
 Creates a new sub-session within an existing session.
 
TInt CreateSubSession (const RSessionBase &aSession, TInt aFunction)
 Creates a new sub-session within an existing session.
 
IMPORT_C TInt CreateAutoCloseSubSession (RSessionBase &aSession, TInt aFunction, const TIpcArgs &aArgs)
 Creates a new sub-session within an existing session.
 
IMPORT_C void CloseSubSession (TInt aFunction)
 Closes the sub-session.
 
TInt Send (TInt aFunction, const TIpcArgs &aArgs) const
 Sends a blind message to the server - no reply is expected.
 
void SendReceive (TInt aFunction, const TIpcArgs &aArgs, TRequestStatus &aStatus) const
 Sends a message to the server and waits asynchronously for the reply.
 
TInt SendReceive (TInt aFunction, const TIpcArgs &aArgs) const
 Sends a message to the server and waits synchronously for a reply.
 
TInt Send (TInt aFunction) const
 Sends a blind message to the server - no reply is expected.
 
void SendReceive (TInt aFunction, TRequestStatus &aStatus) const
 Sends a message to the server and waits asynchronously for the reply.
 
TInt SendReceive (TInt aFunction) const
 Sends a message to the server and waits synchronously for a reply.
 

Detailed Description

Provides an interface to resolver service names and ports.

API status
Published to all clients. Released API.

Definition at line 1035 of file es_sock.h.

Member Function Documentation

◆ Cancel()

IMPORT_C void RServiceResolver::Cancel ( )

Cancels any pending request.

(generated from Symbian Developer Library)

◆ Close()

IMPORT_C void RServiceResolver::Close ( )

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.

(generated from Symbian Developer Library)

◆ GetByName() [1/2]

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

Get a service by name.

Parameters
aNameName of the service to get.
aPortOn return, the port associated with the service.

(generated from Symbian Developer Library)

◆ GetByName() [2/2]

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

Gets a service by name asynchronously.

Parameters
aNameName of the service to get.
aPortOn completion, the port associated with the service.
aStatusOn completion, KErrNone if successful otherwise another of the system-wide error codes.

(generated from Symbian Developer Library)

◆ GetByNumber() [1/2]

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

Gets the name of the service.

Parameters
aPortPort of the service.
aNameOn return, the name of the service.

(generated from Symbian Developer Library)

◆ GetByNumber() [2/2]

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

Gets the name of the service asynchronously.

Parameters
aPortPort of the service.
aNameOn completion, the name of the service.
aStatusOn completion, KErrNone if successful otherwise another of the system-wide error codes.

(generated from Symbian Developer Library)

◆ Open()

IMPORT_C TInt RServiceResolver::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
aSocketServerThe socket server session.
anAddrFamilyA constant identifying the protocol family.
sockTypeA constant that identifies the socket type.
aProtocolA constant that identifies the protocol that provides the service.

(generated from Symbian Developer Library)

◆ RegisterService() [1/2]

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

Registers a new service.

Parameters
aNameName of the service.
aPortPort of the service.
capability
NetworkControl To protect against dangerous new services being added, which may steal legimate services resources

(generated from Symbian Developer Library)

◆ RegisterService() [2/2]

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

Registers a new service asynchronously.

Parameters
aNameName of the service.
aPortPort of the service.
aStatusOn completion, KErrNone if successful otherwise another of the system-wide error codes.
capability
NetworkControl To protect against dangerous new services being added, which may steal legimate services resources

(generated from Symbian Developer Library)

◆ RemoveService() [1/2]

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

Removes a service.

Parameters
aNameName of the service.
aPortPort of the service.
capability
NetworkControl Ensure that only privileged apps can remove information from the service resolver

(generated from Symbian Developer Library)

◆ RemoveService() [2/2]

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

Removes a service asynchronously.

Parameters
aNameName of the service to remove.
aPortPort of the service to remove.
aStatusOn completion, KErrNone if successful otherwise another of the system-wide error codes.
capability
NetworkControl Ensure that only privileged apps can remove information from the service resolver

(generated from Symbian Developer Library)


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