Package com.couchbase.client.core.service

Interface Service

All Superinterfaces:

Stateful<LifecycleState>

All Known Implementing Classes:

AbstractDynamicService, AbstractLazyService, AbstractOnDemandService, AbstractPoolingService, AnalyticsService, ConfigService, KeyValueService, OldAnalyticsService, OldKeyValueService, OldQueryService, OldSearchService, OldViewService, PooledService, QueryService, SearchService, ViewService

public interface Service
extends Stateful<LifecycleState>

Represents a Service on a Node.

Since:

1.0

Author:

Michael Nitschinger

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Service.EndpointFactory	A helper factory which generates endpoints.

Method Summary

Modifier and Type	Method	Description
rx.Observable<LifecycleState>	connect()	Connects all currently enabled Service Endpoints.
rx.Observable<EndpointHealth>	diagnostics()	Returns endpoint health information for all endpoints this service is currently associated with.
rx.Observable<LifecycleState>	disconnect()	Disconnects all currently enabled Service Endpoints.
BucketServiceMapping	mapping()	Returns the mapping for the given Service.
void	send(CouchbaseRequest request)	Sends a CouchbaseRequest into the service and eventually returns a CouchbaseResponse.
ServiceType	type()	Returns the type for the given Service.

Methods inherited from interface com.couchbase.client.core.state.Stateful

hasSubscribers, isState, state, states

Method Details

send

void send(CouchbaseRequest request)

Sends a CouchbaseRequest into the service and eventually returns a CouchbaseResponse. The CouchbaseResponse is not returned directly, but is wrapped into a Observable.

Parameters:

request - the request to send.

mapping

BucketServiceMapping mapping()

Returns the mapping for the given Service.

Returns:

the mapping.

type

ServiceType type()

Returns the type for the given Service.

Returns:

the type.

connect

rx.Observable<LifecycleState> connect()

Connects all currently enabled Service Endpoints.

Returns:

the states of the Service after the connect process for all enabled Endpoints.

disconnect

rx.Observable<LifecycleState> disconnect()

Disconnects all currently enabled Service Endpoints.

Returns:

the states of the Service after the disconnect process for all enabled Endpoints.

diagnostics

rx.Observable<EndpointHealth> diagnostics()

Returns endpoint health information for all endpoints this service is currently associated with.