payload

Documentation

Index

• type Builder
• type FilePayload
  • func (fp FilePayload) BuildPayload(msg message.Message, data map[string]interface{}) ([]byte, error)
  • func (fp FilePayload) SendPayload(destination string, payload []byte) ([]byte, error)
• type Payloader
• type Sender
• type TidePayload
  • func (t TidePayload) BuildPayload(msg message.Message, data map[string]interface{}) ([]byte, error)
  • func (t TidePayload) SendPayload(destination string, payload []byte) ([]byte, error)

Types

type Builder

type Builder interface {
	BuildPayload(message.Message, map[string]interface{}) ([]byte, error)
}

Builder interface describes a payload generator.

type FilePayload

type FilePayload struct {
	TerminateChannel chan struct{}
}

FilePayload implements a Payloader that simply writes to a file.

func (FilePayload) BuildPayload

func (fp FilePayload) BuildPayload(msg message.Message, data map[string]interface{}) ([]byte, error)

BuildPayload uses the default TidePayload.

func (FilePayload) SendPayload

func (fp FilePayload) SendPayload(destination string, payload []byte) ([]byte, error)

SendPayload sends the results to a file.

type Payloader

type Payloader interface {
	Sender
	Builder
}

Payloader interface is used to build and send payloads to endpoints.

type Sender

type Sender interface {
	SendPayload(destination string, payload []byte) ([]byte, error)
}

Sender interface describes a send message to an endpoint.

type TidePayload

type TidePayload struct {
	Client tide.ClientInterface
}

TidePayload implements the Payloader interface to send payloads to the Tide API.

func (TidePayload) BuildPayload

func (t TidePayload) BuildPayload(msg message.Message, data map[string]interface{}) ([]byte, error)

BuildPayload implements payload.Builder interface to generate Tide API payload.

func (TidePayload) SendPayload

func (t TidePayload) SendPayload(destination string, payload []byte) ([]byte, error)

SendPayload sends a payload message to the Tide API.