HttpRouteDirector Interface Reference

Provides directions on establishing a route. More...

Inheritance diagram for HttpRouteDirector:

Description

Implementations of this interface compare a planned route with a tracked route and indicate the next step required.

Author

Roland Weber

Version

Revision

620255

Since

4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
int	nextStep (RouteInfo plan, RouteInfo fact)
	Provides the next step. More...

Static Public Attributes
static final int	UNREACHABLE = -1
	Indicates that the route can not be established at all. More...
static final int	COMPLETE = 0
	Indicates that the route is complete. More...
static final int	CONNECT_TARGET = 1
	Step: open connection to target. More...
static final int	CONNECT_PROXY = 2
	Step: open connection to proxy. More...
static final int	TUNNEL_TARGET = 3
	Step: tunnel through proxy to target. More...
static final int	TUNNEL_PROXY = 4
	Step: tunnel through proxy to other proxy. More...
static final int	LAYER_PROTOCOL = 5
	Step: layer protocol (over tunnel). More...

Member Function Documentation

nextStep()

int nextStep	(	RouteInfo	plan,
		RouteInfo	fact
	)

Parameters

plan	the planned route
fact	the currently established route, or null if nothing is established

Returns

one of the constants defined in this interface, indicating either the next step to perform, or success, or failure. 0 is for success, a negative value for failure.

Implemented in BasicRouteDirector.

Member Data Documentation

UNREACHABLE

final int UNREACHABLE = -1

static

COMPLETE

final int COMPLETE = 0

static

CONNECT_TARGET

final int CONNECT_TARGET = 1

static

CONNECT_PROXY

final int CONNECT_PROXY = 2

static

TUNNEL_TARGET

final int TUNNEL_TARGET = 3

static

TUNNEL_PROXY

final int TUNNEL_PROXY = 4

static

LAYER_PROTOCOL

final int LAYER_PROTOCOL = 5

static