com.pushtechnology.diffusion.client.callbacks.ContextStream Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2014, 2023 DiffusionData Ltd., All Rights Reserved.
*
* Use is subject to licence terms.
*
* NOTICE: All information contained herein is, and remains the
* property of DiffusionData. The intellectual and technical
* concepts contained herein are proprietary to DiffusionData and
* may be covered by U.S. and Foreign Patents, patents in process, and
* are protected by trade secret or copyright law.
*******************************************************************************/
package com.pushtechnology.diffusion.client.callbacks;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An extension of {@link ContextCallback} that allows many callbacks for each
* call context.
*
* This interface and its extensions are alternatives to the {@link Stream}
* interface hierarchy that allow the application to associate an arbitrary
* context object with each call. Any suitable application object can be
* provided as the context. It will be passed on to the corresponding callback
* methods, allowing requests and responses to be correlated. The context object
* is optional (it may be {@code null}).
*
* In all other respects {@link Stream} and {@link ContextStream} behave
* identically.
*
* @author DiffusionData Limited
* @since 5.1
* @param context object type
*
* @deprecated since 6.7
*
* Methods that use contextual callbacks are deprecated and will be
* removed in a future release. Use CompletableFuture variant
* instead.
*/
@Deprecated
public interface ContextStream extends ContextCallback {
/**
* Notification that a call context was closed normally. No further calls
* will be made to this callback.
*
* @param context the context object the application supplied when making
* the call; may be {@code null}
*/
void onClose(C context);
/**
* Abstract default callback.
*
* This simply logs an onClose call at 'debug' level. This method should be
* overridden for more specific processing.
*
* @param context object type
*/
abstract class Default
extends ContextCallback.Default
implements ContextStream {
private static final Logger LOG =
LoggerFactory.getLogger(ContextStream.Default.class);
@Override
public void onClose(C context) {
LOG.debug("{} stream closed, context={}", this, context);
}
}
}