Zeroconf::CService

Zeroconf::CService Class Reference

A description of a service advertised on the local network. More...

#include <zeroconfservice.h>


Public Member Functions

const TDesC & ServiceName () const
 Returns the name of the advertised service.
const TDesC & ServiceTypeName () const
 Returns the type of the advertised service.
TServiceProtocol ServiceProtocol () const
 Returns the protocol the service runs over.
const TDesC & FullyQualifiedName () const
 Returns the fully qualified name of service.
const TDesC & HostName () const
 Returns the name of the host on which the service is running.
TUint16 Port () const
 Returns the port number on which the service is running.
const RPointerArray< CServiceParam > & Parameters () const
 Returns an array of parameters advertised with this service.
 ~CService ()
 Frees any memory associated with the service description.

Static Public Member Functions

static CServiceNewL (RReadStream &aReadStream)
 Constructs a new service description from the given read stream.

Protected Member Functions

 CService ()
 Constructs a new, empty service description.

Protected Attributes

HBufC * iServiceName
HBufC * iServiceType
TServiceProtocol iServiceProtocol
HBufC * iFullyQualifiedName
HBufC * iHostName
TUint16 iPort
RPointerArray< CServiceParamiParams

Detailed Description

A description of a service advertised on the local network.

A description of a service advertised by a host on the local network. The description includes the name of the service and the protocol over which it runs, together with the host and port on which the service is running, and any parameters the host is also providing with the service.


Constructor & Destructor Documentation

Zeroconf::CService::~CService (  ) 

Frees any memory associated with the service description.

Frees any memory associated with the service description.

Zeroconf::CService::CService (  )  [protected]

Constructs a new, empty service description.

Constructs a new, empty service description.


Member Function Documentation

static CService* Zeroconf::CService::NewL ( RReadStream &  aReadStream  )  [static]

Constructs a new service description from the given read stream.

Constructs a new service description from the given read stream.

Parameters:
aReadStrea The read stream from which to read the service description.
Returns:
A fully constructed service description object.

const TDesC& Zeroconf::CService::ServiceName (  )  const

Returns the name of the advertised service.

Returns the name of the advertised service as a unicode descriptor.

Returns:
The name of the advertised service.

const TDesC& Zeroconf::CService::ServiceTypeName (  )  const

Returns the type of the advertised service.

Returns the type of the advertised service as a unicode descriptor. The type name will include the leading underscore (e.g. '_http'.)

Returns:
The type of the advertised service.

TServiceProtocol Zeroconf::CService::ServiceProtocol (  )  const

Returns the protocol the service runs over.

Returns the protocol the service runs over. This will be one of TCP or UDP.

Returns:
The protocol the service runs over.

const TDesC& Zeroconf::CService::FullyQualifiedName (  )  const

Returns the fully qualified name of service.

Returns the fully qualified name of the service as a unicode descriptor. The fully qualified name includes the service name, its type and protocol together with the top level domain the service is advertised in (e.g. 'My Webserver._http._tcp.local'.)

Returns:
The fully qualified name of the service.

const TDesC& Zeroconf::CService::HostName (  )  const

Returns the name of the host on which the service is running.

Retuns the name of the host on which the service is running. This can be passed to RZeroconfSession::Resolve to get an IP address for the host running the service.

Returns:
The name of the host on which the service is running.

TUint16 Zeroconf::CService::Port (  )  const

Returns the port number on which the service is running.

Returns the port number on which the service is running on the remote host.

Returns:
The port number on which the service is running.

const RPointerArray<CServiceParam>& Zeroconf::CService::Parameters (  )  const

Returns an array of parameters advertised with this service.

Returns an array of key-value parameters advertised with this service.

Returns:
An array of parameters advertised with the service.