fcrrestserver

Documentation

Overview

Package fcrrestserver - common methods to create HTTP endpoints and handle HTTP requests across the application.

Index

• type FCRRESTServer
  • func NewFCRRESTServer(listenAddrs []string) *FCRRESTServer
  • func (s *FCRRESTServer) AddHandler(listenAddr string, msgType int32, ...) *FCRRESTServer
  • func (s *FCRRESTServer) Start() error

Examples

• NewFCRRESTServer

Types

type FCRRESTServer

type FCRRESTServer struct {
	// contains filtered or unexported fields
}

FCRRESTServer represents a REST server handling http requests.

func NewFCRRESTServer

func NewFCRRESTServer(
	listenAddrs []string,
) *FCRRESTServer

NewFCRRESTServer creates an empty FCRRESTServer

Example

s := NewFCRRESTServer([]string{"0"})
fmt.Printf("%T\n", s)
err := s.Start()
fmt.Println(err)

Output:

*fcrrestserver.FCRRESTServer
<nil>

func (*FCRRESTServer) AddHandler

func (s *FCRRESTServer) AddHandler(listenAddr string, msgType int32, handler func(rw rest.ResponseWriter, request *fcrmessages.FCRMessage)) *FCRRESTServer

AddHandler is used to add a handler to the server for a given type.

func (*FCRRESTServer) Start

func (s *FCRRESTServer) Start() error

Start is used to start the server.