mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/routing/HttpRouteDirector.java

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/routing/HttpRouteDirector.java	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,74 @@
     1.4 +/*
     1.5 + * ====================================================================
     1.6 + * Licensed to the Apache Software Foundation (ASF) under one
     1.7 + * or more contributor license agreements.  See the NOTICE file
     1.8 + * distributed with this work for additional information
     1.9 + * regarding copyright ownership.  The ASF licenses this file
    1.10 + * to you under the Apache License, Version 2.0 (the
    1.11 + * "License"); you may not use this file except in compliance
    1.12 + * with the License.  You may obtain a copy of the License at
    1.13 + *
    1.14 + *   http://www.apache.org/licenses/LICENSE-2.0
    1.15 + *
    1.16 + * Unless required by applicable law or agreed to in writing,
    1.17 + * software distributed under the License is distributed on an
    1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    1.19 + * KIND, either express or implied.  See the License for the
    1.20 + * specific language governing permissions and limitations
    1.21 + * under the License.
    1.22 + * ====================================================================
    1.23 + *
    1.24 + * This software consists of voluntary contributions made by many
    1.25 + * individuals on behalf of the Apache Software Foundation.  For more
    1.26 + * information on the Apache Software Foundation, please see
    1.27 + * <http://www.apache.org/>.
    1.28 + *
    1.29 + */
    1.30 +
    1.31 +package ch.boye.httpclientandroidlib.conn.routing;
    1.32 +
    1.33 +/**
    1.34 + * Provides directions on establishing a route.
    1.35 + * Implementations of this interface compare a planned route with
    1.36 + * a tracked route and indicate the next step required.
    1.37 + *
    1.38 + * @since 4.0
    1.39 + */
    1.40 +public interface HttpRouteDirector {
    1.41 +
    1.42 +    /** Indicates that the route can not be established at all. */
    1.43 +    public final static int UNREACHABLE = -1;
    1.44 +
    1.45 +    /** Indicates that the route is complete. */
    1.46 +    public final static int COMPLETE = 0;
    1.47 +
    1.48 +    /** Step: open connection to target. */
    1.49 +    public final static int CONNECT_TARGET = 1;
    1.50 +
    1.51 +    /** Step: open connection to proxy. */
    1.52 +    public final static int CONNECT_PROXY = 2;
    1.53 +
    1.54 +    /** Step: tunnel through proxy to target. */
    1.55 +    public final static int TUNNEL_TARGET = 3;
    1.56 +
    1.57 +    /** Step: tunnel through proxy to other proxy. */
    1.58 +    public final static int TUNNEL_PROXY = 4;
    1.59 +
    1.60 +    /** Step: layer protocol (over tunnel). */
    1.61 +    public final static int LAYER_PROTOCOL = 5;
    1.62 +
    1.63 +
    1.64 +    /**
    1.65 +     * Provides the next step.
    1.66 +     *
    1.67 +     * @param plan      the planned route
    1.68 +     * @param fact      the currently established route, or
    1.69 +     *                  <code>null</code> if nothing is established
    1.70 +     *
    1.71 +     * @return  one of the constants defined in this interface, indicating
    1.72 +     *          either the next step to perform, or success, or failure.
    1.73 +     *          0 is for success, a negative value for failure.
    1.74 +     */
    1.75 +    public int nextStep(RouteInfo plan, RouteInfo fact);
    1.76 +
    1.77 +}

mercurial