streamtest

README

streamtest

Utility to test network steaming performance.

Documentation

Index

• Constants
• type AckProtocol
• type ClientOptions
• type ClientResult
• type StreamClient
  • func NewStreamClient(options ClientOptions) *StreamClient
  • func (client *StreamClient) Connect() error
  • func (client *StreamClient) Start() (*ClientResult, error)
• type StreamServer
  • func (server *StreamServer) Start(port uint16, protocol string) error

Constants

const DefaultPort uint16 = 5991

DefaultPort The default IP port that streamtest communicates on

Types

type AckProtocol

type AckProtocol uint8

AckProtocol Acknowledgement protocol used during streaming tests

const (
	// Streaming No acknowledgement between packets
	Streaming AckProtocol = iota

	// StopWait Wait for packet acknowledgement before sending the next packet
	StopWait
)

type ClientOptions

type ClientOptions struct {
	ServerIPAddress net.IPAddr
	ServerPort      uint16
	NetworkProtocol string
	AckProtocol     AckProtocol
	MessageSize     uint32
}

ClientOptions Options when setting up a streamtest client

type ClientResult

type ClientResult struct {
	PacketsSent uint32
	BytesSent   uint32
	Duration    int64
}

type StreamClient

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

StreamClient The streamtest client

func NewStreamClient

func NewStreamClient(options ClientOptions) *StreamClient

NewStreamClient Creates a new StreamClient

func (*StreamClient) Connect

func (client *StreamClient) Connect() error

Connect Connects a StreamClient to its streamtest server

func (*StreamClient) Start

func (client *StreamClient) Start() (*ClientResult, error)

Start Begins a streamtest transfer

type StreamServer

type StreamServer struct{}

func (*StreamServer) Start

func (server *StreamServer) Start(port uint16, protocol string) error