Wed, 31 Dec 2014 07:22:50 +0100
Correct previous dual key logic pending first delivery installment.
michael@0 | 1 | /* |
michael@0 | 2 | * ==================================================================== |
michael@0 | 3 | * Licensed to the Apache Software Foundation (ASF) under one |
michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
michael@0 | 5 | * distributed with this work for additional information |
michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
michael@0 | 8 | * "License"); you may not use this file except in compliance |
michael@0 | 9 | * with the License. You may obtain a copy of the License at |
michael@0 | 10 | * |
michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
michael@0 | 12 | * |
michael@0 | 13 | * Unless required by applicable law or agreed to in writing, |
michael@0 | 14 | * software distributed under the License is distributed on an |
michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
michael@0 | 16 | * KIND, either express or implied. See the License for the |
michael@0 | 17 | * specific language governing permissions and limitations |
michael@0 | 18 | * under the License. |
michael@0 | 19 | * ==================================================================== |
michael@0 | 20 | * |
michael@0 | 21 | * This software consists of voluntary contributions made by many |
michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
michael@0 | 23 | * information on the Apache Software Foundation, please see |
michael@0 | 24 | * <http://www.apache.org/>. |
michael@0 | 25 | * |
michael@0 | 26 | */ |
michael@0 | 27 | |
michael@0 | 28 | package ch.boye.httpclientandroidlib.conn.routing; |
michael@0 | 29 | |
michael@0 | 30 | /** |
michael@0 | 31 | * Provides directions on establishing a route. |
michael@0 | 32 | * Implementations of this interface compare a planned route with |
michael@0 | 33 | * a tracked route and indicate the next step required. |
michael@0 | 34 | * |
michael@0 | 35 | * @since 4.0 |
michael@0 | 36 | */ |
michael@0 | 37 | public interface HttpRouteDirector { |
michael@0 | 38 | |
michael@0 | 39 | /** Indicates that the route can not be established at all. */ |
michael@0 | 40 | public final static int UNREACHABLE = -1; |
michael@0 | 41 | |
michael@0 | 42 | /** Indicates that the route is complete. */ |
michael@0 | 43 | public final static int COMPLETE = 0; |
michael@0 | 44 | |
michael@0 | 45 | /** Step: open connection to target. */ |
michael@0 | 46 | public final static int CONNECT_TARGET = 1; |
michael@0 | 47 | |
michael@0 | 48 | /** Step: open connection to proxy. */ |
michael@0 | 49 | public final static int CONNECT_PROXY = 2; |
michael@0 | 50 | |
michael@0 | 51 | /** Step: tunnel through proxy to target. */ |
michael@0 | 52 | public final static int TUNNEL_TARGET = 3; |
michael@0 | 53 | |
michael@0 | 54 | /** Step: tunnel through proxy to other proxy. */ |
michael@0 | 55 | public final static int TUNNEL_PROXY = 4; |
michael@0 | 56 | |
michael@0 | 57 | /** Step: layer protocol (over tunnel). */ |
michael@0 | 58 | public final static int LAYER_PROTOCOL = 5; |
michael@0 | 59 | |
michael@0 | 60 | |
michael@0 | 61 | /** |
michael@0 | 62 | * Provides the next step. |
michael@0 | 63 | * |
michael@0 | 64 | * @param plan the planned route |
michael@0 | 65 | * @param fact the currently established route, or |
michael@0 | 66 | * <code>null</code> if nothing is established |
michael@0 | 67 | * |
michael@0 | 68 | * @return one of the constants defined in this interface, indicating |
michael@0 | 69 | * either the next step to perform, or success, or failure. |
michael@0 | 70 | * 0 is for success, a negative value for failure. |
michael@0 | 71 | */ |
michael@0 | 72 | public int nextStep(RouteInfo plan, RouteInfo fact); |
michael@0 | 73 | |
michael@0 | 74 | } |