pullapi

type Authorizer func(r *http.Request) bool

type ConsumerConnection struct {
	ID            string
	Route         string
	ConsumerGroup string
	Endpoint      string
	RemoteAddr    string
	UserAgent     string
	TokenRef      string
	ConnectedAt   time.Time
	MessagesSent  int64
	LastMessageAt time.Time
}

type DequeueParams struct {
	Batch       int
	MaxWait     time.Duration
	HasMaxWait  bool
	LeaseTTL    time.Duration
	HasLeaseTTL bool
}

type DequeueResult struct {
	Items []queue.Envelope
}

type Handler interface {
	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

type LeaseBatchResult struct {
	Succeeded int
	Conflicts []queue.LeaseBatchConflict
}

type OpError struct {
	StatusCode int
	Code       string
	Detail     string
}

type Queue struct {
	Route         string
	Target        string
	ConsumerGroup string
}

type Server struct {
	Store queue.Store

	// Target is the queue target used when ResolveQueue is not wired. The
	// runtime always wires it; this keeps a bare Server usable.
	Target string

	// ResolveQueue maps a pull endpoint path to the queue it reads from. It
	// replaces a plain endpoint-to-route lookup because a route with consumer
	// groups serves several endpoints, one per independent queue.
	ResolveQueue func(endpoint string) (Queue, bool)

	Authorize            Authorizer
	ObserveDequeue       func(q Queue, statusCode int, items []queue.Envelope)
	ObserveAck           func(q Queue, statusCode int, leaseID string, leaseExpired bool)
	ObserveNack          func(q Queue, statusCode int, leaseID string, leaseExpired bool)
	ObserveExtend        func(q Queue, statusCode int, leaseID string, extendBy time.Duration, leaseExpired bool)
	DefaultLeaseTTL      time.Duration
	MaxBatch             int
	MaxLeaseBatch        int
	MaxLeaseTTL          time.Duration
	DefaultMaxWait       time.Duration
	MaxWait              time.Duration
	SSEKeepalive         time.Duration
	SSEMaxConnection     time.Duration
	ObserveSSEConnect    func(q Queue)
	ObserveSSEDisconnect func(q Queue, statusCode int, messagesSent int, duration time.Duration)

	// IdentifyToken names the configured secret reference a request
	// authenticated with, for the consumer registry below. It never returns the
	// token value. Optional: without it consumers are listed without a
	// credential.
	IdentifyToken TokenIdentifier

	// ObserveConsumerConnect and ObserveConsumerDisconnect report SSE stream
	// lifecycle so the runtime can log it. They exist next to the SSE metric
	// observers because a counter and an identity answer different questions:
	// the gauge says two consumers are attached, these say which two, and the
	// disconnect is the half that a plain `http_request` access-log line for
	// the establishing GET can never provide.
	ObserveConsumerConnect    func(c ConsumerConnection)
	ObserveConsumerDisconnect func(c ConsumerConnection, statusCode int, duration time.Duration)

	// LeaseRouteScoped reports whether the running config uses per-route pull
	// credentials. When it does, lease operations are checked against the route
	// they were issued for; when it does not, every client is authorized for
	// every route anyway and the check is skipped. See lease_scope.go.
	LeaseRouteScoped func() bool

	RecentLeaseOpTTL time.Duration
	RecentLeaseOpCap int
	// contains filtered or unexported fields
}

type TokenIdentifier func(r *http.Request) string