webpush

type Client ¶

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

func New(keys Keys, subject string, options ...Option) *Client

func (c *Client) Send(ctx context.Context, subscription Subscription, payload []byte, options Options) Result

type Keys ¶

type Keys struct {
	Public  string
	Private string
}

Keys is a VAPID key pair: the base64url uncompressed P-256 public point browsers use as applicationServerKey, and the base64url private scalar.

func GenerateKeys() (Keys, error)

type Option ¶

type Option func(*Client)

func WithHTTPClient(client *http.Client) Option

type Options ¶

type Options struct {
	TTL     time.Duration
	Topic   string
	Urgency string
}

Options are the RFC 8030 message headers. Topic replaces an undelivered message with the same topic; it must be at most 32 base64url characters.

type Outcome ¶

type Outcome int

Outcome classifies a push service response.

const (
	// Accepted: the push service took the message (2xx).
	Accepted Outcome = iota
	// Gone: the subscription expired or was unsubscribed (404, 410).
	Gone
	// Retry: rate limited, a server failure or a network error (429, 5xx).
	Retry
	// Permanent: the push service refused this message (other 4xx, including 413).
	Permanent
)

func (outcome Outcome) String() string

type Result ¶

type Result struct {
	Outcome    Outcome
	Status     int
	RetryAfter time.Duration
	Err        error
}

Result is a classified send. RetryAfter carries the push service's Retry-After when it gave one; Status is zero without a response.

type Subscription ¶

type Subscription struct {
	Endpoint string
	P256dh   string
	Auth     string
}

Subscription is a browser PushSubscription: its endpoint and base64url keys.