router

Documentation

Overview

Package router defines the interface of router.

Index

• func Default() *defaultRouter
• type Router

Functions

func Default

func Default() *defaultRouter

DefaultRouter provides a default implementation of `router`, It routes data according to observed tag and metadata.

Types

type Router

type Router interface {
	// Add adds the route rule to the router.
	Add(id uint64, observeDataTags []uint32, md metadata.M) error
	// Route gets the ID list of connections from the router.
	Route(dataTag uint32, md metadata.M) (connIDs []uint64)
	// Remove removes the route rule from the router.
	Remove(id uint64)
	// Release release the router and removes all the route rules.
	Release()
}

Router routes data that is written by source/sfn according to parameters be passed. Users should define their own rules that tells zipper how to route data and how to store the rules.