Zeroconf::TZeroconfMessage Class Reference
A message from the zeroconf server reporting an event. More...
#include <zeroconfmessage.h>
Public Member Functions | |
| TZeroconfMessage () | |
| Constructs a new, empty zeroconf server message. | |
| TZeroconfMessage (TZeroconfMessageType aType, TZeroconfMessageStatus aStatus, const TDesC8 &aName) | |
| Constructs a new, populated zeroconf server message. | |
| HBufC * | NameL () const |
| Returns the name of the entity described in the message. | |
| HBufC * | ServiceTypeL () const |
| Returns the service type of the entity described in the message. | |
| TZeroconfMessageType | Type () const |
| Returns the type of the message. | |
| TZeroconfMessageStatus | Status () const |
| Returns the status of the entity described in the message. | |
| TServiceProtocol | Protocol () const |
| Returns the protocol of the entity described in the message. | |
| void | SetServiceType (const TDesC8 &aServiceType) |
| Sets the service type for this message. | |
| void | SetServiceProtocol (TServiceProtocol aProtocol) |
| Sets the protocol for this message. | |
Detailed Description
A message from the zeroconf server reporting an event.A message from the zeroconf server reporting an event. Events reported include the addition, removal and update of hosts, services and service types on the local network.
Constructor & Destructor Documentation
| Zeroconf::TZeroconfMessage::TZeroconfMessage | ( | ) |
Constructs a new, empty zeroconf server message.
Constructs a new, empty zeroconf server message.
| Zeroconf::TZeroconfMessage::TZeroconfMessage | ( | TZeroconfMessageType | aType, | |
| TZeroconfMessageStatus | aStatus, | |||
| const TDesC8 & | aName | |||
| ) |
Constructs a new, populated zeroconf server message.
Constructs a new zeroconf server message with the give type, status and name.
- Parameters:
-
aType The type of the message. aStatus The status of the name refered to by this message. aName The name of the entity referred to by his message.
Member Function Documentation
| HBufC* Zeroconf::TZeroconfMessage::NameL | ( | ) | const |
Returns the name of the entity described in the message.
Returns the name of the name of the entity described in the message. For Host messages, the name of the host. For Service messages, the name of the service and for Service Type messages the name of the service type.
The caller is responsible for freeing the memory used by the name.
- Returns:
- A unicode descriptor containing the name of the entity described in the message.
| HBufC* Zeroconf::TZeroconfMessage::ServiceTypeL | ( | ) | const |
Returns the service type of the entity described in the message.
Returns the service type of the entity described in the message. This is only relevant for Service messages. For all other messages it will return an empty descriptor.
The caller is responsible for freeing the memory used by the type.
- Returns:
- A unicode descriptor containing the service type of the entity described in the message.
| TZeroconfMessageType Zeroconf::TZeroconfMessage::Type | ( | ) | const |
Returns the type of the message.
Returns the type of the message. This is one of a Host, Service or Service type message.
- Returns:
- The type of the message.
| TZeroconfMessageStatus Zeroconf::TZeroconfMessage::Status | ( | ) | const |
Returns the status of the entity described in the message.
Returns the status of the entity described in the message. The entity may have been either new, removed or updated
- Returns:
- The status of the entity described in the message.
| TServiceProtocol Zeroconf::TZeroconfMessage::Protocol | ( | ) | const |
Returns the protocol of the entity described in the message.
Returns the protocol of the entity described in the message. This is only meaningful for Service and Service Type messages. For any other message it will return EServiceProtocolUnknown.
- Returns:
- The protocol of the entity described in the message.
| void Zeroconf::TZeroconfMessage::SetServiceType | ( | const TDesC8 & | aServiceType | ) |
Sets the service type for this message.
Sets the service type for this message.
- Parameters:
-
aServiceType The service type to set.
| void Zeroconf::TZeroconfMessage::SetServiceProtocol | ( | TServiceProtocol | aProtocol | ) |
Sets the protocol for this message.
Sets the service protocol for this message.
- Parameters:
-
aProtocol The protocol to set.