github.com/tickoalcantara12/micro/v3@v3.0.0-20221007104245-9d75b9bcbab9/service/api/router/router.go (about)

     1  // Copyright 2020 Asim Aslam
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // Original source: github.com/micro/go-micro/v3/api/router/router.go
    16  
    17  // Package router provides api service routing
    18  package router
    19  
    20  import (
    21  	"net/http"
    22  
    23  	"github.com/tickoalcantara12/micro/v3/service/api"
    24  )
    25  
    26  // Router is used to determine an endpoint for a request
    27  type Router interface {
    28  	// Returns options
    29  	Options() Options
    30  	// Stop the router
    31  	Close() error
    32  	// Endpoint returns an api.Service endpoint or an error if it does not exist
    33  	Endpoint(r *http.Request) (*api.Service, error)
    34  	// Register endpoint in router
    35  	Register(ep *api.Endpoint) error
    36  	// Deregister endpoint from router
    37  	Deregister(ep *api.Endpoint) error
    38  	// Route returns an api.Service route
    39  	Route(r *http.Request) (*api.Service, error)
    40  }