Constant for id field of usage events.
Constant for record field of usage events.
Constant for type field of usage events.
Constant for event type Bind.
Constant for event type Release.
Closes the service discovery
Lookups for a single record.
Filters are expressed using a Json object. Each entry of the given filter will be checked against the record. All entry must match exactly the record. The entry can use the special "*" value to denotes a requirement on the key, but not on the value.
Let's take some example:
{ "name" = "a" } => matches records with name set fo "a"
{ "color" = "*" } => matches records with "color" set
{ "color" = "red" } => only matches records with "color" set to "red"
{ "color" = "red", "name" = "a"} => only matches records with name set to "a", and color set to "red"
If the filter is not set (null or empty), it accepts all records.
This method returns the first matching record.
Lookups for a single record.
Filters are expressed using a Json object. Each entry of the given filter will be checked against the record. All entry must match exactly the record. The entry can use the special "*" value to denotes a requirement on the key, but not on the value.
Let's take some example:
{ "name" = "a" } => matches records with name set fo "a"
{ "color" = "*" } => matches records with "color" set
{ "color" = "red" } => only matches records with "color" set to "red"
{ "color" = "red", "name" = "a"} => only matches records with name set to "a", and color set to "red"
If the filter is not set (null or empty), it accepts all records.
This method returns the first matching record.
Looks up for a single record by its registration id.
When there are no matching record, the operation succeeds, but the async result has no result (null).
Looks up for a single record by its registration id.
When there are no matching record, the operation succeeds, but the async result has no result (null).
Lookups for a single record.
The filter is a taking a Record as argument and returning a boolean. You should see it
as an accept method of a filter. This method return a record passing the filter.
This method only looks for records with a UP status.
Lookups for a single record.
The filter is a taking a Record as argument and returning a boolean. You should see it
as an accept method of a filter. This method return a record passing the filter.
This method only looks for records with a UP status.
Lookups for a single record.
The filter is a taking a Record as argument and returning a boolean. You should see it
as an accept method of a filter. This method return a record passing the filter.
Unlike {@link ServiceDiscovery#getRecord}, this method may accept records with a OUT OF SERVICE
status, if the includeOutOfService parameter is set to true.
Lookups for a single record.
The filter is a taking a Record as argument and returning a boolean. You should see it
as an accept method of a filter. This method return a record passing the filter.
Unlike {@link ServiceDiscovery#getRecord}, this method may accept records with a OUT OF SERVICE
status, if the includeOutOfService parameter is set to true.
Lookups for a set of records. Unlike {@link ServiceDiscovery#getRecord}, this method returns all matching records.
Lookups for a set of records. Unlike {@link ServiceDiscovery#getRecord}, this method returns all matching records.
Lookups for a set of records. Unlike {@link ServiceDiscovery#getRecord}, this method returns all matching records.
The filter is a taking a Record as argument and returning a boolean. You should see it
as an accept method of a filter. This method return a record passing the filter.
This method only looks for records with a UP status.
Lookups for a set of records. Unlike {@link ServiceDiscovery#getRecord}, this method returns all matching records.
The filter is a taking a Record as argument and returning a boolean. You should see it
as an accept method of a filter. This method return a record passing the filter.
This method only looks for records with a UP status.
Lookups for a set of records. Unlike {@link ServiceDiscovery#getRecord}, this method returns all matching records.
The filter is a taking a Record as argument and returning a boolean. You should see it
as an accept method of a filter. This method return a record passing the filter.
Unlike {@link ServiceDiscovery#getRecords}, this method may accept records with a OUT OF SERVICE
status, if the includeOutOfService parameter is set to true.
Lookups for a set of records. Unlike {@link ServiceDiscovery#getRecord}, this method returns all matching records.
The filter is a taking a Record as argument and returning a boolean. You should see it
as an accept method of a filter. This method return a record passing the filter.
Unlike {@link ServiceDiscovery#getRecords}, this method may accept records with a OUT OF SERVICE
status, if the includeOutOfService parameter is set to true.
Gets a service reference from the given record.
Gets a service reference from the given record, the reference is configured with the given json object.
Registers a discovery bridge. Exporters let you integrate other discovery technologies in this service discovery.
Registers a discovery bridge. Exporters let you integrate other discovery technologies in this service discovery.
Registers a discovery service importer. Importers let you integrate other discovery technologies in this service discovery.
Registers a discovery service importer. Importers let you integrate other discovery technologies in this service discovery.
Releases the service reference.
Un-publishes a record.
Un-publishes a record.
Creates an instance of ServiceDiscovery.
Creates a new instance of ServiceDiscovery using the default configuration.
Release the service object retrieved using get methods from the service type interface.
It searches for the reference associated with the given object and release it.
Generated using TypeDoc
Service Discovery main entry point.
The service discovery is an infrastructure that let you publish and find `services`. A `service` is a discoverable functionality. It can be qualified by its type, metadata, and location. So a `service` can be a database, a service proxy, a HTTP endpoint. It does not have to be a vert.x entity, but can be anything. Each service is described by a Record.
The service discovery implements the interactions defined in the service-oriented computing. And to some extend, also provides the dynamic service-oriented computing interaction. So, application can react to arrival and departure of services.
A service provider can:
* publish a service record * un-publish a published record * update the status of a published service (down, out of service...)
A service consumer can:
* lookup for services * bind to a selected service (it gets a ServiceReference) and use it * release the service once the consumer is done with it * listen for arrival, departure and modification of services.
Consumer would 1) lookup for service record matching their need, 2) retrieve the ServiceReference that give access to the service, 3) get a service object to access the service, 4) release the service object once done.
A state above, the central piece of information shared by the providers and consumers are records.
Providers and consumers must create their own ServiceDiscovery instance. These instances are collaborating in background (distributed structure) to keep the set of services in sync.