path

Documentation

Overview

Package path provides routines for path selection.

Index

• func New(rng *mRand.Rand, sphinxGeometry *geo.Geometry, doc *pki.Document, ...) ([]*sphinx.PathHop, time.Time, error)
• func ToString(doc *pki.Document, p []*sphinx.PathHop) ([]string, error)

Functions

func New

func New(rng *mRand.Rand,
	sphinxGeometry *geo.Geometry,
	doc *pki.Document,
	recipient []byte,
	src, dst *pki.MixDescriptor,
	surbID *[constants.SURBIDLength]byte,
	baseTime time.Time,
	isFromClient,
	isForward bool) ([]*sphinx.PathHop, time.Time, error)

New creates a new path suitable for use in creating a Sphinx packet with the specified parameters.

Note: Forward packets originating from a client have slightly different path requirements than internally sourced packets or response packets as it includes the 0th hop.

func ToString

func ToString(doc *pki.Document, p []*sphinx.PathHop) ([]string, error)

ToString returns a slice of strings representing the "useful" component of each PathHop, suitable for debugging.