vertx / io.vertx.rxjava.ext.consul / ConsulClient / rxListEventsWithOptions

# rxListEventsWithOptions

`open fun rxListEventsWithOptions(options: EventListOptions): Single<EventList>`

Returns the most recent events known by the agent. This is blocking query unlike `io.vertx.rxjava.ext.consul.ConsulClient#listEvents`. However, the semantics of this endpoint are slightly different. Most blocking queries provide a monotonic index and block until a newer index is available. This can be supported as a consequence of the total ordering of the consensus protocol. With gossip, there is no ordering, and instead `X-Consul-Index` maps to the newest event that matches the query.

In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.

### Parameters

`options` - the blocking options

Return