Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

httpapi

package

Go to main page

Versions in this module

v0

v0.3.1

Aug 1, 2026

v0.3.0

Jul 22, 2026

Changes in this version

+ const MaximumPollDuration

+ const MinimumWriteTimeout

+ func PrincipalFromContext(ctx context.Context) (string, bool)

type Options

+ PrincipalResolver PrincipalResolver

+ type PrincipalResolver func(*http.Request) (string, error)

type Service

+ ListSchedulesPage func(context.Context, blockqueue.Topic, int, string) (blockqueue.SchedulePage, error)

+ ListSubscriberStatuses func(context.Context, blockqueue.Topic, int, string) (blockqueue.SubscriberStatusPage, error)

+ ListTopics func(context.Context, int, string) (blockqueue.TopicPage, error)

v0.3.0-rc.1

Jul 22, 2026

v0.2.0

Jul 11, 2026

Changes in this version

+ func Router(queue *blockqueue.Queue, options Options) http.Handler

+ type BatchNackRequest struct

+ Error string

+ MessageID string

+ ReceiptToken string

+ RetryDelay string

+ type BatchReceiptRequest struct

+ MessageID string

+ ReceiptToken string

+ type CancelRequest struct

+ Reason string

+ type ErrorMapper func(error) (status int, code, message string)

+ type Handler struct

+ func New(service Service, mapper ErrorMapper) *Handler

+ func (h *Handler) Attach(root chi.Router)

+ type LeaseRequest struct

+ Extension string

+ ReceiptToken string

+ type NackRequest struct

+ Error string

+ ReceiptToken string

+ RetryDelay string

+ type Options struct

+ AuthMiddleware func(http.Handler) http.Handler

+ DisableUI bool

+ Prefix string

+ UIPath string

+ type PublishRequest struct

+ CorrelationID string

+ Delay string

+ Headers map[string]string

+ IdempotencyKey string

+ Message string

+ Priority int

+ ScheduleAt string

+ type ReceiptRequest struct

+ ReceiptToken string

+ type ReplayRequest struct

+ MessageIDs []string

+ type ScheduleRequest struct

+ CorrelationID string

+ CronExpression string

+ Headers map[string]string

+ Message string

+ MisfirePolicy string

+ Name string

+ OverlapPolicy string

+ Priority int

+ Timezone string

+ type ScheduleUpdateRequest struct

+ Version int

+ type Service interface

+ AckDelivery func(context.Context, blockqueue.Topic, string, string, string) error

+ BatchAckDeliveries func(context.Context, blockqueue.Topic, string, []blockqueue.BatchAckItem) []blockqueue.DeliveryResult

+ BatchNackDeliveries func(context.Context, blockqueue.Topic, string, []blockqueue.BatchNackItem) []blockqueue.DeliveryResult

+ BatchPublishAsync func(context.Context, blockqueue.Topic, []blockqueue.Message) (blockqueue.PublishReceipts, error)

+ BatchPublishDurable func(context.Context, blockqueue.Topic, []blockqueue.Message) (blockqueue.PublishReceipts, error)

+ CancelDelivery func(context.Context, blockqueue.Topic, string, string, string) error

+ CancelMessage func(context.Context, blockqueue.Topic, string, string) ([]blockqueue.DeliveryResult, error)

+ ClaimWait func(context.Context, blockqueue.Topic, string, int, time.Duration) (blockqueue.Deliveries, error)

+ CreateSchedule func(context.Context, blockqueue.Topic, blockqueue.ScheduleInput) (blockqueue.Schedule, error)

+ CreateSubscribers func(context.Context, blockqueue.Topic, blockqueue.Subscribers) error

+ CreateTopic func(context.Context, blockqueue.Topic, blockqueue.Subscribers) error

+ DeleteSchedule func(context.Context, blockqueue.Topic, string) error

+ DeleteSubscriber func(context.Context, blockqueue.Topic, string) error

+ DeleteTopic func(context.Context, blockqueue.Topic) error

+ DeliveryErrors func(context.Context, blockqueue.Topic, string, string, int, string) (blockqueue.DeliveryErrorPage, error)

+ ExtendLease func(context.Context, blockqueue.Topic, string, string, string, time.Duration) (time.Time, error)

+ GetMessageStatus func(context.Context, blockqueue.Topic, string) (blockqueue.MessageStatus, error)

+ GetSchedule func(context.Context, blockqueue.Topic, string) (blockqueue.Schedule, error)

+ GetSubscribersStatus func(context.Context, blockqueue.Topic) (blockqueue.SubscriberStatuses, error)

+ GetTopic func(string) (blockqueue.Topic, bool)

+ GetTopics func(context.Context, blockqueue.TopicFilter) (blockqueue.Topics, error)

+ ListDeliveries func(context.Context, blockqueue.Topic, string, bool, int, string) (blockqueue.DeliveryPage, error)

+ ListSchedules func(context.Context, blockqueue.Topic) ([]blockqueue.Schedule, error)

+ NackDelivery func(context.Context, blockqueue.Topic, string, string, string, time.Duration, ...) error

+ PauseSchedule func(context.Context, blockqueue.Topic, string, bool) error

+ PauseSubscriber func(context.Context, blockqueue.Topic, string) error

+ PauseTopic func(context.Context, blockqueue.Topic) error

+ PublishAsync func(context.Context, blockqueue.Topic, blockqueue.Message) (blockqueue.PublishReceipt, error)

+ PublishDurable func(context.Context, blockqueue.Topic, blockqueue.Message) (blockqueue.PublishReceipt, error)

+ ReplayDeadLetters func(context.Context, blockqueue.Topic, string, []string) []blockqueue.DeliveryResult

+ ResumeSubscriber func(context.Context, blockqueue.Topic, string) error

+ ResumeTopic func(context.Context, blockqueue.Topic) error

+ RunScheduleNow func(context.Context, blockqueue.Topic, string, bool) (blockqueue.ScheduleRun, error)

+ ScheduleRunHistory func(context.Context, blockqueue.Topic, string, int, string) (blockqueue.ScheduleRunPage, error)

+ SnoozeDelivery func(context.Context, blockqueue.Topic, string, string, string, time.Duration) (time.Time, error)

+ UpdateSchedule func(context.Context, blockqueue.Topic, string, int, blockqueue.ScheduleInput) (blockqueue.Schedule, error)

+ type SnoozeRequest struct

+ Delay string

+ ReceiptToken string

+ type SubscriberOptions struct

+ DequeueBatchSize int

+ MaxAttempts int

+ RetryPolicy blockqueue.RetryPolicy

+ VisibilityDuration string

+ type SubscriberRequest struct

+ Name string

+ Option SubscriberOptions

+ type TopicRequest struct

+ Name string

+ Subscribers []SubscriberRequest