gosrm

README

GOSRM - GO Client for OSRM

Advanced OSRM client for golang.

Features

• Route Client

Installation

go get github.com/karmadon/gosrm

Quick Start

Route Service

package main

import (
	"fmt"
	"net/url"
	"github.com/karmadon/gosrm"
	"github.com/paulmach/go.geo"
)

func main() {
    options := &gosrm.Options{
        Url:            url.URL{Host: "https://router.project-osrm.org/"},
        Service:        consts.ServiceRoute,
        Version:        consts.VersionFirst,
        Profile:        consts.ProfileDriving,
        RequestTimeout: 5,
    }

    client := gosrm.NewClient(options)

    routeRequest := &models.RouteRequest{
        Coordinates: geo.PointSet{{36.232051849365234, 49.98765584451778}, {36.22089385986328, 50.03718650830641}},
    }

    response, err := client.Route(routeRequest)
    if err != nil {
        panic(err.Error())
    }

    fmt.Printf("%#v", response)
}

Table Service

package main

import (
	"fmt"
	"net/url"
	"github.com/karmadon/gosrm"
	"github.com/paulmach/go.geo"
)

func main() {
	options := &gosrm.Options{
		Url:            url.URL{Host: "https://router.project-osrm.org/"},
		Service:        consts.ServiceTable,
		Version:        consts.VersionFirst,
		Profile:        consts.ProfileDriving,
		RequestTimeout: 5,
	}

	client := gosrm.NewClient(options)

	sources := []int{1, 2}
	destinations := []int{2, 1}

	annotation := consts.TableAnnotationDurationDistance
	scaleFactor := 1.2

	tableRequest := &models.TableRequest{
		Coordinates:  geo.PointSet{{36.232051849365234, 49.98765584451778}, {36.22089385986328, 50.03718650830641}},
		Sources:      &sources,
		Destinations: &destinations,
		Annotations:  &annotation,
		ScaleFactor:  &scaleFactor,
	}

	response, err := client.Table(tableRequest)
	if err != nil {
		panic(err.Error())
	}

	fmt.Printf("%#v", response)
}

Full Example

See examples folder

Documentation

Index

• Constants
• Variables
• type GOSRMError
  • func NewGOSRMError(url *url.URL, err error, rawResponse *[]byte) *GOSRMError
  • func (e *GOSRMError) Error() string
• type OSRM
• type Options
  • func (o *Options) BaseUrl() (*url.URL, error)
• type OsrmClient
  • func NewClient(options *Options) *OsrmClient
  • func (c *OsrmClient) Match(_ *models.MatchRequest) (*models.OSRMResponse, error)
  • func (c *OsrmClient) Nearest(_ *models.NearestRequest) (*models.OSRMResponse, error)
  • func (c *OsrmClient) Route(r *models.RouteRequest) (*models.OSRMResponse, error)
  • func (c *OsrmClient) Table(t *models.TableRequest) (*models.OSRMResponse, error)

Constants

const CodeOK = "Ok"

Variables

var RespCode = map[string]string{
	"NoRoute":        "No route found",
	"NoTable":        "No route found in table method.",
	"NoMatch":        "No matching found.",
	"NoTrips":        "No trips found because input coordinates are not connected.",
	"NotImplemented": "This request is not supported",
	"InvalidUrl":     "URL string is invalid",
	"Ok":             "All OK",
	"InvalidService": "Service name is invalid.",
	"InvalidVersion": "OSRM Version is not found.",
	"InvalidOptions": "Options are invalid.",
	"InvalidQuery":   "The query string is syntactically malformed.",
	"InvalidValue":   "The successfully parsed query parameters are invalid.",
	"NoSegment":      "One of the supplied input coordinates could not snap to street segment.",
	"TooBig":         "The request size violates one of the service specific request size restrictions",
}

Errors which could be returned from OSRM Server

Types

type GOSRMError

type GOSRMError struct {
	Url         *url.URL
	Err         error
	RawResponse *[]byte
}

func NewGOSRMError

func NewGOSRMError(url *url.URL, err error, rawResponse *[]byte) *GOSRMError

func (*GOSRMError) Error

func (e *GOSRMError) Error() string

type OSRM

type OSRM interface {
	Route(r *models.RouteRequest) (*models.OSRMResponse, error)
	Table(r *models.TableRequest) (*models.OSRMResponse, error)
	Match(r *models.MatchRequest) (*models.OSRMResponse, error)
	Nearest(r *models.NearestRequest) (*models.OSRMResponse, error)
}

type Options

type Options struct {
	// Url of osrm server with / on the end
	Url url.URL `json:"url"`

	// One of the following values:  route ,  nearest ,  table ,  match ,  trip ,  tile
	Service string `json:"service"`

	//	Version of the protocol implemented by the service
	Version string `json:"version"`

	// Mode of transportation, is determined statically by the Lua profile that is used to prepare the data using  osrm-extract
	Profile string `json:"profile"`

	GenerateHints bool `json:"generate_hints"`

	// Timeout for request in seconds
	RequestTimeout int `json:"request_timeout"`

	// if need debug you should turn this on
	Debug bool `json:"debug"`
}

OSRM client options structure

func (*Options) BaseUrl

func (o *Options) BaseUrl() (*url.URL, error)

Gets Base url from options

type OsrmClient

type OsrmClient struct {
	Options *Options
	// contains filtered or unexported fields
}

Osrm Client Object

func NewClient

func NewClient(options *Options) *OsrmClient

NewClient creates a client with options

func (*OsrmClient) Match

func (c *OsrmClient) Match(_ *models.MatchRequest) (*models.OSRMResponse, error)

func (*OsrmClient) Nearest

func (c *OsrmClient) Nearest(_ *models.NearestRequest) (*models.OSRMResponse, error)

func (*OsrmClient) Route

func (c *OsrmClient) Route(r *models.RouteRequest) (*models.OSRMResponse, error)

func (*OsrmClient) Table

func (c *OsrmClient) Table(t *models.TableRequest) (*models.OSRMResponse, error)