com.github.dm.jrt.android.core

Class JRoutine

java.lang.Object

com.github.dm.jrt.core.JRoutine

com.github.dm.jrt.android.core.JRoutine

Direct Known Subclasses:

JRoutine, JRoutine

public class JRoutine
extends JRoutine

This utility class extends the base one in order to support additional routine builders specific to the Android platform.
Routine invocations created through the returned builder will be executed inside a service specified by the service context. Be aware, though, that the invocation results will be dispatched into the configured looper, so that, waiting for the outputs on the very same looper thread, immediately after its invocation, will result in a deadlock.
By default output results are dispatched in the main looper.
Note that the configuration of the maximum number of concurrent invocations will not be shared among synchronous and asynchronous invocations, but the invocations created inside the service and the synchronous will respect the same limit separately.

It is up to the caller to properly declare the service in the manifest file. Note also that it is possible to manage the service lifecycle starting it through the Context.startService(android.content.Intent) method. Normally the service will stay active only during a routine invocation. In fact, it is responsibility of the caller to ensure that the started invocations have completed or have been aborted when the relative context (for example the activity) is destroyed, so to avoid the leak of IPC connections.
The service can be also made run in a different process, however, in such case, the data passed through the routine input and output channels, as well as the factory arguments, must comply with the Parcel.writeValue(Object) method. Be aware though, that issues may arise when employing Serializable objects on some OS versions, so, it is advisable to use Parcelable objects instead.

For example, in order to get a resource from the network, needed to fill an activity UI:

     

         @Override
         protected void onCreate(final Bundle savedInstanceState) {

             super.onCreate(savedInstanceState);
             setContentView(R.layout.my_activity_layout);

             final Routine<URI, MyResource> routine =
                     JRoutine.on(serviceFrom(this), targetInvocation(LoadResourceUri.class))
                             .buildRoutine();
             routine.asyncCall(RESOURCE_URI)
                    .passTo(new TemplateOutputConsumer<MyResource>() {

                        @Override
                        public void onError(@Nullable final Throwable error) {

                            displayError(error);
                        }

                        @Override
                        public void onOutput(final MyResource resource) {

                            displayResource(resource);
                        }
                    });
         }
     
 

Created by davide-maestroni on 01/08/2015.

Constructor Summary

Constructors

Constructor and Description
JRoutine()

Method Summary

Methods

Modifier and Type	Method and Description
static ServiceObjectRoutineBuilder	on(ServiceContext context, ContextInvocationTarget target) Returns a builder of routines running in a service based on the specified context, wrapping the specified target object. In order to customize the object creation, the caller must employ an implementation of a FactoryContext as the invocation service.
static <IN,OUT> ServiceRoutineBuilder<IN,OUT>	on(ServiceContext context, InvocationFactoryTarget<IN,OUT> target) Returns a builder of routines running in a service based on the specified context. In order to customize the invocation creation, the caller must override the method getInvocationFactory(InvocationFactoryTarget) of the routine service.

Methods inherited from class com.github.dm.jrt.core.JRoutine

on, on, transport

Methods inherited from class java.lang.Object

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

Constructor Detail

JRoutine

public JRoutine()

Method Detail

on

@Nonnull
public static ServiceObjectRoutineBuilder on(@Nonnull
                                     ServiceContext context,
                                     @Nonnull
                                     ContextInvocationTarget target)

Returns a builder of routines running in a service based on the specified context, wrapping the specified target object.
In order to customize the object creation, the caller must employ an implementation of a FactoryContext as the invocation service.

Note that the built routine results will be dispatched into the configured looper, thus, waiting for the outputs on the very same looper thread, immediately after its invocation, will result in a deadlock.
By default output results are dispatched in the main looper.

Parameters:

context - the service context.

target - the invocation target.

Returns:

the routine builder instance.

on

@Nonnull
public static <IN,OUT> ServiceRoutineBuilder<IN,OUT> on(@Nonnull
                                                ServiceContext context,
                                                @Nonnull
                                                InvocationFactoryTarget<IN,OUT> target)

Returns a builder of routines running in a service based on the specified context.
In order to customize the invocation creation, the caller must override the method getInvocationFactory(InvocationFactoryTarget) of the routine service.

Note that the built routine results will be dispatched into the configured looper, thus, waiting for the outputs on the very same looper thread, immediately after its invocation, will result in a deadlock.
By default output results are dispatched in the main looper.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

context - the service context.

target - the invocation target.

Returns:

the routine builder instance.