Project: /_project.yaml Book: /_book.yaml

fuchsia.net.mdns

PROTOCOLS

Resolver {:#Resolver}

Defined in fuchsia.net.mdns/mdns.fidl

Discoverable protocol for resolving host names to IP addresses.

ResolveHostName {:#ResolveHostName}

Gets the addresses for the specified host. timeout specifies how long the service should wait before giving up when waiting for a response to a resolution query. In typical use, a timeout of two or three seconds is recommended.

A successful resolution may return one or both addresses. An unsuccessful resolution is indicated when both addresses are null.

Request

Response

Subscriber {:#Subscriber}

Defined in fuchsia.net.mdns/mdns.fidl

Discoverable protocol for finding service instances.

SubscribeToService {:#SubscribeToService}

Subscribes to a service. The subscription lasts until subscriber is unbound.

Request

Publisher {:#Publisher}

Defined in fuchsia.net.mdns/mdns.fidl

Discoverable protocol for publishing service instances.

PublishServiceInstance {:#PublishServiceInstance}

Publishes a service instance. publication_responder is consulted via its OnPublication method for initial announcements and to answer queries. The service is published until the publication_responder channel closes. In addition to announcements and queries for the service type, all queries for subtypes are answered subject to filtering through the responder. perform_probe indicates whether a probe for a conflicting instance should be performed before publishing the instance. This value should be true unless the instance name is known to be unique.

Request

Response

ServiceSubscriber {:#ServiceSubscriber}

Defined in fuchsia.net.mdns/mdns.fidl

Client-implemented interface for subscribers. Method replies are used to throttle traffic. The service won't necessarily wait for a reply before calling another method.

OnInstanceDiscovered {:#OnInstanceDiscovered}

Notifies the subscriber that a service instance has been discovered.

Request

Response

OnInstanceChanged {:#OnInstanceChanged}

Notifies the subscriber that addresses or text for a known service instance have changed.

Request

Response

OnInstanceLost {:#OnInstanceLost}

Notifies the subscriber that a known service instance has been lost.

Request

Response

PublicationResponder {:#PublicationResponder}

Defined in fuchsia.net.mdns/mdns.fidl

Client-supplied publication responder interface.

OnPublication {:#OnPublication}

Provides instance information for initial announcements and query responses relating to the service instance specified in Publisher.PublishServiceInstance. query indicates whether data is requested for an initial announcement (false) or in response to a query (true). If the publication relates to a subtype of the service, subtype contains the subtype, otherwise it is null. If publication is null, no announcement or response is transmitted. Strings in text are transmitted in the TXT record.

Request

Response

SetSubtypes {:#SetSubtypes}

Sets the subtypes for the service instance. The specified subtypes will be announced subject to filtering through the responder. The initial subtype collection is empty.

Response

Reannounce {:#Reannounce}

Initiates reannouncement of the service instance due to a change in the instance's port number or text strings. All announcements are filtered through OnPublication, which replies with the new port and text values.

Response

Resolver {:#Resolver}

Defined in fuchsia.net.mdns/mdns.fidl

Discoverable protocol for resolving host names to IP addresses.

ResolveHostName {:#ResolveHostName}

Gets the addresses for the specified host. timeout specifies how long the service should wait before giving up when waiting for a response to a resolution query. In typical use, a timeout of two or three seconds is recommended.

A successful resolution may return one or both addresses. An unsuccessful resolution is indicated when both addresses are null.

Request

Response

Subscriber {:#Subscriber}

Defined in fuchsia.net.mdns/mdns.fidl

Discoverable protocol for finding service instances.

SubscribeToService {:#SubscribeToService}

Subscribes to a service. The subscription lasts until subscriber is unbound.

Request

Publisher {:#Publisher}

Defined in fuchsia.net.mdns/mdns.fidl

Discoverable protocol for publishing service instances.

PublishServiceInstance {:#PublishServiceInstance}

Publishes a service instance. publication_responder is consulted via its OnPublication method for initial announcements and to answer queries. The service is published until the publication_responder channel closes. In addition to announcements and queries for the service type, all queries for subtypes are answered subject to filtering through the responder. perform_probe indicates whether a probe for a conflicting instance should be performed before publishing the instance. This value should be true unless the instance name is known to be unique.

Request

Response

ServiceSubscriber {:#ServiceSubscriber}

Defined in fuchsia.net.mdns/mdns.fidl

Client-implemented interface for subscribers. Method replies are used to throttle traffic. The service won't necessarily wait for a reply before calling another method.

OnInstanceDiscovered {:#OnInstanceDiscovered}

Notifies the subscriber that a service instance has been discovered.

Request

Response

OnInstanceChanged {:#OnInstanceChanged}

Notifies the subscriber that addresses or text for a known service instance have changed.

Request

Response

OnInstanceLost {:#OnInstanceLost}

Notifies the subscriber that a known service instance has been lost.

Request

Response

PublicationResponder {:#PublicationResponder}

Defined in fuchsia.net.mdns/mdns.fidl

Client-supplied publication responder interface.

OnPublication {:#OnPublication}

Provides instance information for initial announcements and query responses relating to the service instance specified in Publisher.PublishServiceInstance. query indicates whether data is requested for an initial announcement (false) or in response to a query (true). If the publication relates to a subtype of the service, subtype contains the subtype, otherwise it is null. If publication is null, no announcement or response is transmitted. Strings in text are transmitted in the TXT record.

Request

Response

SetSubtypes {:#SetSubtypes}

Sets the subtypes for the service instance. The specified subtypes will be announced subject to filtering through the responder. The initial subtype collection is empty.

Response

Reannounce {:#Reannounce}

Initiates reannouncement of the service instance due to a change in the instance's port number or text strings. All announcements are filtered through OnPublication, which replies with the new port and text values.

Response

STRUCTS

Publisher_PublishServiceInstance_Response {:#Publisher_PublishServiceInstance_Response}

generated

ServiceInstance {:#ServiceInstance}

Defined in fuchsia.net.mdns/mdns.fidl

Describes a service instance.

Publication {:#Publication}

Defined in fuchsia.net.mdns/mdns.fidl

Describes an initial instance announcement or query response. In typical use, the default SRV priority, SRV weight and TTL values should be used. TTL values are rounded down to the nearest second. TTL values less than one second are not permitted and will result in the PublicationResponder channel being closed.

Publisher_PublishServiceInstance_Response {:#Publisher_PublishServiceInstance_Response}

generated

ServiceInstance {:#ServiceInstance}

Defined in fuchsia.net.mdns/mdns.fidl

Describes a service instance.

Publication {:#Publication}

Defined in fuchsia.net.mdns/mdns.fidl

Describes an initial instance announcement or query response. In typical use, the default SRV priority, SRV weight and TTL values should be used. TTL values are rounded down to the nearest second. TTL values less than one second are not permitted and will result in the PublicationResponder channel being closed.

ENUMS

Error {:#Error}

Type: int32

Defined in fuchsia.net.mdns/mdns.fidl

Error values for instance publishing.

Error {:#Error}

Type: int32

Defined in fuchsia.net.mdns/mdns.fidl

Error values for instance publishing.

UNIONS

Publisher_PublishServiceInstance_Result {:#Publisher_PublishServiceInstance_Result}

generated

Publisher_PublishServiceInstance_Result {:#Publisher_PublishServiceInstance_Result}

generated

CONSTANTS