stream

Documentation

Index

• Constants
• type MetricsCollector
  • func NewMetricsCollector(logger func(format string, v ...interface{})) *MetricsCollector
  • func (metrics *MetricsCollector) StartStatsEmitScheduler(emitRateMillis int)
  • func (metrics *MetricsCollector) StopStatsEmitScheduler(emitRateMillis int)
• type Proxy
  • func NewConnectionWithoutProxy() (Proxy, error)
  • func NewTCPProxy(o *TCPProxyOptions) (Proxy, error)
  • func NewUDPProxy(o *UDPProxyOptions) (Proxy, error)
• type SatelliteStream
  • func OpenSatelliteStream(o *SatelliteStreamOptions, receiveChan chan<- []byte) (SatelliteStream, func(), error)
• type SatelliteStreamOptions
• type TCPProxyOptions
• type UDPProxyOptions

Constants

const (
	OPEN   uint32 = 0
	CLOSED uint32 = 1
)

const InstantMaxSamples = 50000

InstantMaxSamples - Maximum number of samples to calculate instantaneous stats with (rate & delay)

const InstantMinSamples = 5

InstantMinSamples - Minimum number of samples to calculate instantaneous stats with (rate & delay)

const InstantSampleSeconds = 10

InstantSampleSeconds - Duration of data samples to calculate instantaneous stats with

const MaxElapsedTime = 60 * time.Second

Types

type MetricsCollector

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

MetricsCollector holds metrics used to display pass report and instantaneous stats

func NewMetricsCollector

func NewMetricsCollector(logger func(format string, v ...interface{})) *MetricsCollector

NewMetricsCollector creates a stats collector

func (*MetricsCollector) StartStatsEmitScheduler

func (metrics *MetricsCollector) StartStatsEmitScheduler(emitRateMillis int)

StartStatsEmitScheduler start process to emit stats at defined interval

func (*MetricsCollector) StopStatsEmitScheduler

func (metrics *MetricsCollector) StopStatsEmitScheduler(emitRateMillis int)

StopStatsEmitScheduler stop the emitting stats process

type Proxy

type Proxy interface {
	// Close the proxy.
	Close() error
	// Start listening for packets to send to the satellite and sending back received packets.
	Start(o *SatelliteStreamOptions) (func(), error)
}

Proxy is the interface to send and receive packets.

func NewConnectionWithoutProxy

func NewConnectionWithoutProxy() (Proxy, error)

Create a connection without using a proxy.

func NewTCPProxy

func NewTCPProxy(o *TCPProxyOptions) (Proxy, error)

Create a UDPProxy.

func NewUDPProxy

func NewUDPProxy(o *UDPProxyOptions) (Proxy, error)

Create a UDPProxy.

type SatelliteStream

type SatelliteStream interface {
	Send(payload []byte) error

	io.Closer
}

func OpenSatelliteStream

func OpenSatelliteStream(o *SatelliteStreamOptions, receiveChan chan<- []byte) (SatelliteStream, func(), error)

OpenSatelliteStream opens a stream to a satellite over the StellarStation API.

type SatelliteStreamOptions

type SatelliteStreamOptions struct {
	AcceptedFraming []stellarstation.Framing
	SatelliteID     string
	StreamId        string
	PlanId          string
	GroundStationId string
	IsDebug         bool
	IsVerbose       bool
	ShowStats       bool
	TelemetryFile   *os.File

	CorrectOrder   bool
	DelayThreshold time.Duration

	EnableAutoClose bool
}

type TCPProxyOptions

type TCPProxyOptions struct {
	Addr string
}

type UDPProxyOptions

type UDPProxyOptions struct {
	RecvAddr string
	SendAddr string
}