HttpRoute Class

Article
12/19/2012

Represents a route class for self-host (i.e. hosted outside of ASP.NET).

Inheritance Hierarchy

System.Object
System.Web.Http.Routing.HttpRoute

Namespace: System.Web.Http.Routing
Assembly: System.Web.Http (in System.Web.Http.dll)

Syntax

'Declaration
Public Class HttpRoute _
    Implements IHttpRoute
'Usage
Dim instance As HttpRoute

public class HttpRoute : IHttpRoute

public ref class HttpRoute : IHttpRoute

type HttpRoute =  
    class
        interface IHttpRoute
    end

public class HttpRoute implements IHttpRoute

The HttpRoute type exposes the following members.

Constructors

	Name	Description
	HttpRoute()	Initializes a new instance of the HttpRoute class.
	HttpRoute(String)	Initializes a new instance of the HttpRoute class.
	HttpRoute(String, HttpRouteValueDictionary)	Initializes a new instance of the HttpRoute class.
	HttpRoute(String, HttpRouteValueDictionary, HttpRouteValueDictionary)	Initializes a new instance of the HttpRoute class.
	HttpRoute(String, HttpRouteValueDictionary, HttpRouteValueDictionary, HttpRouteValueDictionary)	Initializes a new instance of the HttpRoute class.
	HttpRoute(String, HttpRouteValueDictionary, HttpRouteValueDictionary, HttpRouteValueDictionary, HttpMessageHandler)	Initializes a new instance of the HttpRoute class.

Top

Properties

	Name	Description
	Constraints	Gets the constraints for the route parameters.
	DataTokens	Gets any additional data tokens not used directly to determine whether a route matches an incoming HttpRequestMessage.
	Defaults	Gets the default values for route parameters if not provided by the incoming HttpRequestMessage.
	Handler	Gets or sets the http route handler.
	RouteTemplate	Gets the route template describing the URI pattern to match against.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetRouteData	Determines whether this route is a match for the incoming request by looking up the HttpRouteData for the route.
	GetType	(Inherited from Object.)
	GetVirtualPath	Attempts to generate a URI that represents the values passed in based on current values from the HttpRouteData and new values using the specified HttpRoute.
	MemberwiseClone	(Inherited from Object.)
	ProcessConstraint	Determines whether this instance equals a specified route.
	ToString	(Inherited from Object.)

Top

Remarks

This class is mostly the same as the Route implementation. This class has the same URL matching functionality as Route. However, in order for this route to match when generating URLs, a special "httproute" key must be specified when generating the URL.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via