Documentation
¶
Overview ¶
Package protocol defines the interface for different tracking protocol implementations.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Protocol ¶
type Protocol interface {
ID() string
Columns() schema.Columns
Interfaces() any
Endpoints() []ProtocolEndpoint
Hits(*fasthttp.RequestCtx, *hits.ParsedRequest) ([]*hits.Hit, error)
}
Protocol defines the interface for different tracking protocol implementations.
type ProtocolEndpoint ¶ added in v0.18.0
type ProtocolEndpoint struct {
Methods []string
Path string
// Normal endpoints are hit-creating ones, Custom endpoints are called directly
// and may serve different purposes.
IsCustom bool
CustomHandler func(*fasthttp.RequestCtx)
}
ProtocolEndpoint describes a web endpoint that is used by a protocol.
Click to show internal directories.
Click to hide internal directories.