receiver

Documentation

Overview

Package receiver implements the messages receiver. It can be used both by the download and the upload subtests.

Index

• func StartDownloadReceiverAsync(ctx context.Context, conn *websocket.Conn, data *model.ArchivalData) context.Context
• func StartUploadReceiverAsync(ctx context.Context, conn *websocket.Conn, data *model.ArchivalData) context.Context

Functions

func StartDownloadReceiverAsync

func StartDownloadReceiverAsync(ctx context.Context, conn *websocket.Conn, data *model.ArchivalData) context.Context

StartDownloadReceiverAsync starts the receiver in a background goroutine and saves messages received from the client in the given archival data. The returned context may be used to detect when the receiver has completed.

This receiver will not tolerate receiving binary messages. It will terminate early if such a message is received.

Liveness guarantee: the goroutine will always terminate after a MaxRuntime timeout.

func StartUploadReceiverAsync

func StartUploadReceiverAsync(ctx context.Context, conn *websocket.Conn, data *model.ArchivalData) context.Context

StartUploadReceiverAsync is like StartDownloadReceiverAsync except that it tolerates incoming binary messages, sent by "upload" measurement clients to create network load, and therefore must be allowed.