telefork

Documentation

Overview

Package telefork contains Telefork client and processor for sending batches of events to Telefork.

Index

• type Client
  • func NewClient(appName, apiKey string) *Client
  • func NewClientWithHTTPClient(appName, apiKey string, client *http.Client) *Client
  • func (c *Client) SendEvents(ctx context.Context, events []interface{}) error
• type Processor
  • func NewProcessor(appName, apiKey string) *Processor
  • func (p *Processor) ProcessRecords(ctx context.Context, events []interface{}) error
• type Transport
  • func NewTransport(appName, apiKey string, rt http.RoundTripper) *Transport
  • func (t *Transport) RoundTrip(r *http.Request) (*http.Response, error)

Types

type Client

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

Client is the Telefork Service client.

func NewClient

func NewClient(appName, apiKey string) *Client

NewClient returns a new Telefork client.

func NewClientWithHTTPClient

func NewClientWithHTTPClient(appName, apiKey string, client *http.Client) *Client

NewClientWithHTTPClient returns a new Telefork client with the given HTTP client.

func (*Client) SendEvents

func (c *Client) SendEvents(ctx context.Context, events []interface{}) error

SendEvents sends the given events to Telefork.

type Processor

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

Processor wraps the Telefork Client for use in a Tracker.

func NewProcessor

func NewProcessor(appName, apiKey string) *Processor

NewProcessor returns a new Telefork Processor.

func (*Processor) ProcessRecords

func (p *Processor) ProcessRecords(ctx context.Context, events []interface{}) error

ProcessRecords sends the given events to Telefork.

type Transport

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

Transport is an http.RoundTripper that adds the X-OUTREACH-CLIENT-APP-ID and X-OUTREACH-CLIENT-LOGGING headers.

func NewTransport

func NewTransport(appName, apiKey string, rt http.RoundTripper) *Transport

NewTransport returns a new Transport.

func (*Transport) RoundTrip

func (t *Transport) RoundTrip(r *http.Request) (*http.Response, error)

RoundTrip implements http.RoundTripper.