Class DefaultRPCImplementationBuilder<T>

java.lang.Object

eu.cloudnetservice.driver.network.rpc.defaults.generation.DefaultRPCImplementationBuilder<T>

Type Parameters:

T - the type that is being implemented.

All Implemented Interfaces:

RPCImplementationBuilder<T>, RPCProvider.Builder<RPCImplementationBuilder<T>>

public final class DefaultRPCImplementationBuilder<T>
extends Object
implements RPCImplementationBuilder<T>

The default implementation of a rpc implementation builder.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	DefaultRPCImplementationBuilder.DefaultInstanceAllocator<T>	The default implementation of an instance allocator using an internal instance factory as delegation.

Nested classes/interfaces inherited from interface eu.cloudnetservice.driver.network.rpc.factory.RPCImplementationBuilder

RPCImplementationBuilder.InstanceAllocator<T>

Field Summary

Fields

Modifier and Type	Field	Description
private Supplier<NetworkChannel>	channelSupplier
private final RPCClassMetadata	classMetadata
private DataBufFactory	dataBufFactory
private final RPCClassMetadata	fullClasMetadata
private final RPCGenerationCache	generationCache
private int	generationFlags
private ObjectMapper	objectMapper
private Class<?>	senderTargetClass
private final RPCFactory	sourceFactory

Constructor Summary

Constructors

Constructor	Description
DefaultRPCImplementationBuilder(@NonNull RPCFactory sourceFactory, @NonNull ObjectMapper objectMapper, @NonNull DataBufFactory dataBufFactory, @NonNull RPCClassMetadata classMetadata, @NonNull RPCGenerationCache generationCache)	Constructs a new default implementation builder instance.

Method Summary

Modifier and Type	Method	Description
@NonNull RPCImplementationBuilder<T>	dataBufFactory(@NonNull DataBufFactory dataBufFactory)	Sets the data buf factory to use for everything that is related with data serialization in the final rpc provider.
@NonNull RPCImplementationBuilder<T>	excludeMethod(@NonNull String name, @NonNull TypeDescriptor methodDescriptor)	Excludes the method in the target class that has the given name and method descriptor from being available for RPC execution.
@NonNull RPCImplementationBuilder.InstanceAllocator<T>	generateImplementation()	Generates an implementation of the target class and returns an allocator which can be used to construct an instance of the generated class.
@NonNull RPCImplementationBuilder<T>	implementConcreteMethods()	Enables that concrete methods (methods that are non-abstract and already have an implementation in the extending class or interfaces) should be implemented with RPC calls anyway.
@NonNull RPCImplementationBuilder<T>	objectMapper(@NonNull ObjectMapper objectMapper)	Sets the object mapper for serialization of objects during RPC execution related to the final rpc provider.
@NonNull RPCImplementationBuilder<T>	superclass(@NonNull Class<? super T> superclass)	Sets the superclass to use for rpc executions.
@NonNull RPCImplementationBuilder<T>	targetChannel(@NonNull NetworkChannel channel)	Sets the singleton channel that will be used to send all RPCs to.
@NonNull RPCImplementationBuilder<T>	targetChannel(@NonNull Supplier<NetworkChannel> channelSupplier)	Sets the supplier to use to resolve the network channel to which RPCs should be sent.
@NonNull RPCImplementationBuilder<T>	targetComponent(@NonNull NetworkComponent networkComponent)	Sets the network component to use for obtaining the network channel to send RPCs to.

Methods inherited from class java.lang.Object

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

Field Details

sourceFactory

private final RPCFactory sourceFactory

classMetadata

private final RPCClassMetadata classMetadata

fullClasMetadata

private final RPCClassMetadata fullClasMetadata

generationCache

private final RPCGenerationCache generationCache

generationFlags

private int generationFlags

objectMapper

private ObjectMapper objectMapper

senderTargetClass

private Class<?> senderTargetClass

dataBufFactory

private DataBufFactory dataBufFactory

channelSupplier

private Supplier<NetworkChannel> channelSupplier

Constructor Details

DefaultRPCImplementationBuilder

public DefaultRPCImplementationBuilder(@NonNull
 @NonNull RPCFactory sourceFactory,
 @NonNull
 @NonNull ObjectMapper objectMapper,
 @NonNull
 @NonNull DataBufFactory dataBufFactory,
 @NonNull
 @NonNull RPCClassMetadata classMetadata,
 @NonNull
 @NonNull RPCGenerationCache generationCache)

