io.smallrye.mutiny.subscription.ContextSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mutiny Show documentation

Intuitive Event-Driven Reactive Programming Library for Java

There is a newer version: 2.7.0

package io.smallrye.mutiny.subscription;

import io.smallrye.mutiny.Context;

/**
 * Interface for subscribers and types that provide a {@link Context}.
 */
public interface ContextSupport {

    /**
     * Provide a context.
     * 
     * Since calls to this method shall only be triggered when a Mutiny pipeline uses a {@code withContext} operator,
     * there is no need in general for caching the context value in a field of the implementing class.
     * Exceptions include operators that have cross-subscriber semantics such as memoizers or broadcasters.
     * 
     * This method is expected to be called once per {@code withContext} operator.
     *
     * @return the context, must not be {@code null}.
     */
    default Context context() {
        return Context.empty();
    }
}