org.rvpf.base.util.rlp

Class RLPClient

Object

RLPClient

@ThreadSafe
public class RLPClient
extends Object

RLP client.

Represents a process that need to locate resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RLPClient.Builder Builder.

Method Summary

Modifier and Type	Method and Description
void	close() Closes.
Optional<ResourceSpecifier[]>	doYouProvide(ResourceProvider resourceProvider, ResourceSpecifier[] resourceSpecifiers, boolean local, ElapsedTime timeout) Do you provide.
static RLPClient.Builder	newBuilder() Returns a new builder.
Optional<ResourceProvider[]>	whoProvides(ResourceProvider resourceProvider, ResourceSpecifier[] resourceSpecifiers, boolean local, ElapsedTime maximumWait, ElapsedTime minimumWait) Who provides.

Methods inherited from class Object

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

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static RLPClient.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

close

public void close()

Closes.

doYouProvide

@Nonnull
 @CheckReturnValue
public Optional<ResourceSpecifier[]> doYouProvide(@Nonnull
                                                                                ResourceProvider resourceProvider,
                                                                                @Nonnull
                                                                                ResourceSpecifier[] resourceSpecifiers,
                                                                                boolean local,
                                                                                @Nonnull
                                                                                ElapsedTime timeout)
                                                                         throws IOException,
                                                                                InterruptedByTimeoutException

Do you provide.

Parameters:

resourceProvider - A resource provider.

resourceSpecifiers - The resource specifiers.

local - True for local resource providers.

timeout - The timeout interval.

Returns:

The resource providers (empty optional on timeout or socket closed).

Throws:

IOException - On failure.

InterruptedByTimeoutException - When interrupted by timeout.

whoProvides

@Nonnull
 @CheckReturnValue
public Optional<ResourceProvider[]> whoProvides(@Nonnull
                                                                              ResourceProvider resourceProvider,
                                                                              @Nonnull
                                                                              ResourceSpecifier[] resourceSpecifiers,
                                                                              boolean local,
                                                                              @Nonnull
                                                                              ElapsedTime maximumWait,
                                                                              @Nonnull
                                                                              ElapsedTime minimumWait)
                                                                       throws IOException

Who provides.

This method waits a maximum amount of time to receive at least one response. After each response, it will also wait a minimum amount of time to get an other.

Parameters:

resourceProvider - A resource provider (broadcast).

resourceSpecifiers - The resource specifiers.

local - True for local resource providers.

maximumWait - The maximum time to wait.

minimumWait - The minimum time to wait.

Returns:

The resource providers (null on timeout or socket closed).

Throws:

IOException - On failure.