com.nike.riposte.server.error.exception.DownstreamIdleChannelTimeoutException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of riposte-spi Show documentation

Riposte module riposte-spi

There is a newer version: 0.20.0

package com.nike.riposte.server.error.exception;

import io.netty.channel.Channel;

/**
 * This will be thrown when a Netty {@link io.netty.channel.Channel} used for an async downstream call sits idle beyond
 * the specified timeout value. This generally occurs in two situations:
 * 
 *     An active downstream call takes too long to return and passes the timeout threshold.
 *     
 *         A pooled connection sits idle beyond the threshold (no active downstream call, just sitting in the pool
 *         unused).
 *     
 * 
 *
 * @author Nic Munroe
 */
public class DownstreamIdleChannelTimeoutException extends RuntimeException {

    public final long timeoutValueMillis;
    public final String channelId;

    public DownstreamIdleChannelTimeoutException(long timeoutValueMillis, Channel channel) {
        super("The downstream channel was idle too long. downstream_channel_timeout_value_millis=" + timeoutValueMillis
              + ", idle_channel_id=" + getChannelId(channel)
        );
        this.timeoutValueMillis = timeoutValueMillis;
        this.channelId = getChannelId(channel);
    }

    @SuppressWarnings("WeakerAccess")
    protected static String getChannelId(Channel channel) {
        if (channel == null)
            return "null";

        return channel.toString();
    }
}