com.here.mobility.sdk.core.net

Class ClientBase<ClientT extends INetworkClient>

java.lang.Object

com.here.mobility.sdk.core.net.ClientBase<ClientT>

Type Parameters:

ClientT - the specific NetworkClient

All Implemented Interfaces:

INetworkClient

Direct Known Subclasses:

GeocodingClient, RoutingClient, TimeZoneClient

public class ClientBase<ClientT extends INetworkClient>
extends Object
implements INetworkClient

A base class for facade client classes

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientT	client The NetworkClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientBase(ClientT client) Generate new Client

Method Summary

Modifier and Type	Method and Description
void	cancelAllActiveRequests() Cancels all active requests this client has running.
void	shutdown() Shuts down this INetworkClient.
void	shutdownNow() Shuts down this INetworkClient immediately, forcefully closing even preexisting calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

client

protected final ClientT extends INetworkClient client

The NetworkClient

Constructor Detail

ClientBase

protected ClientBase(ClientT client)

Generate new Client

Method Detail

cancelAllActiveRequests

public void cancelAllActiveRequests()

Description copied from interface: INetworkClient

Cancels all active requests this client has running. Note that this doesn't necessarily stop any underlying sending of data through the network. The only guarantee is that no response listeners will be called. Implementation note: unfortunately, GRPC stream requests provide no way to cancel them, so these are not currently cancelled.

Specified by:

cancelAllActiveRequests in interface INetworkClient

shutdown

public void shutdown()

Description copied from interface: INetworkClient

Shuts down this INetworkClient. All active requests are cancelled, and the underlying channel is shutdown cleanly (requests in progress will finish, but no new ones will be accepted). Note that any streaming requests may continue indefinitely.

Specified by:

shutdown in interface INetworkClient

shutdownNow

public void shutdownNow()

Description copied from interface: INetworkClient

Shuts down this INetworkClient immediately, forcefully closing even preexisting calls. This is the preferred method to call when using INetworkClient from an Android activity or service that is finishing, because it should guarantee that no further callbacks will be invoked.

Specified by:

shutdownNow in interface INetworkClient