Constructs a new default implementation builder instance.

Parameters:

classMetadata - the metadata of class that is being implemented.

generationCache - the cache for all generated implementations.

Throws:

NullPointerException - if the given class meta, sender builder or generation cache is null.

Method Details

superclass

@NonNull
public @NonNull RPCImplementationBuilder<T> superclass(@NonNull
 @NonNull Class<? super T> superclass)

Sets the superclass to use for rpc executions. The given class must be the superclass of the actual target of this builder and will be used when invoking methods on the remote. Handlers on the remote must be bound to this class rather than the target class of this builder.

Specified by:

superclass in interface RPCImplementationBuilder<T>

Parameters:

superclass - the actual superclass to use as the target for rpc invocations.

Returns:

this builder, for chaining.

targetComponent

@NonNull
public @NonNull RPCImplementationBuilder<T> targetComponent(@NonNull
 @NonNull NetworkComponent networkComponent)

Sets the network component to use for obtaining the network channel to send RPCs to. For that purpose the first channel of the given component is always used. An exception during RPC execution will be thrown if the first channel of the component every becomes null or closed.

Specified by:

targetComponent in interface RPCImplementationBuilder<T>

Parameters:

networkComponent - the network component to use the first channel of during RPC execution.

Returns:

this builder, for chaining.

targetChannel

@NonNull
public @NonNull RPCImplementationBuilder<T> targetChannel(@NonNull
 @NonNull NetworkChannel channel)

Sets the singleton channel that will be used to send all RPCs to. The target channel should not be closed while this sender is in use.

Specified by:

targetChannel in interface RPCImplementationBuilder<T>

Parameters:

channel - the channel to which all RPCs that are using this sender are sent to.

Returns:

this builder, for chaining.

targetChannel

@NonNull
public @NonNull RPCImplementationBuilder<T> targetChannel(@NonNull
 @NonNull Supplier<NetworkChannel> channelSupplier)

Sets the supplier to use to resolve the network channel to which RPCs should be sent. The given supplier is called every time the channel is needed, and is allowed to change over time. An exception during RPC execution will be thrown if this supplier ever returns null or a channel that is closed.

Specified by:

targetChannel in interface RPCImplementationBuilder<T>

Parameters:

channelSupplier - the supplier to call to obtain the target channel for RPCs.

Returns:

this builder, for chaining.

implementConcreteMethods

@NonNull
public @NonNull RPCImplementationBuilder<T> implementConcreteMethods()

Enables that concrete methods (methods that are non-abstract and already have an implementation in the extending class or interfaces) should be implemented with RPC calls anyway.

Specified by:

implementConcreteMethods in interface RPCImplementationBuilder<T>

Returns:

this builder, for chaining.

excludeMethod

@NonNull
public @NonNull RPCImplementationBuilder<T> excludeMethod(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull TypeDescriptor methodDescriptor)

Excludes the method in the target class that has the given name and method descriptor from being available for RPC execution. It does not mean that the method will not be implemented in the generated class.

Specified by:

excludeMethod in interface RPCImplementationBuilder<T>

Parameters:

name - the name of the method to exclude.

methodDescriptor - the descriptor of the method to exclude.

Returns:

this builder, for chaining.

objectMapper

@NonNull
public @NonNull RPCImplementationBuilder<T> objectMapper(@NonNull
 @NonNull ObjectMapper objectMapper)

Sets the object mapper for serialization of objects during RPC execution related to the final rpc provider.

Specified by:

objectMapper in interface RPCProvider.Builder<T>

Parameters:

objectMapper - the object mapper to use.

Returns:

this builder, for chaining.

dataBufFactory

@NonNull
public @NonNull RPCImplementationBuilder<T> dataBufFactory(@NonNull
 @NonNull DataBufFactory dataBufFactory)

Sets the data buf factory to use for everything that is related with data serialization in the final rpc provider.

Specified by:

dataBufFactory in interface RPCProvider.Builder<T>

Parameters:

dataBufFactory - the data buf factory to use.

Returns:

this builder, for chaining.

generateImplementation

@NonNull
public @NonNull RPCImplementationBuilder.InstanceAllocator<T> generateImplementation()

Generates an implementation of the target class and returns an allocator which can be used to construct an instance of the generated class.

Specified by:

generateImplementation in interface RPCImplementationBuilder<T>

Returns:

an allocator which can be used to construct an instance of the underlying class.