endpoint

Documentation

Index

• type EndpointEntry
  • func (a EndpointEntry) Identical(b EndpointEntry) bool
• type EndpointManager
  • func (s *EndpointManager) PostInit() error
  • func (s *EndpointManager) RegisterEndpoint(category, pathName, id, name, method, protocol string, t task.Task) (task.Task, error)
  • func (s *EndpointManager) RegisterHttpEndpoint(category, pathName, id, name, method, protocol string, t task.Task) error
• type Endpoints

Types

type EndpointEntry

type EndpointEntry struct {
	Category string
	Id       string
	Name     string
	Endpoint string
	Method   string
	Protocol string
	LastCall time.Time
	NumCalls int64
}

EndpointEntry contains info exposed to the templates

func (EndpointEntry) Identical

func (a EndpointEntry) Identical(b EndpointEntry) bool

Identical returns true of both entries have the same Endpoint and Method

type EndpointManager

type EndpointManager struct {
	Rest *rest.Server `kernel:"inject"`
	// contains filtered or unexported fields
}

EndpointManager acts as a frontend to the Rest server and provides a common interface for both inbound feeds (using http or message brokers) as well as for svg and image sources.

func (*EndpointManager) PostInit

func (s *EndpointManager) PostInit() error

func (*EndpointManager) RegisterEndpoint

func (s *EndpointManager) RegisterEndpoint(category, pathName, id, name, method, protocol string, t task.Task) (task.Task, error)

RegisterEndpoint registers a new endpoint will be sent to a task. This doesn't do much other than count the number of times the task is run and show it on the status page. This is usually used for mqtt and amqp queues

func (*EndpointManager) RegisterHttpEndpoint

func (s *EndpointManager) RegisterHttpEndpoint(category, pathName, id, name, method, protocol string, t task.Task) error

RegisterHttpEndpoint registers a new endpoint with the system webserver which will be sent to a task.

type Endpoints

type Endpoints struct {
	Category  string
	Endpoints []EndpointEntry
}