https

Documentation

Overview

Package https provides comms.Communicator implementations which connect to the Fleetspeak server using HTTPS.

Index

• func SetContentEncoding(h http.Header, compression fspb.CompressionAlgorithm)
• type BodyWriter
  • func CompressingWriter(w io.Writer, compression fspb.CompressionAlgorithm) BodyWriter
• type Communicator
  • func (c *Communicator) GetFileIfModified(ctx context.Context, service, name string, modSince time.Time) (io.ReadCloser, time.Time, error)
  • func (c *Communicator) Setup(cl comms.Context) error
  • func (c *Communicator) Start() error
  • func (c *Communicator) Stop()
• type StreamingCommunicator
  • func (c *StreamingCommunicator) GetFileIfModified(ctx context.Context, service, name string, modSince time.Time) (io.ReadCloser, time.Time, error)
  • func (c *StreamingCommunicator) Setup(cl comms.Context) error
  • func (c *StreamingCommunicator) Start() error
  • func (c *StreamingCommunicator) Stop()

Functions

func SetContentEncoding

func SetContentEncoding(h http.Header, compression fspb.CompressionAlgorithm)

SetContentEncoding sets the Content-Encoding header on req to the appropriate value for the given compression algorithm.

Types

type BodyWriter

type BodyWriter interface {
	io.WriteCloser
	Flush() error
}

BodyWriter is an interface that groups Write, Flush, and Close functions.

func CompressingWriter

func CompressingWriter(w io.Writer, compression fspb.CompressionAlgorithm) BodyWriter

CompressingWriter returns a BodyWriter that will compress the data written to it with the given compression algorithm and write it to w.

type Communicator

type Communicator struct {
	DialContext func(ctx context.Context, network, addr string) (net.Conn, error) // If set, will be used to initiate network connections to the server.
	// contains filtered or unexported fields
}

Communicator implements comms.Communicator and communicates with a Fleetspeak server using https.

func (*Communicator) GetFileIfModified

func (c *Communicator) GetFileIfModified(ctx context.Context, service, name string, modSince time.Time) (io.ReadCloser, time.Time, error)

func (*Communicator) Setup

func (c *Communicator) Setup(cl comms.Context) error

Setup implements comms.Communicator.

func (*Communicator) Start

func (c *Communicator) Start() error

Start implements comms.Communicator.

func (*Communicator) Stop

func (c *Communicator) Stop()

Stop implements comms.Communicator.

type StreamingCommunicator

type StreamingCommunicator struct {
	DialContext func(ctx context.Context, network, addr string) (net.Conn, error) // If set, will be used to initiate network connections to the server.
	// contains filtered or unexported fields
}

StreamingCommunicator is a comms.Communicator that communicates with the fleetspeak server via HTTPS and long lived connections.

func (*StreamingCommunicator) GetFileIfModified

func (c *StreamingCommunicator) GetFileIfModified(ctx context.Context, service, name string, modSince time.Time) (io.ReadCloser, time.Time, error)

func (*StreamingCommunicator) Setup

func (c *StreamingCommunicator) Setup(cl comms.Context) error

Setup implements comms.Communicator.

func (*StreamingCommunicator) Start

func (c *StreamingCommunicator) Start() error

Start implements comms.Communicator.

func (*StreamingCommunicator) Stop

func (c *StreamingCommunicator) Stop()

Stop implements comms.Communicator.